Class ActionContextSingle<S, N>

Readonlyfilter

ReadonlyformValues

hasFieldChanged

caller

• get caller(): Readonly<Caller>

  Returns Readonly<Caller>

changedField

• get changedField(): string

  Returns string

  Deprecated

  use hasFieldChange instead. linked issue.

  Todo

  remove accessor

collection

• get collection(): RelaxedCollection<S, N>

  Returns RelaxedCollection<S, N>

dataSource

• get dataSource(): RelaxedDataSource<S>

  Returns RelaxedDataSource<S>

getCompositeRecordIds

• getCompositeRecordIds(): Promise<CompositeId[]>

  Get all the records ids (when the collection uses composite keys)

  Returns Promise<CompositeId[]>

getRecordIds

• getRecordIds(): Promise<(string | number)[]>

  Get all the records ids selected by an action

  Returns Promise<(string | number)[]>

getRecords

• getRecords(fields: TFieldName<S, N>[]): Promise<TRow<S, N>[]>

  Get all the records selected by an action

  Parameters

  • fields: TFieldName<S, N>[]

    An array of fields needed in the response

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

  Example

  .getRecords(['id', 'isActive', 'name']);
  Copy

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');
  Copy

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');
  Copy

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');
  Copy