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

constructor

• new AuthorizationResultBasedEntityLoader<
      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,
  >(
      queryContext: EntityQueryContext,
      entityConfiguration: EntityConfiguration<TFields, TIDField>,
      entityClass: IEntityClass<
          TFields,
          TIDField,
          TViewerContext,
          TEntity,
          TPrivacyPolicy,
          TSelectedFields,
      >,
      dataManager: EntityDataManager<TFields, TIDField>,
      metricsAdapter: IEntityMetricsAdapter,
      utils: EntityLoaderUtils<
          TFields,
          TIDField,
          TViewerContext,
          TEntity,
          TPrivacyPolicy,
          TSelectedFields,
      >,
  ): AuthorizationResultBasedEntityLoader<
      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

  • queryContext: EntityQueryContext
  • entityConfiguration: EntityConfiguration<TFields, TIDField>
  • entityClass: IEntityClass<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TPrivacyPolicy,
        TSelectedFields,
    >
  • dataManager: EntityDataManager<TFields, TIDField>
  • metricsAdapter: IEntityMetricsAdapter
  • utils: EntityLoaderUtils<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TPrivacyPolicy,
        TSelectedFields,
    >

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

Readonlyutils

loadByCompositeFieldEqualingAsync

• loadByCompositeFieldEqualingAsync<
      N extends EntityCompositeField<Pick<TFields, TSelectedFields>>,
  >(
      compositeField: N,
      compositeFieldValue: EntityCompositeFieldValue<
          Pick<TFields, TSelectedFields>,
          N,
      >,
  ): Promise<null | Result<TEntity>>

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Type Parameters

  • N extends EntityCompositeField<Pick<TFields, TSelectedFields>>

  Parameters

  • compositeField: N
  • compositeFieldValue: EntityCompositeFieldValue<Pick<TFields, TSelectedFields>, N>

  Returns Promise<null | Result<TEntity>>

  entity result where uniqueFieldName equals fieldValue, where result error can be UnauthorizedError.

loadByFieldEqualingAsync

• loadByFieldEqualingAsync<N extends string | number | symbol>(
      uniqueFieldName: N,
      fieldValue: NonNullable<TFields[N]>,
  ): Promise<null | Result<TEntity>>

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Type Parameters

  • N extends string | number | symbol

  Parameters

  • uniqueFieldName: N
  • fieldValue: NonNullable<TFields[N]>

  Returns Promise<null | Result<TEntity>>

  entity result where uniqueFieldName equals fieldValue, or null if no entity matches the condition.

  Throws

  when multiple entities match the condition

loadByIDAsync

• loadByIDAsync(id: TFields[TIDField]): Promise<Result<TEntity>>

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Parameters

  • id: TFields[TIDField]

  Returns Promise<Result<TEntity>>

  entity result for matching ID, where result error can be UnauthorizedError or EntityNotFoundError.

loadByIDNullableAsync

• loadByIDNullableAsync(id: TFields[TIDField]): Promise<null | Result<TEntity>>

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Parameters

  • id: TFields[TIDField]

  Returns Promise<null | Result<TEntity>>

  entity result for matching ID, or null if no entity exists for ID.

loadFirstByFieldEqualityConjunctionAsync

• loadFirstByFieldEqualityConjunctionAsync<N extends string | number | symbol>(
      fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
      querySelectionModifiers: Omit<QuerySelectionModifiers<TFields>, "limit"> & Required<
          Pick<QuerySelectionModifiers<TFields>, "orderBy">,
      >,
  ): Promise<null | Result<TEntity>>

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Type Parameters

  • N extends string | number | symbol

  Parameters

  • fieldEqualityOperands: FieldEqualityCondition<TFields, N>[]
  • querySelectionModifiers: Omit<QuerySelectionModifiers<TFields>, "limit"> & Required<
        Pick<QuerySelectionModifiers<TFields>, "orderBy">,
    >

  Returns Promise<null | Result<TEntity>>

  the first entity results that matches the query, where result error can be UnauthorizedError

loadManyByCompositeFieldEqualingAsync

• loadManyByCompositeFieldEqualingAsync<
      N extends EntityCompositeField<Pick<TFields, TSelectedFields>>,
  >(
      compositeField: N,
      compositeFieldValue: EntityCompositeFieldValue<
          Pick<TFields, TSelectedFields>,
          N,
      >,
  ): Promise<readonly Result<TEntity>[]>

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Type Parameters

  • N extends EntityCompositeField<Pick<TFields, TSelectedFields>>

  Parameters

  • compositeField: N
  • compositeFieldValue: EntityCompositeFieldValue<Pick<TFields, TSelectedFields>, N>

  Returns Promise<readonly Result<TEntity>[]>

  array of entity results that match the query for compositeFieldValue, where result error can be UnauthorizedError

loadManyByCompositeFieldEqualingManyAsync

• loadManyByCompositeFieldEqualingManyAsync<
      N extends EntityCompositeField<Pick<TFields, TSelectedFields>>,
  >(
      compositeField: N,
      compositeFieldValues: readonly EntityCompositeFieldValue<
          Pick<TFields, TSelectedFields>,
          N,
      >[],
  ): Promise<
      ReadonlyMap<
          EntityCompositeFieldValue<TFields, N>,
          readonly Result<TEntity>[],
      >,
  >

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Type Parameters

  • N extends EntityCompositeField<Pick<TFields, TSelectedFields>>

  Parameters

  • compositeField: N
  • compositeFieldValues: readonly EntityCompositeFieldValue<Pick<TFields, TSelectedFields>, N>[]

  Returns Promise<
      ReadonlyMap<
          EntityCompositeFieldValue<TFields, N>,
          readonly Result<TEntity>[],
      >,
  >

  map from compositeField to entity results that match the query for that compositeField, where result errors can be UnauthorizedError

loadManyByFieldEqualingAsync

• loadManyByFieldEqualingAsync<N extends string | number | symbol>(
      fieldName: N,
      fieldValue: NonNullable<TFields[N]>,
  ): Promise<readonly Result<TEntity>[]>

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Type Parameters

  • N extends string | number | symbol

  Parameters

  • fieldName: N
  • fieldValue: NonNullable<TFields[N]>

  Returns Promise<readonly Result<TEntity>[]>

  array of entity results that match the query for fieldValue, where result error can be UnauthorizedError

loadManyByFieldEqualingManyAsync

• loadManyByFieldEqualingManyAsync<N extends string | number | symbol>(
      fieldName: N,
      fieldValues: readonly NonNullable<TFields[N]>[],
  ): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>>

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Type Parameters

  • N extends string | number | symbol

  Parameters

  • fieldName: N
  • fieldValues: readonly NonNullable<TFields[N]>[]

  Returns Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>>

  map from fieldValue to entity results that match the query for that fieldValue, where result errors can be UnauthorizedError

loadManyByFieldEqualityConjunctionAsync

• loadManyByFieldEqualityConjunctionAsync<N extends string | number | symbol>(
      fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
      querySelectionModifiers?: QuerySelectionModifiers<TFields>,
  ): Promise<readonly Result<TEntity>[]>

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Type Parameters

  • N extends string | number | symbol

  Parameters

  • fieldEqualityOperands: FieldEqualityCondition<TFields, N>[]
  • querySelectionModifiers: QuerySelectionModifiers<TFields> = {}

  Returns Promise<readonly Result<TEntity>[]>

  array of entity results that match the query, where result error can be UnauthorizedError

loadManyByIDsAsync

• loadManyByIDsAsync(
      ids: readonly TFields[TIDField][],
  ): Promise<ReadonlyMap<TFields[TIDField], Result<TEntity>>>

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Parameters

  • ids: readonly TFields[TIDField][]

  Returns Promise<ReadonlyMap<TFields[TIDField], Result<TEntity>>>

  map from ID to corresponding entity result, where result error can be UnauthorizedError or EntityNotFoundError.

loadManyByIDsNullableAsync

• loadManyByIDsNullableAsync(
      ids: readonly TFields[TIDField][],
  ): Promise<ReadonlyMap<TFields[TIDField], null | Result<TEntity>>>

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Parameters

  • ids: readonly TFields[TIDField][]

  Returns Promise<ReadonlyMap<TFields[TIDField], null | Result<TEntity>>>

  map from ID to nullable corresponding entity result, where result error can be UnauthorizedError.

loadManyByRawWhereClauseAsync

• loadManyByRawWhereClauseAsync(
      rawWhereClause: string,
      bindings: object | any[],
      querySelectionModifiers?: QuerySelectionModifiersWithOrderByRaw<TFields>,
  ): Promise<readonly Result<TEntity>[]>

  Authorization-result-based version of the EnforcingEntityLoader method by the same name.

  Parameters

  • rawWhereClause: string
  • bindings: object | any[]
  • querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields> = {}

  Returns Promise<readonly Result<TEntity>[]>

  array of entity results that match the query, where result error can be UnauthorizedError

  Throws

  Error when rawWhereClause or bindings are invalid