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

The primary entry point for loading entities via knex queries (non-data-loader methods).

Type Parameters

TFields extends Record<string, any>
TIDField extends keyof NonNullable<Pick<TFields, TSelectedFields>>
TViewerContext extends ViewerContext
TEntity extends ReadonlyEntity<TFields, TIDField, TViewerContext, TSelectedFields>
TPrivacyPolicy extends EntityPrivacyPolicy<TFields, TIDField, TViewerContext, TEntity, TSelectedFields>
TSelectedFields extends keyof TFields

Index

Constructors

constructor

new KnexEntityLoaderFactory<
    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,
>(
    entityCompanion: EntityCompanion<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TPrivacyPolicy,
        TSelectedFields,
    >,
    knexDataManager: EntityKnexDataManager<TFields, TIDField>,
    metricsAdapter: IEntityMetricsAdapter,
): KnexEntityLoaderFactory<
    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
- entityCompanion: EntityCompanion<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TPrivacyPolicy,
      TSelectedFields,
  >
- knexDataManager: EntityKnexDataManager<TFields, TIDField>
- metricsAdapter: IEntityMetricsAdapter
Returns KnexEntityLoaderFactory<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
- Defined in entity-database-adapter-knex/src/KnexEntityLoaderFactory.ts:33

Properties

`Protected` `Readonly`metricsAdapter

metricsAdapter: IEntityMetricsAdapter

Methods

forLoad

forLoad(
    viewerContext: TViewerContext,
    queryContext: EntityQueryContext,
    privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >,
): AuthorizationResultBasedKnexEntityLoader<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
Vend knex loader for loading an entity in a given query context.
Parameters
- viewerContext: TViewerContext
  viewer context of loading user
- queryContext: EntityQueryContext
  query context in which to perform the load
- privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TSelectedFields,
  >
Returns AuthorizationResultBasedKnexEntityLoader<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
- Defined in entity-database-adapter-knex/src/KnexEntityLoaderFactory.ts:51

forLoadEnforcing

forLoadEnforcing(
    viewerContext: TViewerContext,
    queryContext: EntityQueryContext,
    privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext<
        TFields,
        TIDField,
        TViewerContext,
        TEntity,
        TSelectedFields,
    >,
): EnforcingKnexEntityLoader<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
Vend enforcing knex loader for loading an entity in a given query context.
Parameters
- viewerContext: TViewerContext
  viewer context of loading user
- queryContext: EntityQueryContext
  query context in which to perform the load
- privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext<
      TFields,
      TIDField,
      TViewerContext,
      TEntity,
      TSelectedFields,
  >
Returns EnforcingKnexEntityLoader<
    TFields,
    TIDField,
    TViewerContext,
    TEntity,
    TPrivacyPolicy,
    TSelectedFields,
>
- Defined in entity-database-adapter-knex/src/KnexEntityLoaderFactory.ts:93

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

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

`Protected` `Readonly`metricsAdapter

Methods

forLoad

Parameters

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

forLoadEnforcing

Parameters

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

Settings

On This Page

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

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

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

Properties

Protected ReadonlymetricsAdapter

Methods

forLoad

Parameters

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

forLoadEnforcing

Parameters

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

Settings

On This Page

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

`Protected` `Readonly`metricsAdapter

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

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