DatasetClient <Data>

Index

Methods

• delete
• downloadItems
• get
• listItems
• pushItems
• update

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 | string[] | Data[]): Promise<void>

• Parameters

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

  Returns Promise<void>

update

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

• Parameters

  • newFields: DatasetClientUpdateOptions

  Returns Promise<Partial<DatasetInfo>>