Interface SequelizeHooks<Dialect>

interface SequelizeHooks<Dialect> {
    _UNSTABLE_afterBulkDestroy(options, deletedCount): AsyncHookReturn;
    _UNSTABLE_beforeBulkDestroy(options): AsyncHookReturn;
    afterAssociate(data, options): AsyncHookReturn;
    afterBulkCreate(instances, options): AsyncHookReturn;
    afterBulkDestroy(options): AsyncHookReturn;
    afterBulkRestore(options): AsyncHookReturn;
    afterBulkSync(options): AsyncHookReturn;
    afterBulkUpdate(options): AsyncHookReturn;
    afterConnect(connection, config): AsyncHookReturn;
    afterCreate(attributes, options): AsyncHookReturn;
    afterDefine(model): void;
    afterDefinitionRefresh(): void;
    afterDestroy(instance, options): AsyncHookReturn;
    afterDestroyMany(instances, options, deletedCount): AsyncHookReturn;
    afterDisconnect(connection): AsyncHookReturn;
    afterFind(instancesOrInstance, options): AsyncHookReturn;
    afterPoolAcquire(connection, options?): AsyncHookReturn;
    afterQuery(options, query): AsyncHookReturn;
    afterRestore(instance, options): AsyncHookReturn;
    afterSave(instance, options): AsyncHookReturn;
    afterSync(options): AsyncHookReturn;
    afterUpdate(instance, options): AsyncHookReturn;
    afterUpsert(attributes, options): AsyncHookReturn;
    afterValidate(instance, options): AsyncHookReturn;
    beforeAssociate(data, options): AsyncHookReturn;
    beforeBulkCreate(instances, options): AsyncHookReturn;
    beforeBulkDestroy(options): AsyncHookReturn;
    beforeBulkRestore(options): AsyncHookReturn;
    beforeBulkSync(options): AsyncHookReturn;
    beforeBulkUpdate(options): AsyncHookReturn;
    beforeConnect(config): AsyncHookReturn;
    beforeCount(options): AsyncHookReturn;
    beforeCreate(attributes, options): AsyncHookReturn;
    beforeDefine(attributes, options): void;
    beforeDefinitionRefresh(): void;
    beforeDestroy(instance, options): AsyncHookReturn;
    beforeDestroyMany(instances, options): AsyncHookReturn;
    beforeDisconnect(connection): AsyncHookReturn;
    beforeFind(options): AsyncHookReturn;
    beforeFindAfterExpandIncludeAll(options): AsyncHookReturn;
    beforeFindAfterOptions(options): AsyncHookReturn;
    beforePoolAcquire(options?): AsyncHookReturn;
    beforeQuery(options, query): AsyncHookReturn;
    beforeRestore(instance, options): AsyncHookReturn;
    beforeSave(instance, options): AsyncHookReturn;
    beforeSync(options): AsyncHookReturn;
    beforeUpdate(instance, options): AsyncHookReturn;
    beforeUpsert(attributes, options): AsyncHookReturn;
    beforeValidate(instance, options): AsyncHookReturn;
    validationFailed(instance, options, error): AsyncHookReturn;
}

Type Parameters

Dialect extends AbstractDialect

Hierarchy (view full)

ModelHooks
- SequelizeHooks

Methods

_UNSTABLE_afterBulkDestroy

_UNSTABLE_afterBulkDestroy(options, deletedCount): AsyncHookReturn
Parameters
- options: DestroyOptions<any>
- deletedCount: number
Returns AsyncHookReturn
Inherited from ModelHooks._UNSTABLE_afterBulkDestroy
- Defined in packages/core/src/model-hooks.ts:66

_UNSTABLE_beforeBulkDestroy

_UNSTABLE_beforeBulkDestroy(options): AsyncHookReturn
Parameters
- options: DestroyOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks._UNSTABLE_beforeBulkDestroy
- Defined in packages/core/src/model-hooks.ts:65

afterAssociate

afterAssociate(data, options): AsyncHookReturn
Parameters
- data: AfterAssociateEventData
- options: AssociationOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.afterAssociate
- Defined in packages/core/src/model-hooks.ts:119

afterBulkCreate

afterBulkCreate(instances, options): AsyncHookReturn
Parameters
- instances: readonly Model<any, any>[]
- options: BulkCreateOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.afterBulkCreate
- Defined in packages/core/src/model-hooks.ts:59

afterBulkDestroy

afterBulkDestroy(options): AsyncHookReturn
Parameters
- options: DestroyOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.afterBulkDestroy
- Defined in packages/core/src/model-hooks.ts:64

afterBulkRestore

afterBulkRestore(options): AsyncHookReturn
Parameters
- options: RestoreOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.afterBulkRestore
- Defined in packages/core/src/model-hooks.ts:71

afterBulkSync

afterBulkSync(options): AsyncHookReturn
A hook that is run at the end of Sequelize#sync
Parameters
- options: SyncOptions
Returns AsyncHookReturn
- Defined in packages/core/src/sequelize-typescript.ts:124

afterBulkUpdate

afterBulkUpdate(options): AsyncHookReturn
Parameters
- options: UpdateOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.afterBulkUpdate
- Defined in packages/core/src/model-hooks.ts:73

afterConnect

afterConnect(connection, config): AsyncHookReturn
A hook that is run after a connection is created
Parameters
- connection: AbstractConnection
- config: ConnectionOptions<Dialect>
Returns AsyncHookReturn
- Defined in packages/core/src/sequelize-typescript.ts:102

afterCreate

afterCreate(attributes, options): AsyncHookReturn
Parameters
- attributes: Model<any, any>
- options: CreateOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.afterCreate
- Defined in packages/core/src/model-hooks.ts:32

afterDefine

afterDefine(model): void
A hook that is run at the end of Sequelize#define and Model.init
Parameters
- model: ModelStatic
Returns void
- Defined in packages/core/src/sequelize-typescript.ts:92

afterDefinitionRefresh

afterDefinitionRefresh(): void
Runs after the definition of the model has changed because ModelDefinition#refreshAttributes was called.

Returns void
Inherited from ModelHooks.afterDefinitionRefresh
- Defined in packages/core/src/model-hooks.ts:129

afterDestroy

afterDestroy(instance, options): AsyncHookReturn
Parameters
- instance: Model<any, any>
- options: InstanceDestroyOptions
Returns AsyncHookReturn
Inherited from ModelHooks.afterDestroy
- Defined in packages/core/src/model-hooks.ts:34

afterDestroyMany

afterDestroyMany(instances, options, deletedCount): AsyncHookReturn
Parameters
- instances: readonly Model<any, any>[]
- options: DestroyManyOptions
- deletedCount: number
Returns AsyncHookReturn
Inherited from ModelHooks.afterDestroyMany
- Defined in packages/core/src/model-hooks.ts:36

afterDisconnect

afterDisconnect(connection): AsyncHookReturn
A hook that is run after a connection is disconnected
Parameters
- connection: unknown
Returns AsyncHookReturn
- Defined in packages/core/src/sequelize-typescript.ts:112

afterFind

afterFind(instancesOrInstance, options): AsyncHookReturn
A hook that is run after a find (select) query
Parameters
- instancesOrInstance: null | Model<any, any> | readonly Model<any, any>[]
- options: FindOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.afterFind
- Defined in packages/core/src/model-hooks.ts:101

afterPoolAcquire

afterPoolAcquire(connection, options?): AsyncHookReturn
A hook that is run after a connection to the pool
Parameters
- connection: AbstractConnection
- Optional options: AcquireConnectionOptions
Returns AsyncHookReturn
- Defined in packages/core/src/sequelize-typescript.ts:134

afterSync

afterSync(options): AsyncHookReturn
A hook that is run at the end of Model.sync
Parameters
- options: SyncOptions
Returns AsyncHookReturn
Inherited from ModelHooks.afterSync
- Defined in packages/core/src/model-hooks.ts:114

afterUpdate

afterUpdate(instance, options): AsyncHookReturn
Parameters
- instance: Model<any, any>
- options: InstanceUpdateOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.afterUpdate
- Defined in packages/core/src/model-hooks.ts:44

afterUpsert

afterUpsert(attributes, options): AsyncHookReturn
Parameters
- attributes: [Model<any, any>, null | boolean]
- options: UpsertOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.afterUpsert
- Defined in packages/core/src/model-hooks.ts:46

afterValidate

afterValidate(instance, options): AsyncHookReturn
Parameters
- instance: Model<any, any>
- options: ValidationOptions
Returns AsyncHookReturn
Inherited from ModelHooks.afterValidate
- Defined in packages/core/src/model-hooks.ts:29

beforeAssociate

beforeAssociate(data, options): AsyncHookReturn
Parameters
- data: BeforeAssociateEventData
- options: AssociationOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.beforeAssociate
- Defined in packages/core/src/model-hooks.ts:115

beforeBulkCreate

beforeBulkCreate(instances, options): AsyncHookReturn
Parameters
- instances: Model<any, any>[]
- options: BulkCreateOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.beforeBulkCreate
- Defined in packages/core/src/model-hooks.ts:58

beforeBulkDestroy

beforeBulkDestroy(options): AsyncHookReturn
Parameters
- options: DestroyOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.beforeBulkDestroy
- Defined in packages/core/src/model-hooks.ts:63

beforeBulkRestore

beforeBulkRestore(options): AsyncHookReturn
Parameters
- options: RestoreOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.beforeBulkRestore
- Defined in packages/core/src/model-hooks.ts:70

beforeBulkSync

beforeBulkSync(options): AsyncHookReturn
A hook that is run at the start of Sequelize#sync
Parameters
- options: SyncOptions
Returns AsyncHookReturn
- Defined in packages/core/src/sequelize-typescript.ts:119

beforeBulkUpdate

beforeBulkUpdate(options): AsyncHookReturn
Parameters
- options: UpdateOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.beforeBulkUpdate
- Defined in packages/core/src/model-hooks.ts:72

beforeConnect

beforeConnect(config): AsyncHookReturn
A hook that is run before a connection is created
Parameters
- config: ConnectionOptions<Dialect>
Returns AsyncHookReturn
- Defined in packages/core/src/sequelize-typescript.ts:97

beforeCount

beforeCount(options): AsyncHookReturn
A hook that is run at the start of Model.count
Parameters
- options: CountOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.beforeCount
- Defined in packages/core/src/model-hooks.ts:78

beforeCreate

beforeCreate(attributes, options): AsyncHookReturn
Parameters
- attributes: Model<any, any>
- options: CreateOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.beforeCreate
- Defined in packages/core/src/model-hooks.ts:31

beforeDefine

beforeDefine(attributes, options): void
A hook that is run at the start of Sequelize#define and Model.init
Parameters
- attributes: ModelAttributes<any, any>
- options: ModelOptions<Model<any, any>>
Returns void
- Defined in packages/core/src/sequelize-typescript.ts:87

beforeDefinitionRefresh

beforeDefinitionRefresh(): void
Runs before the definition of the model changes because ModelDefinition#refreshAttributes was called.

Returns void
Inherited from ModelHooks.beforeDefinitionRefresh
- Defined in packages/core/src/model-hooks.ts:124

beforeDestroy

beforeDestroy(instance, options): AsyncHookReturn
Parameters
- instance: Model<any, any>
- options: InstanceDestroyOptions
Returns AsyncHookReturn
Inherited from ModelHooks.beforeDestroy
- Defined in packages/core/src/model-hooks.ts:33

beforeDestroyMany

beforeDestroyMany(instances, options): AsyncHookReturn
Parameters
- instances: Model<any, any>[]
- options: DestroyManyOptions
Returns AsyncHookReturn
Inherited from ModelHooks.beforeDestroyMany
- Defined in packages/core/src/model-hooks.ts:35

beforeDisconnect

beforeDisconnect(connection): AsyncHookReturn
A hook that is run before a connection is disconnected
Parameters
- connection: AbstractConnection
Returns AsyncHookReturn
- Defined in packages/core/src/sequelize-typescript.ts:107

beforeFind

beforeFind(options): AsyncHookReturn
A hook that is run before a find (select) query
Parameters
- options: FindOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.beforeFind
- Defined in packages/core/src/model-hooks.ts:83

beforeFindAfterExpandIncludeAll

beforeFindAfterExpandIncludeAll(options): AsyncHookReturn
A hook that is run before a find (select) query, after any { include: {all: ...} } options are expanded
Parameters
- options: FindOptions<any>
Returns AsyncHookReturn
Deprecated
use beforeFind instead
Inherited from ModelHooks.beforeFindAfterExpandIncludeAll
- Defined in packages/core/src/model-hooks.ts:90

beforeFindAfterOptions

beforeFindAfterOptions(options): AsyncHookReturn
A hook that is run before a find (select) query, after all option have been normalized
Parameters
- options: FindOptions<any>
Returns AsyncHookReturn
Deprecated
use beforeFind instead
Inherited from ModelHooks.beforeFindAfterOptions
- Defined in packages/core/src/model-hooks.ts:97

beforePoolAcquire

beforePoolAcquire(options?): AsyncHookReturn
A hook that is run before a connection to the pool
Parameters
- Optional options: AcquireConnectionOptions
Returns AsyncHookReturn
- Defined in packages/core/src/sequelize-typescript.ts:129

beforeQuery

beforeQuery(options, query): AsyncHookReturn
Parameters
- options: QueryOptions
- query: AbstractQuery
Returns AsyncHookReturn
- Defined in packages/core/src/sequelize-typescript.ts:113

beforeRestore

beforeRestore(instance, options): AsyncHookReturn
Parameters
- instance: Model<any, any>
- options: InstanceRestoreOptions
Returns AsyncHookReturn
Inherited from ModelHooks.beforeRestore
- Defined in packages/core/src/model-hooks.ts:41

beforeSave

beforeSave(instance, options): AsyncHookReturn
Parameters
- instance: Model<any, any>
- options: CreateOptions<any> | InstanceUpdateOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.beforeSave
- Defined in packages/core/src/model-hooks.ts:50

beforeSync

beforeSync(options): AsyncHookReturn
A hook that is run at the start of Model.sync
Parameters
- options: SyncOptions
Returns AsyncHookReturn
Inherited from ModelHooks.beforeSync
- Defined in packages/core/src/model-hooks.ts:109

beforeUpdate

beforeUpdate(instance, options): AsyncHookReturn
Parameters
- instance: Model<any, any>
- options: InstanceUpdateOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.beforeUpdate
- Defined in packages/core/src/model-hooks.ts:43

beforeUpsert

beforeUpsert(attributes, options): AsyncHookReturn
Parameters
- attributes: Model<any, any>
- options: UpsertOptions<any>
Returns AsyncHookReturn
Inherited from ModelHooks.beforeUpsert
- Defined in packages/core/src/model-hooks.ts:45

beforeValidate

beforeValidate(instance, options): AsyncHookReturn
Parameters
- instance: Model<any, any>
- options: ValidationOptions
Returns AsyncHookReturn
Inherited from ModelHooks.beforeValidate
- Defined in packages/core/src/model-hooks.ts:28

validationFailed

validationFailed(instance, options, error): AsyncHookReturn
Parameters
- instance: Model<any, any>
- options: ValidationOptions
- error: unknown
Returns AsyncHookReturn
Inherited from ModelHooks.validationFailed
- Defined in packages/core/src/model-hooks.ts:30

Interface SequelizeHooks<Dialect>

Type Parameters

Hierarchy (view full)

Index

Methods

Methods

_UNSTABLE_afterBulkDestroy

Parameters

Returns AsyncHookReturn

_UNSTABLE_beforeBulkDestroy

Parameters

Returns AsyncHookReturn

afterAssociate

Parameters

Returns AsyncHookReturn

afterBulkCreate

Parameters

Returns AsyncHookReturn

afterBulkDestroy

Parameters

Returns AsyncHookReturn

afterBulkRestore

Parameters

Returns AsyncHookReturn

afterBulkSync

Parameters

Returns AsyncHookReturn

afterBulkUpdate

Parameters

Returns AsyncHookReturn

afterConnect

Parameters

Returns AsyncHookReturn

afterCreate

Parameters

Returns AsyncHookReturn

afterDefine

Parameters

Returns void

afterDefinitionRefresh

Returns void

afterDestroy

Parameters

Returns AsyncHookReturn

afterDestroyMany

Parameters

Returns AsyncHookReturn

afterDisconnect

Parameters

Returns AsyncHookReturn

afterFind

Parameters

Returns AsyncHookReturn

afterPoolAcquire

Parameters

Returns AsyncHookReturn

afterQuery

Parameters

Returns AsyncHookReturn

afterRestore

Parameters

Returns AsyncHookReturn

afterSave

Parameters

Returns AsyncHookReturn

afterSync

Parameters

Returns AsyncHookReturn

afterUpdate

Parameters

Returns AsyncHookReturn

afterUpsert

Parameters

Returns AsyncHookReturn

afterValidate

Parameters

Returns AsyncHookReturn

beforeAssociate

Parameters

Returns AsyncHookReturn