Class ActionContext<S, N>

constructor

• new ActionContext<
      S extends TSchema = TSchema,
      N extends string = TCollectionName<S>,
  >(
      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 = TCollectionName<S>

  Parameters

  • collection: Collection
  • caller: Caller
  • formValue: RecordData
  • filter: TFilter<S, N>
  • Optionalused: Set<string>
  • OptionalchangedField: string

  Returns ActionContext<S, N>

Readonlyfilter

ReadonlyformValues

hasFieldChanged

changedField

• get changedField(): string

  Returns string

  Deprecated

  use hasFieldChange instead. linked issue.

  Todo

  remove accessor

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