Class EnforcingEntityDeleter<TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Enforcing entity deleter. All deletes through this deleter will throw if authorization is not successful.

Type Parameters

TFields extends Record<string, any>
TIDField extends keyof NonNullable<Pick<TFields, TSelectedFields>>
TViewerContext extends ViewerContext
TEntity extends ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TIDField, TViewerContext, TEntity, TSelectedFields>
TSelectedFields extends keyof TFields

Index

Constructors

constructor

Methods

deleteAsync

Constructors

constructor

new EnforcingEntityDeleter<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
    TViewerContext extends ViewerContext,
    TEntity extends
        ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>,
    TPrivacyPolicy extends
        EntityPrivacyPolicy<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >,
    TSelectedFields extends string
    | number
    | symbol,
>(
    entityDeleter: AuthorizationResultBasedDeleteMutator<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TPrivacyPolicy,
        TSelectedFields,
    >,
): EnforcingEntityDeleter<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
- TViewerContext extends ViewerContext
- TEntity extends ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>
- TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TIDField, TViewerContext, TEntity, TSelectedFields>
- TSelectedFields extends string | number | symbol
Parameters
- entityDeleter: AuthorizationResultBasedDeleteMutator<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >
Returns EnforcingEntityDeleter<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
- Defined in packages/entity/src/EnforcingEntityDeleter.ts:26

Methods

deleteAsync

deleteAsync(): Promise<void>
Delete the entity after authorizing against delete privacy rules. The entity is invalidated in all caches. Throws when delete is not successful.

Returns Promise<void>
- Defined in packages/entity/src/EnforcingEntityDeleter.ts:41

Class EnforcingEntityDeleter<TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EnforcingEntityDeleter<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>

Methods

deleteAsync

Returns Promise<void>

Settings

On This Page

Class EnforcingEntityDeleter<TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EnforcingEntityDeleter< TFields, TIDField, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields,>

Methods

deleteAsync

Returns Promise<void>

Settings

On This Page

Returns EnforcingEntityDeleter<
TFields,
TIDField,
TViewerContext,
TEntity,
TPrivacyPolicy,
TSelectedFields,
>