Class EnforcingEntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Enforcing entity loader. All normal loads are batched, cached, and authorized against the entity's EntityPrivacyPolicy. All loads through this loader will throw if the load is not successful.

Type Parameters

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

Index

Constructors

constructor

Methods

loadByFieldEqualingAsync loadByIDAsync loadByIDNullableAsync loadFirstByFieldEqualityConjunctionAsync loadManyByFieldEqualingAsync loadManyByFieldEqualingManyAsync loadManyByFieldEqualityConjunctionAsync loadManyByIDsAsync loadManyByIDsNullableAsync loadManyByRawWhereClauseAsync

Constructors

constructor

new EnforcingEntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>(entityLoader): EnforcingEntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Type Parameters
- TFields extends object
- TID extends {}
- TViewerContext extends ViewerContext
- TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>
- TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity, TSelectedFields>
- TSelectedFields extends string | number | symbol
Parameters
- entityLoader: AuthorizationResultBasedEntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Returns EnforcingEntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- Defined in packages/entity/src/EnforcingEntityLoader.ts:31

Methods

loadByFieldEqualingAsync

loadByFieldEqualingAsync<N>(uniqueFieldName, fieldValue): Promise<null | TEntity>
Enforcing version of entity loader method by the same name.
Type Parameters
- N extends string | number | symbol
Parameters
- uniqueFieldName: N
- fieldValue: NonNullable<TFields[N]>
Returns Promise<null | TEntity>
Throws
EntityNotAuthorizedError when viewer is not authorized to view the returned entity

Throws
when multiple entities are found matching the condition
- Defined in packages/entity/src/EnforcingEntityLoader.ts:79

loadByIDAsync

loadByIDAsync(id): Promise<TEntity>
Enforcing version of entity loader method by the same name.
Parameters
- id: TID
Returns Promise<TEntity>
Throws
EntityNotAuthorizedError when viewer is not authorized to view the returned entity
- Defined in packages/entity/src/EnforcingEntityLoader.ts:94

loadByIDNullableAsync

loadByIDNullableAsync(id): Promise<null | TEntity>
Enforcing version of entity loader method by the same name.
Parameters
- id: TID
Returns Promise<null | TEntity>
Throws
EntityNotAuthorizedError when viewer is not authorized to view the returned entity

Throws
when multiple entities are found matching the condition
- Defined in packages/entity/src/EnforcingEntityLoader.ts:104

loadFirstByFieldEqualityConjunctionAsync

loadFirstByFieldEqualityConjunctionAsync<N>(fieldEqualityOperands, querySelectionModifiers): Promise<null | TEntity>
Enforcing version of entity loader 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 | TEntity>
Throws
EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
- Defined in packages/entity/src/EnforcingEntityLoader.ts:131

loadManyByFieldEqualingAsync

loadManyByFieldEqualingAsync<N>(fieldName, fieldValue): Promise<readonly TEntity[]>
Enforcing version of entity loader method by the same name.
Type Parameters
- N extends string | number | symbol
Parameters
- fieldName: N
- fieldValue: NonNullable<TFields[N]>
Returns Promise<readonly TEntity[]>
Throws
EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
- Defined in packages/entity/src/EnforcingEntityLoader.ts:63

loadManyByFieldEqualingManyAsync

loadManyByFieldEqualingManyAsync<N>(fieldName, fieldValues): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly TEntity[]>>
Enforcing version of entity loader 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 TEntity[]>>
Throws
EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
- Defined in packages/entity/src/EnforcingEntityLoader.ts:46

loadManyByFieldEqualityConjunctionAsync

loadManyByFieldEqualityConjunctionAsync<N>(fieldEqualityOperands, querySelectionModifiers?): Promise<readonly TEntity[]>
Enforcing version of entity loader method by the same name.
Type Parameters
- N extends string | number | symbol
Parameters
- fieldEqualityOperands: FieldEqualityCondition<TFields, N>[]
- querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
Returns Promise<readonly TEntity[]>
Throws
EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
- Defined in packages/entity/src/EnforcingEntityLoader.ts:147

loadManyByIDsAsync

loadManyByIDsAsync(ids): Promise<ReadonlyMap<TID, TEntity>>
Enforcing version of entity loader method by the same name.
Parameters
- ids: readonly TID[]
Returns Promise<ReadonlyMap<TID, TEntity>>
Throws
EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
- Defined in packages/entity/src/EnforcingEntityLoader.ts:113

loadManyByIDsNullableAsync

loadManyByIDsNullableAsync(ids): Promise<ReadonlyMap<TID, null | TEntity>>
Enforcing version of entity loader method by the same name.
Parameters
- ids: readonly TID[]
Returns Promise<ReadonlyMap<TID, null | TEntity>>
Throws
EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
- Defined in packages/entity/src/EnforcingEntityLoader.ts:122

loadManyByRawWhereClauseAsync

loadManyByRawWhereClauseAsync(rawWhereClause, bindings, querySelectionModifiers?): Promise<readonly TEntity[]>
Enforcing version of entity loader method by the same name.
Parameters
- rawWhereClause: string
- bindings: object | any[]
- querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields> = {}
Returns Promise<readonly TEntity[]>
Throws
EntityNotAuthorizedError when viewer is not authorized to view one or more of the returned entities
- Defined in packages/entity/src/EnforcingEntityLoader.ts:162

Class EnforcingEntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EnforcingEntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

Methods

loadByFieldEqualingAsync

Type Parameters

Parameters

Returns Promise<null | TEntity>

Throws

Throws

loadByIDAsync

Parameters

Returns Promise<TEntity>

Throws

loadByIDNullableAsync

Parameters

Returns Promise<null | TEntity>

Throws

Throws

loadFirstByFieldEqualityConjunctionAsync

Type Parameters

Parameters

Returns Promise<null | TEntity>

Throws

loadManyByFieldEqualingAsync

Type Parameters

Parameters

Returns Promise<readonly TEntity[]>

Throws

loadManyByFieldEqualingManyAsync

Type Parameters

Parameters

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

Throws

loadManyByFieldEqualityConjunctionAsync

Type Parameters

Parameters

Returns Promise<readonly TEntity[]>

Throws

loadManyByIDsAsync

Parameters

Returns Promise<ReadonlyMap<TID, TEntity>>

Throws

loadManyByIDsNullableAsync

Parameters

Returns Promise<ReadonlyMap<TID, null | TEntity>>

Throws

loadManyByRawWhereClauseAsync

Parameters

Returns Promise<readonly TEntity[]>

Throws

Settings

On This Page