Class HookBeforeListContext<S, N>

Type Parameters

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

Hierarchy

HookContext<S, N>
- HookBeforeListContext
  - HookAfterListContext

Index

Constructors

Properties

_filter _projection realCollection

Accessors

caller collection dataSource filter projection

Methods

throwError throwForbiddenError throwValidationError

Constructors

constructor

new HookBeforeListContext<S, N>(collection: Collection, caller: Caller, filter: PaginatedFilter, projection: Projection): HookBeforeListContext<S, N>
Type Parameters
- S extends TSchema = TSchema
- N extends string = Extract<keyof S, string>
Parameters
- collection: Collection
- caller: Caller
- filter: PaginatedFilter
- projection: Projection
Returns HookBeforeListContext<S, N>
Overrides HookContext.constructor
- Defined in packages/datasource-customizer/src/decorators/hook/context/list.ts:21

Properties

`Protected` _filter

_filter: PaginatedFilter

`Protected` _projection

_projection: Projection

`Protected` realCollection

realCollection: Collection

Accessors

caller

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

collection

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

dataSource

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

filter

get filter(): Readonly<TPaginatedFilter<S, N>>
Returns Readonly<TPaginatedFilter<S, N>>
- Defined in packages/datasource-customizer/src/decorators/hook/context/list.ts:33

projection

get projection(): readonly TFieldName<S, N>[]
Returns readonly TFieldName<S, N>[]
- Defined in packages/datasource-customizer/src/decorators/hook/context/list.ts:37

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 HookContext.throwError
- Defined in packages/datasource-customizer/src/context/agent-context.ts:55

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 HookContext.throwForbiddenError
- Defined in packages/datasource-customizer/src/context/agent-context.ts:45

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 HookContext.throwValidationError
- Defined in packages/datasource-customizer/src/context/agent-context.ts:35