Class Table<RowType>

constructor

• new Table<RowType = any>(args: TableParams): Table<RowType>

  Constructs a new Table instance.

  Type Parameters

  • RowType = any

  Parameters

  • args: TableParams

  Returns Table<RowType>

Readonlyabi

Readonlyaccount

Readonlyclient

Readonlydebug

defaultRowLimit

OptionaldefaultScope

Readonlyname

Optional ReadonlyrowType

ReadonlytableABI

all

• all(params?: QueryParams): Promise<RowType[]>

  Returns all the rows from the table.

  Parameters

  • params: QueryParams = {}

  Returns Promise<RowType[]>

  Promise resolving to an array of table rows.

first

• first(maxRows: number, params?: QueryParams): TableCursor<RowType>

  Retrieves all the rows from the table.

  Parameters

  • maxRows: number

    The maximum number of rows to return.

  • params: QueryParams = {}

  Returns TableCursor<RowType>

  Promise resolving to a TableCursor of the table rows.

get

• get(
      value?: string | TableIndexType,
      params?: QueryParams,
  ): Promise<RowType | undefined>

  Retrieves the row from the table that matches the given parameters.

  Parameters

  • Optionalvalue: string | TableIndexType

    The value to match against the index.

  • params: QueryParams = {}

  Returns Promise<RowType | undefined>

  Promise resolving to a single table row.

getFieldToIndex

• getFieldToIndex(): any

  Returns any

query

• query(params?: QueryParams): TableCursor<RowType>

  Retrieves the rows from the table that match the given parameters.

  Parameters

  • params: QueryParams = {}

  Returns TableCursor<RowType>

  Promise resolving to a TableCursor of the filtered table rows.

scopes

• scopes(params?: QueryParams): TableScopeCursor

  Parameters

  • params: QueryParams = {}

  Returns TableScopeCursor

Staticfrom

• from<RowType = any>(tableParams: TableParams): Table<RowType>

  Creates a new Table instance from the given parameters.

  Type Parameters

  • RowType = any

  Parameters

  • tableParams: TableParams

    Parameters for the table. The parameters should include:

    • contract: Name of the contract that this table is associated with.
    • name: Name of the table.
    • client: Client object to interact with the network.
    • rowType: (optional) Custom row type.
    • fieldToIndex: (optional) Mapping of fields to their indices.

  Returns Table<RowType>

  A new Table instance.