Entity
    Preparing search index...

    Interface EntityMutationTriggerConfiguration<TFields, TIDField, TViewerContext, TEntity, TSelectedFields>

    Interface to define trigger behavior for entities.

    interface EntityMutationTriggerConfiguration<
        TFields extends Record<string, any>,
        TIDField extends keyof NonNullable<Pick<TFields, TSelectedFields>>,
        TViewerContext extends ViewerContext,
        TEntity extends
            ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>,
        TSelectedFields extends keyof TFields = keyof TFields,
    > {
        afterAll?: EntityMutationTrigger<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >[];
        afterCommit?: EntityNonTransactionalMutationTrigger<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >[];
        afterCreate?: EntityMutationTrigger<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >[];
        afterDelete?: EntityMutationTrigger<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >[];
        afterUpdate?: EntityMutationTrigger<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >[];
        beforeAll?: EntityMutationTrigger<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >[];
        beforeCreate?: EntityMutationTrigger<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >[];
        beforeDelete?: EntityMutationTrigger<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >[];
        beforeUpdate?: EntityMutationTrigger<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >[];
    }

    Type Parameters

    Index

    Properties

    afterAll? afterCommit? afterCreate? afterDelete? afterUpdate? beforeAll? beforeCreate? beforeDelete? beforeUpdate?

    Properties

    afterAll?: EntityMutationTrigger<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >[]

    Trigger set that runs within the transaction but after the entity is created in, updated in, or deleted from the database and the cache is invalidated.

    afterCommit?: EntityNonTransactionalMutationTrigger<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >[]

    Trigger set that runs after committing the mutation transaction. If the call to the mutation is wrapped in a transaction, these will be run after the wrapping transaction is completed.

    afterCreate?: EntityMutationTrigger<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >[]

    Trigger set that runs within the transaction but after the entity is created in the database and cache is invalidated.

    afterDelete?: EntityMutationTrigger<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >[]

    Trigger set that runs within the transaction but after the entity is deleted from the database and cache is invalidated.

    afterUpdate?: EntityMutationTrigger<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >[]

    Trigger set that runs within the transaction but after the entity is updated in the database and cache is invalidated.

    beforeAll?: EntityMutationTrigger<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >[]

    Trigger set that runs within the transaction but before the entity is created, updated, or deleted.

    beforeCreate?: EntityMutationTrigger<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >[]

    Trigger set that runs within the transaction but before the entity is created in the database.

    beforeDelete?: EntityMutationTrigger<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >[]

    Trigger set that runs within the transaction but before the entity is deleted from the database.

    beforeUpdate?: EntityMutationTrigger<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >[]

    Trigger set that runs within the transaction but before the entity is updated in the database.

    Settings

    Member Visibility

    On This Page

    Properties