Class HookBeforeDeleteContext<S, N>

Type Parameters

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

Hierarchy

HookContext<S, N>
- HookBeforeDeleteContext
  - HookAfterDeleteContext

Index

Constructors

Properties

_filter realCollection

Accessors

caller collection dataSource filter

Methods

throwError throwForbiddenError throwValidationError

Constructors

constructor

new HookBeforeDeleteContext<S, N>(collection: Collection, caller: Caller, filter: Filter): HookBeforeDeleteContext<S, N>
Type Parameters
- S extends TSchema = TSchema
- N extends string = Extract<keyof S, string>
Parameters
- collection: Collection
- caller: Caller
- filter: Filter
Returns HookBeforeDeleteContext<S, N>
Overrides HookContext.constructor
- Defined in packages/datasource-customizer/dist/decorators/hook/context/delete.d.ts:6

Properties

`Protected` _filter

_filter: Filter

`Protected` realCollection

realCollection: Collection

Accessors

caller

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

collection

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

dataSource

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

filter

get filter(): Readonly<TFilter<S, N>>
Returns Readonly<TFilter<S, N>>
- Defined in packages/datasource-customizer/dist/decorators/hook/context/delete.d.ts:7

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/dist/context/agent-context.d.ts:30

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/dist/context/agent-context.d.ts:23

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/dist/context/agent-context.d.ts:16