Class WriteCustomizationContext<S, N>

Type Parameters

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

Hierarchy

CollectionCustomizationContext<S, N>
- WriteCustomizationContext

Index

Constructors

Properties

action filter? realCollection record

Accessors

caller collection dataSource

Methods

throwError throwForbiddenError throwValidationError

Constructors

constructor

new WriteCustomizationContext<S, N>(collection: Collection, caller: Caller, action: "update" | "create", record: RecursivePartial<TSimpleRow<S, N>>, filter?: Filter): WriteCustomizationContext<S, N>
Type Parameters
- S extends TSchema = TSchema
- N extends string = Extract<keyof S, string>
Parameters
- collection: Collection
- caller: Caller
- action: "update" | "create"
- record: RecursivePartial<TSimpleRow<S, N>>
- Optional filter: Filter
Returns WriteCustomizationContext<S, N>
Overrides CollectionCustomizationContext.constructor
- Defined in packages/datasource-customizer/dist/decorators/write/write-replace/context.d.ts:8

Properties

`Readonly` action

action: "update" | "create"

`Optional` `Readonly` filter

filter?: TFilter<S, N>

`Protected` realCollection

realCollection: Collection

`Readonly` record

record: RecursivePartial<TSimpleRow<S, N>>

Accessors

caller

get caller(): Readonly<Caller>
Returns Readonly<Caller>
Inherited from CollectionCustomizationContext.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 CollectionCustomizationContext.collection
- Defined in packages/datasource-customizer/dist/context/collection-context.d.ts:7

dataSource

get dataSource(): default<S>
Returns default<S>
Inherited from CollectionCustomizationContext.dataSource
- Defined in packages/datasource-customizer/dist/context/agent-context.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 CollectionCustomizationContext.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 CollectionCustomizationContext.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 CollectionCustomizationContext.throwValidationError
- Defined in packages/datasource-customizer/dist/context/agent-context.d.ts:16