Class ActionContextSingle<S, N>

Type Parameters

Hierarchy

Constructors

constructor

Properties

filter formValues hasFieldChanged realCollection

Accessors

caller changedField collection dataSource

Methods

getCompositeRecordId getCompositeRecordIds getField getRecord getRecordId getRecordIds getRecords

Constructors

constructor

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>

changedField

  • get changedField(): string

  • Deprecated

    use hasFieldChange instead. linked issue.

    Todo

    remove accessor

    Returns string

collection

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

  • Returns default<S, N>

dataSource

  • get dataSource(): default<S>

  • Returns default<S>

Methods

getCompositeRecordId

  • Returns Promise<CompositeId>

getCompositeRecordIds

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

    Returns Promise<CompositeId[]>

getField

  • Type Parameters

    • T extends string

    Parameters

    • field: T

    Returns Promise<TFieldType<S, N, T>>

getRecord

  • Parameters

    Returns Promise<TRow<S, N>>

getRecordId

  • Returns Promise<string | number>

getRecordIds

  • Get all the records ids selected by an action

    Returns Promise<(string | number)[]>

getRecords

  • 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>[]>

Settings

Member Visibility

Theme