Class HookAfterAggregateContext<S, N>

Type Parameters

Hierarchy

Constructors

constructor

Properties

_aggregation _filter _limit realCollection

Accessors

aggregateResult aggregation caller collection dataSource filter limit

Methods

throwError throwForbiddenError throwValidationError

Constructors

constructor

Properties

Protected _aggregation

_aggregation: Aggregation

Protected _filter

_filter: Filter

Protected _limit

_limit: number

Protected realCollection

realCollection: Collection

Accessors

aggregateResult

  • get aggregateResult(): readonly TAggregateResult<S, N>[]

  • Returns readonly TAggregateResult<S, N>[]

aggregation

  • get aggregation(): Readonly<TAggregation<S, N>>

  • Returns Readonly<TAggregation<S, N>>

caller

  • get caller(): Readonly<Caller>

  • Returns Readonly<Caller>

collection

  • get collection(): default<S, N>

  • Returns default<S, N>

dataSource

  • get dataSource(): default<S>

  • Returns default<S>

filter

  • get filter(): Readonly<TFilter<S, N>>

  • Returns Readonly<TFilter<S, N>>

limit

  • get limit(): number

  • Returns number

Methods

throwError

  • Stop hooks execution and send error to the UI

    Example

    .throwError('My error message');

    Parameters

    • message: string

      the error message

    Returns never

throwForbiddenError

  • Stop hooks execution and send Forbidden error to the UI

    Example

    .throwForbiddenError('My forbidden error message');

    Parameters

    • message: string

      the forbidden error message

    Returns never

throwValidationError

  • Stop hooks execution and send Validation error to the UI

    Example

    .throwValidationError('My validation error message');

    Parameters

    • message: string

      the validation error message

    Returns never

Settings

Member Visibility

Theme