Skip to main content
Version: 3.0

DatasetClient <Data>

Index

Methods

delete

  • delete(): Promise<void>
  • Returns Promise<void>

downloadItems

  • downloadItems(...args: unknown[]): Promise<Buffer>
  • Parameters

    • rest...args: unknown[]

    Returns Promise<Buffer>

get

  • get(): Promise<undefined | DatasetInfo>
  • Returns Promise<undefined | DatasetInfo>

listItems

  • listItems(options?: DatasetClientListOptions): Promise<PaginatedList<Data>>
  • Parameters

    • optionaloptions: DatasetClientListOptions

    Returns Promise<PaginatedList<Data>>

pushItems

  • pushItems(items: string | Data | Data[] | string[]): Promise<void>
  • Parameters

    • items: string | Data | Data[] | string[]

    Returns Promise<void>

update

  • update(newFields: DatasetClientUpdateOptions): Promise<Partial<DatasetInfo>>
  • Parameters

    • newFields: DatasetClientUpdateOptions

    Returns Promise<Partial<DatasetInfo>>