Options
All
  • Public
  • Public/Protected
  • All
Menu

@textile/powergate-client

Index

Modules

Enumerations

Interfaces

Type aliases

Functions

Type aliases

DealRecordsOptions

DealRecordsOptions: { ascending?: undefined | false | true; dataCids?: string[]; fromAddresses?: string[]; includeFinal?: undefined | false | true; includePending?: undefined | false | true }

Controls the behavior of listing deal records.

Type declaration

  • Optional ascending?: undefined | false | true

    Specifies to sort the results in ascending order Default is descending order Records are sorted by timestamp

  • Optional dataCids?: string[]

    Limits the results to deals for the provided data cids

  • Optional fromAddresses?: string[]

    Limits the results deals initiated from the provided wallet addresses.

  • Optional includeFinal?: undefined | false | true

    Specifies whether or not to include final deals in the results Default is false Ignored for listRetrievalDealRecords

  • Optional includePending?: undefined | false | true

    Specifies whether or not to include pending deals in the results Default is false Ignored for listRetrievalDealRecords

GetFolderOptions

GetFolderOptions: { timeout?: undefined | number }

Object that allows you to configure the call to getFolder

Type declaration

  • Optional timeout?: undefined | number

    Timeout for fetching data

WatchLogsOptions

WatchLogsOptions: { includeHistory?: undefined | false | true; jobId?: undefined | string }

Object control the behavior of watchLogs

Type declaration

  • Optional includeHistory?: undefined | false | true

    Control whether or not to include the history of log events

  • Optional jobId?: undefined | string

    Filter log events to only those associated with the provided job id

Functions

Const createPow

  • Creates a new Powergate client

    Parameters

    • Optional config: Partial<Config>

      A config object that changes the behavior of the client

    Returns Pow

    A Powergate client API

Generated using TypeDoc