Skip to content

public / sequelize

Go to a project

不要怂，就是干，撸起袖子干！

Commit 73b1246a by Simon Schick
Options

refactor: updates

1 parent 7745bc2f
Expand all
Inline Side-by-side
Showing with 114 additions and 114 deletions
lib/associations/belongs-to-many.js
......@@ -369,8 +369,8 @@ class BelongsToMany extends Association {
* {@link Model} for a full explanation of options
*
* @param {Model} instance instance
* @param {Object} [options] find options
* @param {Object} [options.where] An optional where clause to limit the associated models
* @param {object} [options] find options
* @param {object} [options.where] An optional where clause to limit the associated models
* @param {string|boolean} [options.scope] Apply a scope on the related model, or remove its default scope by passing false
* @param {string} [options.schema] Apply a schema on the related model
*
......@@ -438,8 +438,8 @@ class BelongsToMany extends Association {
* Count everything currently associated with this, using an optional where clause.
*
* @param {Model} instance instance
* @param {Object} [options] find options
* @param {Object} [options.where] An optional where clause to limit the associated models
* @param {object} [options] find options
* @param {object} [options.where] An optional where clause to limit the associated models
* @param {string|boolean} [options.scope] Apply a scope on the related model, or remove its default scope by passing false
*
* @returns {Promise<number>}
......@@ -464,7 +464,7 @@ class BelongsToMany extends Association {
*
* @param {Model} sourceInstance source instance to check for an association with
* @param {Model|Model[]|string[]|string|number[]|number} [instances] Can be an array of instances or their primary keys
* @param {Object} [options] Options passed to getAssociations
* @param {object} [options] Options passed to getAssociations
*
* @returns {Promise<boolean>}
*/
......@@ -508,9 +508,9 @@ class BelongsToMany extends Association {
*
* @param {Model} sourceInstance source instance to associate new instances with
* @param {Model|Model[]|string[]|string|number[]|number} [newAssociatedObjects] A single instance or primary key, or a mixed array of persisted instances or primary keys
* @param {Object} [options] Options passed to `through.findAll`, `bulkCreate`, `update` and `destroy`
* @param {Object} [options.validate] Run validation for the join model
* @param {Object} [options.through] Additional attributes for the join table.
* @param {object} [options] Options passed to `through.findAll`, `bulkCreate`, `update` and `destroy`
* @param {object} [options.validate] Run validation for the join model
* @param {object} [options.through] Additional attributes for the join table.
*
* @returns {Promise}
*/
......@@ -611,9 +611,9 @@ class BelongsToMany extends Association {
*
* @param {Model} sourceInstance source instance to associate new instances with
* @param {Model|Model[]|string[]|string|number[]|number} [newInstances] A single instance or primary key, or a mixed array of persisted instances or primary keys
* @param {Object} [options] Options passed to `through.findAll`, `bulkCreate` and `update`
* @param {Object} [options.validate] Run validation for the join model.
* @param {Object} [options.through] Additional attributes for the join table.
* @param {object} [options] Options passed to `through.findAll`, `bulkCreate` and `update`
* @param {object} [options.validate] Run validation for the join model.
* @param {object} [options.through] Additional attributes for the join table.
*
* @returns {Promise}
*/
......@@ -700,7 +700,7 @@ class BelongsToMany extends Association {
*
* @param {Model} sourceInstance instance to un associate instances with
* @param {Model|Model[]|string|string[]|number|number[]} [oldAssociatedObjects] Can be an Instance or its primary key, or a mixed array of instances and primary keys
* @param {Object} [options] Options passed to `through.destroy`
* @param {object} [options] Options passed to `through.destroy`
*
* @returns {Promise}
*/
......@@ -719,9 +719,9 @@ class BelongsToMany extends Association {
* Create a new instance of the associated model and associate it with this.
*
* @param {Model} sourceInstance source instance
* @param {Object} [values] values for target model
* @param {Object} [options] Options passed to create and add
* @param {Object} [options.through] Additional attributes for the join table
* @param {object} [values] values for target model
* @param {object} [options] Options passed to create and add
* @param {object} [options.through] Additional attributes for the join table
*
* @returns {Promise}
*/
......
lib/associations/belongs-to.js
......@@ -115,7 +115,7 @@ class BelongsTo extends Association {
* Get the associated instance.
*
* @param {Model|Array<Model>} instances source instances
* @param {Object} [options] find options
* @param {object} [options] find options
* @param {string|boolean} [options.scope] Apply a scope on the related model, or remove its default scope by passing false.
* @param {string} [options.schema] Apply a schema on the related model
*
......@@ -187,7 +187,7 @@ class BelongsTo extends Association {
*
* @param {Model} sourceInstance the source instance
* @param {?<Model>|string|number} [associatedInstance] An persisted instance or the primary key of an instance to associate with this. Pass `null` or `undefined` to remove the association.
* @param {Object} [options={}] options passed to `this.save`
* @param {object} [options={}] options passed to `this.save`
* @param {boolean} [options.save=true] Skip saving this after setting the foreign key if false.
*
* @returns {Promise}
......@@ -217,8 +217,8 @@ class BelongsTo extends Association {
* Create a new instance of the associated model and associate it with this.
*
* @param {Model} sourceInstance the source instance
* @param {Object} [values={}] values to create associated model instance with
* @param {Object} [options={}] Options passed to `target.create` and setAssociation.
* @param {object} [values={}] values to create associated model instance with
* @param {object} [options={}] Options passed to `target.create` and setAssociation.
*
* @see
* {@link Model#create} for a full explanation of options
......
lib/associations/has-many.js
......@@ -159,8 +159,8 @@ class HasMany extends Association {
* Get everything currently associated with this, using an optional where clause.
*
* @param {Model|Array<Model>} instances source instances
* @param {Object} [options] find options
* @param {Object} [options.where] An optional where clause to limit the associated models
* @param {object} [options] find options
* @param {object} [options.where] An optional where clause to limit the associated models
* @param {string|boolean} [options.scope] Apply a scope on the related model, or remove its default scope by passing false
* @param {string} [options.schema] Apply a schema on the related model
*
......@@ -244,8 +244,8 @@ class HasMany extends Association {
* Count everything currently associated with this, using an optional where clause.
*
* @param {Model} instance the source instance
* @param {Object} [options] find & count options
* @param {Object} [options.where] An optional where clause to limit the associated models
* @param {object} [options] find & count options
* @param {object} [options.where] An optional where clause to limit the associated models
* @param {string|boolean} [options.scope] Apply a scope on the related model, or remove its default scope by passing false
*
* @returns {Promise<number>}
......@@ -273,7 +273,7 @@ class HasMany extends Association {
*
* @param {Model} sourceInstance the source instance
* @param {Model|Model[]|string[]|string|number[]|number} [targetInstances] Can be an array of instances or their primary keys
* @param {Object} [options] Options passed to getAssociations
* @param {object} [options] Options passed to getAssociations
*
* @returns {Promise}
*/
......@@ -314,8 +314,8 @@ class HasMany extends Association {
*
* @param {Model} sourceInstance source instance to associate new instances with
* @param {Model|Model[]|string[]|string|number[]|number} [targetInstances] An array of persisted instances or primary key of instances to associate with this. Pass `null` or `undefined` to remove all associations.
* @param {Object} [options] Options passed to `target.findAll` and `update`.
* @param {Object} [options.validate] Run validation for the join model
* @param {object} [options] Options passed to `target.findAll` and `update`.
* @param {object} [options.validate] Run validation for the join model
*
* @returns {Promise}
*/
......@@ -395,7 +395,7 @@ class HasMany extends Association {
*
* @param {Model} sourceInstance the source instance
* @param {Model|Model[]|string[]|string|number[]|number} [targetInstances] A single instance or primary key, or a mixed array of persisted instances or primary keys
* @param {Object} [options] Options passed to `target.update`.
* @param {object} [options] Options passed to `target.update`.
*
* @returns {Promise}
*/
......@@ -423,7 +423,7 @@ class HasMany extends Association {
*
* @param {Model} sourceInstance instance to un associate instances with
* @param {Model|Model[]|string|string[]|number|number[]} [targetInstances] Can be an Instance or its primary key, or a mixed array of instances and primary keys
* @param {Object} [options] Options passed to `target.update`
* @param {object} [options] Options passed to `target.update`
*
* @returns {Promise}
*/
......@@ -448,8 +448,8 @@ class HasMany extends Association {
* Create a new instance of the associated model and associate it with this.
*
* @param {Model} sourceInstance source instance
* @param {Object} [values] values for target model instance
* @param {Object} [options] Options passed to `target.create`
* @param {object} [values] values for target model instance
* @param {object} [options] Options passed to `target.create`
*
* @returns {Promise}
*/
......
lib/associations/has-one.js
......@@ -114,7 +114,7 @@ class HasOne extends Association {
* Get the associated instance.
*
* @param {Model|Array<Model>} instances source instances
* @param {Object} [options] find options
* @param {object} [options] find options
* @param {string|boolean} [options.scope] Apply a scope on the related model, or remove its default scope by passing false
* @param {string} [options.schema] Apply a schema on the related model
*
......@@ -187,7 +187,7 @@ class HasOne extends Association {
*
* @param {Model} sourceInstance the source instance
* @param {?<Model>|string|number} [associatedInstance] An persisted instance or the primary key of an instance to associate with this. Pass `null` or `undefined` to remove the association.
* @param {Object} [options] Options passed to getAssociation and `target.save`
* @param {object} [options] Options passed to getAssociation and `target.save`
*
* @returns {Promise}
*/
......@@ -236,8 +236,8 @@ class HasOne extends Association {
* Create a new instance of the associated model and associate it with this.
*
* @param {Model} sourceInstance the source instance
* @param {Object} [values={}] values to create associated model instance with
* @param {Object} [options] Options passed to `target.create` and setAssociation.
* @param {object} [values={}] values to create associated model instance with
* @param {object} [options] Options passed to `target.create` and setAssociation.
*
* @see
* {@link Model#create} for a full explanation of options
......
lib/associations/helpers.js
......@@ -46,10 +46,10 @@ exports.addForeignKeyConstraints = addForeignKeyConstraints;
*
* @private
*
* @param {Object} association instance
* @param {Object} obj Model prototype
* @param {object} association instance
* @param {object} obj Model prototype
* @param {Array} methods Method names to inject
* @param {Object} aliases Mapping between model and association method names
* @param {object} aliases Mapping between model and association method names
*
*/
function mixinMethods(association, obj, methods, aliases = {}) {
......
lib/data-types.js
......@@ -157,7 +157,7 @@ class CITEXT extends ABSTRACT {
*/
class NUMBER extends ABSTRACT {
/**
* @param {Object} options type options
* @param {object} options type options
* @param {string|number} [options.length] length of type, like `INT(4)`
* @param {boolean} [options.zerofill] Is zero filled?
* @param {boolean} [options.unsigned] Is unsigned?
......
lib/dialects/abstract/connection-manager.js
......@@ -65,7 +65,7 @@ class ConnectionManager {
* @param {string} moduleName Name of dialect module to lookup
*
* @private
* @returns {Object}
* @returns {object}
*/
_loadDialectModule(moduleName) {
try {
......@@ -249,7 +249,7 @@ class ConnectionManager {
* Get connection from pool. It sets database version if it's not already set.
* Call pool.acquire to get a connection
*
* @param {Object} [options] Pool options
* @param {object} [options] Pool options
* @param {string} [options.type] Set which replica to use. Available options are `read` and `write`
* @param {boolean} [options.useMaster=false] Force master or write replica to get connection from
*
......
lib/dialects/abstract/query-generator.js
......@@ -92,9 +92,9 @@ class QueryGenerator {
* Returns an insert into command
*
* @param {string} table
* @param {Object} valueHash attribute value pairs
* @param {Object} modelAttributes
* @param {Object} [options]
* @param {object} valueHash attribute value pairs
* @param {object} modelAttributes
* @param {object} [options]
*
* @private
*/
......@@ -253,9 +253,9 @@ class QueryGenerator {
* Returns an insert into command for multiple values.
*
* @param {string} tableName
* @param {Object} fieldValueHashes
* @param {Object} options
* @param {Object} fieldMappedAttributes
* @param {object} fieldValueHashes
* @param {object} options
* @param {object} fieldMappedAttributes
*
* @private
*/
......@@ -313,10 +313,10 @@ class QueryGenerator {
* Returns an update query
*
* @param {string} tableName
* @param {Object} attrValueHash
* @param {Object} where A hash with conditions (e.g. {name: 'foo'}) OR an ID as integer
* @param {Object} options
* @param {Object} attributes
* @param {object} attrValueHash
* @param {object} where A hash with conditions (e.g. {name: 'foo'}) OR an ID as integer
* @param {object} options
* @param {object} attributes
*
* @private
*/
......@@ -427,10 +427,10 @@ class QueryGenerator {
*
* @param {string} operator String with the arithmetic operator (e.g. '+' or '-')
* @param {string} tableName Name of the table
* @param {Object} attrValueHash A hash with attribute-value-pairs
* @param {Object} where A hash with conditions (e.g. {name: 'foo'}) OR an ID as integer
* @param {Object} options
* @param {Object} attributes
* @param {object} attrValueHash A hash with attribute-value-pairs
* @param {object} where A hash with conditions (e.g. {name: 'foo'}) OR an ID as integer
* @param {object} options
* @param {object} attributes
*/
arithmeticQuery(operator, tableName, attrValueHash, where, options, attributes = {}) {
options = {
......@@ -896,7 +896,7 @@ class QueryGenerator {
/**
* Quote table name with optional alias and schema attribution
*
* @param {string|Object} param table string or object
* @param {string|object} param table string or object
* @param {string|boolean} alias alias name
*
* @returns {string}
......@@ -1917,7 +1917,7 @@ class QueryGenerator {
/**
* Returns an SQL fragment for adding result constraints.
*
* @param {Object} options An object with selectQuery options.
* @param {object} options An object with selectQuery options.
* @returns {string} The generated sql query.
* @private
*/
......
lib/dialects/abstract/query-generator/helpers/quote.js
......@@ -25,7 +25,7 @@ const postgresReservedWords = 'all,analyse,analyze,and,any,array,as,asc,asymmetr
*
* @param {string} dialect Dialect name
* @param {string} identifier Identifier to quote
* @param {Object} [options]
* @param {object} [options]
* @param {boolean} [options.force=false]
* @param {boolean} [options.quoteIdentifiers=true]
*
......
lib/dialects/abstract/query-generator/transaction.js
......@@ -7,7 +7,7 @@ const TransactionQueries = {
* Returns a query that sets the transaction isolation level.
*
* @param {string} value The isolation level.
* @param {Object} options An object with options.
* @param {object} options An object with options.
* @returns {string} The generated sql query.
* @private
*/
......
lib/dialects/abstract/query.js
......@@ -38,10 +38,10 @@ class AbstractQuery {
* skipValueReplace: bool, do not replace (but do unescape $$). Check correct syntax and if all values are available
*
* @param {string} sql
* @param {Object|Array} values
* @param {object|Array} values
* @param {string} dialect
* @param {Function} [replacementFunc]
* @param {Object} [options]
* @param {object} [options]
* @private
*/
static formatBindParameters(sql, values, dialect, replacementFunc, options = {}) {
......@@ -382,8 +382,8 @@ class AbstractQuery {
* ]
*
* @param {Array} rows
* @param {Object} includeOptions
* @param {Object} options
* @param {object} includeOptions
* @param {object} options
* @private
*/
static _groupJoinData(rows, includeOptions, options) {
......
lib/dialects/mariadb/connection-manager.js
......@@ -33,7 +33,7 @@ class ConnectionManager extends AbstractConnectionManager {
* Set the pool handlers on connection.error
* Also set proper timezone once connection is connected.
*
* @param {Object} config
* @param {object} config
* @returns {Promise<Connection>}
* @private
*/
......
lib/dialects/mssql/data-types.js
......@@ -8,7 +8,7 @@ module.exports = BaseTypes => {
/**
* Removes unsupported MSSQL options, i.e., LENGTH, UNSIGNED and ZEROFILL, for the integer data types.
*
* @param {Object} dataType The base integer data type.
* @param {object} dataType The base integer data type.
* @private
*/
function removeUnsupportedIntegerOptions(dataType) {
......
lib/dialects/mssql/query-generator.js
......@@ -695,7 +695,7 @@ class MSSQLQueryGenerator extends AbstractQueryGenerator {
/**
* Generates an SQL query that returns all foreign keys details of a table.
*
* @param {string|Object} table
* @param {string|object} table
* @param {string} catalogName database name
* @returns {string}
*/
......
lib/dialects/mssql/query-interface.js
......@@ -15,7 +15,7 @@
@param {QueryInterface} qi
@param {string} tableName The name of the table.
@param {string} attributeName The name of the attribute that we want to remove.
@param {Object} options
@param {object} options
@param {boolean|Function} [options.logging] A function that logs the sql queries, or false for explicitly not logging these queries
@private
......
lib/dialects/mysql/connection-manager.js
......@@ -33,7 +33,7 @@ class ConnectionManager extends AbstractConnectionManager {
* Set the pool handlers on connection.error
* Also set proper timezone once connection is connected.
*
* @param {Object} config
* @param {object} config
* @returns {Promise<Connection>}
* @private
*/
......
lib/dialects/mysql/query-generator.js
......@@ -499,7 +499,7 @@ class MySQLQueryGenerator extends AbstractQueryGenerator {
/**
* Generates an SQL query that returns all foreign keys of a table.
*
* @param {Object} table The table.
* @param {object} table The table.
* @param {string} schemaName The name of the schema.
* @returns {string} The generated sql query.
* @private
......@@ -512,7 +512,7 @@ class MySQLQueryGenerator extends AbstractQueryGenerator {
/**
* Generates an SQL query that returns the foreign key constraint of a given column.
*
* @param {Object} table The table.
* @param {object} table The table.
* @param {string} columnName The name of the column.
* @returns {string} The generated sql query.
* @private
......
lib/dialects/mysql/query-interface.js
......@@ -17,7 +17,7 @@ const sequelizeErrors = require('../../errors');
@param {QueryInterface} qi
@param {string} tableName The name of the table.
@param {string} columnName The name of the attribute that we want to remove.
@param {Object} options
@param {object} options
@private
*/
......@@ -50,7 +50,7 @@ function removeColumn(qi, tableName, columnName, options = {}) {
* @param {QueryInterface} qi
* @param {string} tableName
* @param {string} constraintName
* @param {Object} options
* @param {object} options
*
* @private
*/
......
lib/dialects/postgres/data-types.js
......@@ -9,7 +9,7 @@ module.exports = BaseTypes => {
/**
* Removes unsupported Postgres options, i.e., LENGTH, UNSIGNED and ZEROFILL, for the integer data types.
*
* @param {Object} dataType The base integer data type.
* @param {object} dataType The base integer data type.
* @private
*/
function removeUnsupportedIntegerOptions(dataType) {
......
lib/dialects/postgres/query-interface.js
......@@ -17,8 +17,8 @@ const QueryTypes = require('../../query-types');
*
* @param {QueryInterface} qi
* @param {string} tableName Name of table to create
* @param {Object} attributes Object representing a list of normalized table attributes
* @param {Object} [options]
* @param {object} attributes Object representing a list of normalized table attributes
* @param {object} [options]
* @param {Model} [model]
*
* @returns {Promise}
......
lib/dialects/postgres/query.js
......@@ -15,7 +15,7 @@ class Query extends AbstractQuery {
* Rewrite query with parameters.
*
* @param {string} sql
* @param {Array|Object} values
* @param {Array|object} values
* @param {string} dialect
* @private
*/
......
lib/dialects/sqlite/data-types.js
......@@ -6,7 +6,7 @@ module.exports = BaseTypes => {
/**
* Removes unsupported SQLite options, i.e., UNSIGNED and ZEROFILL, for the integer data types.
*
* @param {Object} dataType The base integer data type.
* @param {object} dataType The base integer data type.
* @private
*/
function removeUnsupportedIntegerOptions(dataType) {
......
lib/dialects/sqlite/query-interface.js
......@@ -20,7 +20,7 @@ const QueryTypes = require('../../query-types');
@param {QueryInterface} qi
@param {string} tableName The name of the table.
@param {string} attributeName The name of the attribute that we want to remove.
@param {Object} options
@param {object} options
@param {boolean|Function} [options.logging] A function that logs the sql queries, or false for explicitly not logging these queries
@since 1.6.0
......@@ -45,8 +45,8 @@ exports.removeColumn = removeColumn;
@param {QueryInterface} qi
@param {string} tableName The name of the table.
@param {Object} attributes An object with the attribute's name as key and its options as value object.
@param {Object} options
@param {object} attributes An object with the attribute's name as key and its options as value object.
@param {object} options
@param {boolean|Function} [options.logging] A function that logs the sql queries, or false for explicitly not logging these queries
@since 1.6.0
......@@ -74,7 +74,7 @@ exports.changeColumn = changeColumn;
@param {string} tableName The name of the table.
@param {string} attrNameBefore The name of the attribute before it was renamed.
@param {string} attrNameAfter The name of the attribute after it was renamed.
@param {Object} options
@param {object} options
@param {boolean|Function} [options.logging] A function that logs the sql queries, or false for explicitly not logging these queries
@since 1.6.0
......@@ -97,7 +97,7 @@ exports.renameColumn = renameColumn;
* @param {QueryInterface} qi
* @param {string} tableName
* @param {string} constraintName
* @param {Object} options
* @param {object} options
*
* @private
*/
......@@ -145,7 +145,7 @@ exports.removeConstraint = removeConstraint;
/**
* @param {QueryInterface} qi
* @param {string} tableName
* @param {Object} options
* @param {object} options
*
* @private
*/
......@@ -176,7 +176,7 @@ exports.addConstraint = addConstraint;
/**
* @param {QueryInterface} qi
* @param {string} tableName
* @param {Object} options Query Options
* @param {object} options Query Options
*
* @private
* @returns {Promise}
......
lib/dialects/sqlite/query.js
......@@ -20,7 +20,7 @@ class Query extends AbstractQuery {
* rewrite query with parameters.
*
* @param {string} sql
* @param {Array|Object} values
* @param {Array|object} values
* @param {string} dialect
* @private
*/
......
lib/errors/bulk-record-error.js
......@@ -7,7 +7,7 @@ const BaseError = require('./base-error');
* Used with Promise.AggregateError
*
* @param {Error} error Error for a given record/instance
* @param {Object} record DAO instance that error belongs to
* @param {object} record DAO instance that error belongs to
*/
class BulkRecordError extends BaseError {
constructor(error, record) {
......
lib/errors/validation-error.js
......@@ -61,8 +61,8 @@ class ValidationErrorItem {
* @param {string} type The type/origin of the validation error
* @param {string} path The field that triggered the validation error
* @param {string} value The value that generated the error
* @param {Object} [inst] the DAO instance that caused the validation error
* @param {Object} [validatorKey] a validation "key", used for identification
* @param {object} [inst] the DAO instance that caused the validation error
* @param {object} [validatorKey] a validation "key", used for identification
* @param {string} [fnName] property name of the BUILT-IN validator function that caused the validation error (e.g. "in" or "len"), if applicable
* @param {string} [fnArgs] parameters used with the BUILT-IN validator function, if applicable
*/
......@@ -179,7 +179,7 @@ class ValidationErrorItem {
/**
* An enum that defines valid ValidationErrorItem `origin` values
*
* @type {Object}
* @type {object}
* @property CORE {string} specifies errors that originate from the sequelize "core"
* @property DB {string} specifies validation errors that originate from the storage engine
* @property FUNCTION {string} specifies validation errors that originate from validator functions (both built-in and custom) defined for a given attribute
......@@ -195,7 +195,7 @@ ValidationErrorItem.Origins = {
* that maps current `type` strings (as given to ValidationErrorItem.constructor()) to
* our new `origin` values.
*
* @type {Object}
* @type {object}
*/
ValidationErrorItem.TypeStringMap = {
'notnull violation': 'CORE',
......
lib/hooks.js
......@@ -73,7 +73,7 @@ const Hooks = {
/**
* Process user supplied hooks definition
*
* @param {Object} hooks hooks definition
* @param {object} hooks hooks definition
*
* @private
* @memberof Sequelize
......
lib/instance-validator.js
......@@ -12,7 +12,7 @@ const validator = require('./utils/validator-extras').validator;
* Instance Validator.
*
* @param {Instance} modelInstance The model instance.
* @param {Object} options A dictionary with options.
* @param {object} options A dictionary with options.
*
* @private
*/
......@@ -281,7 +281,7 @@ class InstanceValidator {
* @param {string} validatorType One of known to Sequelize validators.
* @param {string} field The field that is being validated
*
* @returns {Object} An object with specific keys to invoke the validator.
* @returns {object} An object with specific keys to invoke the validator.
*/
_invokeBuiltinValidator(value, test, validatorType, field) {
return Promise.try(() => {
......@@ -330,7 +330,7 @@ class InstanceValidator {
/**
* Will validate a single field against its schema definition (isnull).
*
* @param {Object} rawAttribute As defined in the Schema.
* @param {object} rawAttribute As defined in the Schema.
* @param {string} field The field name.
* @param {*} value anything.
*
......
lib/model-manager.js
......@@ -35,7 +35,7 @@ class ModelManager {
* Will take foreign key constraints into account so that dependencies are visited before dependents.
*
* @param {Function} iterator method to execute on each model
* @param {Object} [options] iterator options
* @param {object} [options] iterator options
* @private
*/
forEachModel(iterator, options) {
......
lib/transaction.js
......@@ -15,7 +15,7 @@ class Transaction {
* Creates a new transaction instance
*
* @param {Sequelize} sequelize A configured sequelize Instance
* @param {Object} options An object with options
* @param {object} options An object with options
* @param {string} options.type=true Sets the type of the transaction.
* @param {string} options.isolationLevel=true Sets the isolation level of the transaction.
* @param {string} options.deferrable Sets the constraints to be deferred or immediately checked.
......@@ -264,7 +264,7 @@ class Transaction {
* });
* # The query will now return any rows that aren't locked by another transaction
*
* @returns {Object}
* @returns {object}
* @property UPDATE
* @property SHARE
* @property KEY_SHARE Postgres 9.3+ only
......
lib/utils.js
......@@ -380,8 +380,8 @@ exports.removeTicks = removeTicks;
* address.coordinates.longitude: 12.5964313
* }
*
* @param {Object} value an Object
* @returns {Object} a flattened object
* @param {object} value an Object
* @returns {object} a flattened object
* @private
*/
function flattenObjectDeep(value) {
......@@ -488,7 +488,7 @@ exports.Where = Where;
/**
* getOperators
*
* @param {Object} obj
* @param {object} obj
* @returns {Array<Symbol>} All operators properties of obj
* @private
*/
......@@ -500,7 +500,7 @@ exports.getOperators = getOperators;
/**
* getComplexKeys
*
* @param {Object} obj
* @param {object} obj
* @returns {Array<string|Symbol>} All keys including operators
* @private
*/
......@@ -512,7 +512,7 @@ exports.getComplexKeys = getComplexKeys;
/**
* getComplexSize
*
* @param {Object|Array} obj
* @param {object|Array} obj
* @returns {number} Length of object properties including operators if obj is array returns its length
* @private
*/
......@@ -524,7 +524,7 @@ exports.getComplexSize = getComplexSize;
/**
* Returns true if a where clause is empty, even with Symbols
*
* @param {Object} obj
* @param {object} obj
* @returns {boolean}
* @private
*/
......@@ -549,7 +549,7 @@ exports.generateEnumName = generateEnumName;
/**
* Returns an new Object which keys are camelized
*
* @param {Object} obj
* @param {object} obj
* @returns {string}
* @private
*/
......@@ -570,9 +570,9 @@ exports.camelizeObjectKeys = camelizeObjectKeys;
*
* **Note:** This method mutates `object`.
*
* @param {Object} object The destination object.
* @param {...Object} [sources] The source objects.
* @returns {Object} Returns `object`.
* @param {object} object The destination object.
* @param {...object} [sources] The source objects.
* @returns {object} Returns `object`.
* @private
*/
function defaults(object, ...sources) {
......@@ -602,12 +602,12 @@ exports.defaults = defaults;
/**
*
* @param {Object} index
* @param {object} index
* @param {Array} index.fields
* @param {string} [index.name]
* @param {string|Object} tableName
* @param {string|object} tableName
*
* @returns {Object}
* @returns {object}
* @private
*/
function nameIndex(index, tableName) {
......
package.json
......@@ -46,10 +46,10 @@
"wkx": "^0.4.6"
},
"devDependencies": {
"@commitlint/cli": "^7.6.1",
"@commitlint/config-angular": "^7.6.0",
"@commitlint/cli": "^8.0.0",
"@commitlint/config-angular": "^8.0.0",
"@types/bluebird": "^3.5.26",
"@types/node": "^10.14.6",
"@types/node": "^12.0.8",
"@types/validator": "^10.11.0",
"big-integer": "^1.6.42",
"chai": "^4.x",
......@@ -62,14 +62,14 @@
"esdoc-inject-style-plugin": "^1.0.0",
"esdoc-standard-plugin": "^1.0.0",
"eslint": "^5.15.0",
"eslint-plugin-jsdoc": "^4.8.4",
"eslint-plugin-jsdoc": "^8.0.1",
"eslint-plugin-mocha": "^5.2.1",
"husky": "^2.2.0",
"js-combinatorics": "^0.5.4",
"lcov-result-merger": "^3.0.0",
"lint-staged": "^8.1.6",
"mariadb": "^2.0.5",
"markdownlint-cli": "^0.15.0",
"markdownlint-cli": "^0.16.0",
"mocha": "^6.0.2",
"mysql2": "^1.6.5",
"nyc": "^13.3.0",
......
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!