Class WriteCustomizationContext<S, N>

Type Parameters

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

Hierarchy (View Summary)

CollectionCustomizationContext<S, N>
- WriteCustomizationContext

Index

Constructors

Properties

action filter? realCollection record

Accessors

caller collection dataSource

Methods

throwError throwForbiddenError throwValidationError

Constructors

constructor

new WriteCustomizationContext<
    S extends TSchema = TSchema,
    N extends string = TCollectionName<S>,
>(
    collection: Collection,
    caller: Caller,
    action: "update" | "create",
    record: TPartialSimpleRow<S, N>,
    filter?: Filter,
): WriteCustomizationContext<S, N>
Type Parameters
- S extends TSchema = TSchema
- N extends string = TCollectionName<S>
Parameters
- collection: Collection
- caller: Caller
- action: "update" | "create"
- record: TPartialSimpleRow<S, N>
- Optionalfilter: Filter
Returns WriteCustomizationContext<S, N>
Overrides CollectionCustomizationContext.constructor
- Defined in 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: TPartialSimpleRow<S, N>

Accessors

caller

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

collection

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

dataSource

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

Methods

throwError

throwError(message: string): never
Stop hooks execution and send error to the UI
Parameters
- message: string
  the error message
Returns never
Example
```
.throwError('My error message');
```
Inherited from CollectionCustomizationContext.throwError
- Defined in datasource-customizer/dist/context/agent-context.d.ts:30

throwForbiddenError

throwForbiddenError(message: string): never
Stop hooks execution and send Forbidden error to the UI
Parameters
- message: string
  the forbidden error message
Returns never
Example
```
.throwForbiddenError('My forbidden error message');
```
Inherited from CollectionCustomizationContext.throwForbiddenError
- Defined in datasource-customizer/dist/context/agent-context.d.ts:23

throwValidationError

throwValidationError(message: string): never
Stop hooks execution and send Validation error to the UI
Parameters
- message: string
  the validation error message
Returns never
Example
```
.throwValidationError('My validation error message');
```
Inherited from CollectionCustomizationContext.throwValidationError
- Defined in datasource-customizer/dist/context/agent-context.d.ts:16