Class AlwaysSkipPrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>

A no-op policy rule that always skips.

Type Parameters

TFields extends object
TID extends NonNullable<TFields[TSelectedFields]>
TViewerContext extends ViewerContext
TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>
TSelectedFields extends keyof TFields = keyof TFields

Hierarchy (View Summary)

PrivacyPolicyRule<TFields, TID, TViewerContext, TEntity, TSelectedFields>
- AlwaysSkipPrivacyPolicyRule

Index

Constructors

Methods

Constructors

constructor

new AlwaysSkipPrivacyPolicyRule<
    TFields extends object,
    TID extends {},
    TViewerContext extends ViewerContext,
    TEntity extends
        ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
    TSelectedFields extends string
    | number
    | symbol = keyof TFields,
>(): AlwaysSkipPrivacyPolicyRule<
    TFields,
    TID,
    TViewerContext,
    TEntity,
    TSelectedFields,
>
Type Parameters
- TFields extends object
- TID extends {}
- TViewerContext extends ViewerContext
- TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>
- TSelectedFields extends string | number | symbol = keyof TFields
Returns AlwaysSkipPrivacyPolicyRule<
    TFields,
    TID,
    TViewerContext,
    TEntity,
    TSelectedFields,
>
Inherited from PrivacyPolicyRule.constructor

Methods

evaluateAsync

evaluateAsync(
    _viewerContext: TViewerContext,
    _queryContext: EntityQueryContext,
    _evaluationContext: EntityPrivacyPolicyEvaluationContext<
        TFields,
        TID,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >,
    _entity: TEntity,
): Promise<RuleEvaluationResult>
Parameters
- _viewerContext: TViewerContext
- _queryContext: EntityQueryContext
- _evaluationContext: EntityPrivacyPolicyEvaluationContext<
      TFields,
      TID,
      TViewerContext,
      TEntity,
      TSelectedFields,
  >
- _entity: TEntity
Returns Promise<RuleEvaluationResult>
Overrides PrivacyPolicyRule.evaluateAsync
- Defined in packages/entity/src/rules/AlwaysSkipPrivacyPolicyRule.ts:17