Class HookAfterAggregateContext<S, N>

Type Parameters

S extends TSchema = TSchema
N extends TCollectionName<S> = TCollectionName<S>

Hierarchy

HookBeforeAggregateContext<S, N>
- HookAfterAggregateContext

Index

Constructors

Properties

_aggregation _filter _limit realCollection

Accessors

aggregateResult aggregation caller collection dataSource filter limit

Methods

throwError throwForbiddenError throwValidationError

Constructors

constructor

new HookAfterAggregateContext<S, N>(collection: Collection, caller: Caller, filter: Filter, aggregation: Aggregation, aggregateResult: TAggregateResult<S, N>[], limit?: number): HookAfterAggregateContext<S, N>
Type Parameters
- S extends TSchema = TSchema
- N extends string = Extract<keyof S, string>
Parameters
- collection: Collection
- caller: Caller
- filter: Filter
- aggregation: Aggregation
- aggregateResult: TAggregateResult<S, N>[]
- Optional limit: number
Returns HookAfterAggregateContext<S, N>
Overrides HookBeforeAggregateContext.constructor
- Defined in packages/datasource-customizer/src/decorators/hook/context/aggregate.ts:65

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>[]
- Defined in packages/datasource-customizer/src/decorators/hook/context/aggregate.ts:78

aggregation

get aggregation(): Readonly<TAggregation<S, N>>
Returns Readonly<TAggregation<S, N>>
Inherited from HookBeforeAggregateContext.aggregation
- Defined in packages/datasource-customizer/src/decorators/hook/context/aggregate.ts:40

caller

get caller(): Readonly<Caller>
Returns Readonly<Caller>
Inherited from HookBeforeAggregateContext.caller
- Defined in packages/datasource-customizer/src/context/agent-context.ts:19

collection

get collection(): default<S, N>
Returns default<S, N>
Inherited from HookBeforeAggregateContext.collection
- Defined in packages/datasource-customizer/src/context/collection-context.ts:13

dataSource

get dataSource(): default<S>
Returns default<S>
Inherited from HookBeforeAggregateContext.dataSource
- Defined in packages/datasource-customizer/src/context/agent-context.ts:10

filter

get filter(): Readonly<TFilter<S, N>>
Returns Readonly<TFilter<S, N>>
Inherited from HookBeforeAggregateContext.filter
- Defined in packages/datasource-customizer/src/decorators/hook/context/aggregate.ts:36

limit

get limit(): number
Returns number
Inherited from HookBeforeAggregateContext.limit
- Defined in packages/datasource-customizer/src/decorators/hook/context/aggregate.ts:44

Methods

throwError

throwError(message: string): never
Stop hooks execution and send error to the UI

Example
```
.throwError('My error message');
```
Parameters
- message: string
  
  the error message
Returns never
Inherited from HookBeforeAggregateContext.throwError
- Defined in packages/datasource-customizer/src/decorators/hook/context/hook.ts:40

throwForbiddenError

throwForbiddenError(message: string): never
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
Inherited from HookBeforeAggregateContext.throwForbiddenError
- Defined in packages/datasource-customizer/src/decorators/hook/context/hook.ts:30

throwValidationError

throwValidationError(message: string): never
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
Inherited from HookBeforeAggregateContext.throwValidationError
- Defined in packages/datasource-customizer/src/decorators/hook/context/hook.ts:20