Function canViewerDeleteAsync

canViewerDeleteAsync<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
    TViewerContext extends ViewerContext,
    TEntity extends Entity<TFields, TIDField, TViewerContext, TSelectedFields>,
    TPrivacyPolicy extends
        EntityPrivacyPolicy<
            TFields,
            TIDField,
            TViewerContext,
            TEntity,
            TSelectedFields,
        >,
    TSelectedFields extends string
    | number
    | symbol = keyof TFields,
>(
    entityClass: IEntityClass<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TPrivacyPolicy,
        TSelectedFields,
    >,
    sourceEntity: TEntity,
    queryContext?: EntityQueryContext,
): Promise<boolean>
Check whether a single entity loaded by a viewer can be deleted by that same viewer. This recursively checks edge cascade permissions (EntityEdgeDeletionBehavior) as well.
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
- TViewerContext extends ViewerContext
- TEntity extends Entity<TFields, TIDField, TViewerContext, TSelectedFields>
- TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TIDField, TViewerContext, TEntity, TSelectedFields>
- TSelectedFields extends string | number | symbol = keyof TFields
Parameters
- entityClass: IEntityClass<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >
  class of entity
- sourceEntity: TEntity
  entity loaded by viewer
- queryContext: EntityQueryContext = ...
  query context in which to perform the check
Returns Promise<boolean>
See
canViewerUpdateAsync
- Defined in packages/entity/src/utils/EntityPrivacyUtils.ts:188

Function canViewerDeleteAsync

Type Parameters

Parameters

Returns Promise<boolean>

See

Settings