Class ActionContext<S, N>

Type Parameters

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

Hierarchy

CollectionCustomizationContext<S, N>
- ActionContext
  - ActionContextSingle

Index

Constructors

constructor

new ActionContext<S, N>(collection: Collection, caller: Caller, formValue: RecordData, filter: TFilter<S, N>, used?: Set<string>, changedField?: string): ActionContext<S, N>
Type Parameters
- S extends TSchema = TSchema
- N extends string = Extract<keyof S, string>
Parameters
- collection: Collection
- caller: Caller
- formValue: RecordData
- filter: TFilter<S, N>
- Optional used: Set<string>
- Optional changedField: string
Returns ActionContext<S, N>
Overrides CollectionCustomizationContext.constructor
- Defined in packages/datasource-customizer/dist/decorators/actions/context/base.d.ts:16

Properties

`Readonly` filter

filter: TFilter<S, N>

`Readonly` formValues

formValues: RecordData

hasFieldChanged

hasFieldChanged: ((fieldName: string) => boolean)

Type declaration

- (fieldName: string): boolean
- Parameters
  - fieldName: string
  Returns boolean

`Protected` realCollection

realCollection: Collection

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

changedField

get changedField(): string
Deprecated
use hasFieldChange instead. linked issue.

Todo
remove accessor

Returns string
- Defined in packages/datasource-customizer/dist/decorators/actions/context/base.d.ts:12

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

getCompositeRecordIds

getCompositeRecordIds(): Promise<CompositeId[]>
Get all the records ids (when the collection uses composite keys)

Returns Promise<CompositeId[]>
- Defined in packages/datasource-customizer/dist/decorators/actions/context/base.d.ts:31

getRecordIds

getRecordIds(): Promise<(string | number)[]>
Get all the records ids selected by an action

Returns Promise<(string | number)[]>
- Defined in packages/datasource-customizer/dist/decorators/actions/context/base.d.ts:27

getRecords

getRecords(fields: TFieldName<S, N>[]): Promise<TRow<S, N>[]>
Get all the records selected by an action

Example
```
.getRecords(['id', 'isActive', 'name']);
```
Parameters
- fields: TFieldName<S, N>[]
  
  An array of fields needed in the response
Returns Promise<TRow<S, N>[]>
- Defined in packages/datasource-customizer/dist/decorators/actions/context/base.d.ts:23

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

Class ActionContext<S, N>

Type Parameters

S extends TSchema = TSchema

N extends TCollectionName<S> = TCollectionName<S>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

S extends TSchema = TSchema

N extends string = Extract<keyof S, string>

Parameters

collection: Collection

caller: Caller

formValue: RecordData

filter: TFilter<S, N>

Optional used: Set<string>

Optional changedField: string

Returns ActionContext<S, N>

Properties

Readonly filter

Readonly formValues

hasFieldChanged

Type declaration

Parameters

fieldName: string

Returns boolean

Protected realCollection

Accessors

caller

Returns Readonly<Caller>

changedField

Deprecated

Todo

Returns string

collection

Returns default<S, N>

dataSource

Returns default<S>

Methods

getCompositeRecordIds

Returns Promise<CompositeId[]>

getRecordIds

Returns Promise<(string | number)[]>

getRecords

Example

Parameters

fields: TFieldName<S, N>[]

Returns Promise<TRow<S, N>[]>

throwError

Example

Parameters

message: string

Returns never

throwForbiddenError

Example

Parameters

message: string

Returns never

throwValidationError

Example

Parameters

message: string

Returns never

Settings

Member Visibility

Theme

`Optional` used: Set<string>

`Optional` changedField: string

`Readonly` filter

`Readonly` formValues

`Protected` realCollection