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

Enforcing view on an entity loader. All loads through this loader will throw if the loads are 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

Hierarchy

EnforcingEntityLoader

Index

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<TViewerContext>
- TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields, TEntity>
- TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity, TSelectedFields, TPrivacyPolicy>
- TSelectedFields extends string | number | symbol
Parameters
- entityLoader: EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
Returns EnforcingEntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>
- Defined in packages/entity/src/EnforcingEntityLoader.ts:30

Properties

`Private` `Readonly` entityLoader

entityLoader: EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

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:78

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:93

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:103

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:130

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:62

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:45

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:146

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:112

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:121

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:161

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

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

TFields extends object

TID extends {}

TViewerContext extends ViewerContext<TViewerContext>

TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields, TEntity>

TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TID, TViewerContext, TEntity, TSelectedFields, TPrivacyPolicy>

TSelectedFields extends string | number | symbol

Parameters

entityLoader: EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields>

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

Properties

Private Readonly entityLoader

Methods

loadByFieldEqualingAsync

Type Parameters

N extends string | number | symbol

Parameters

uniqueFieldName: N

fieldValue: NonNullable<TFields[N]>

Returns Promise<null | TEntity>

Throws

Throws

loadByIDAsync

Parameters

id: TID

Returns Promise<TEntity>

Throws

loadByIDNullableAsync

Parameters

id: TID

Returns Promise<null | TEntity>

Throws

Throws

loadFirstByFieldEqualityConjunctionAsync

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

loadManyByFieldEqualingAsync

Type Parameters

N extends string | number | symbol

Parameters

fieldName: N

fieldValue: NonNullable<TFields[N]>

Returns Promise<readonly TEntity[]>

Throws

loadManyByFieldEqualingManyAsync

Type Parameters

N extends string | number | symbol

Parameters

fieldName: N

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

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

Throws

loadManyByFieldEqualityConjunctionAsync

Type Parameters

N extends string | number | symbol

Parameters

fieldEqualityOperands: FieldEqualityCondition<TFields, N>[]

querySelectionModifiers: QuerySelectionModifiers<TFields> = {}

Returns Promise<readonly TEntity[]>

Throws

`Private` `Readonly` entityLoader