DatasetClient <Data>

Index

Methods

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

Methods

delete

• delete(): Promise<void>

• Returns Promise<void>

downloadItems

• downloadItems(...args): Promise<Buffer<ArrayBufferLike>>

• Parameters

  • rest...args: unknown[]

  Returns Promise<Buffer<ArrayBufferLike>>

get

• get(): Promise<undefined | DatasetInfo>

• Returns Promise<undefined | DatasetInfo>

optionallistEntries

• listEntries(options): AsyncIterable<[number, Data], any, any> & Promise<PaginatedList<[number, Data]>>

• Parameters

  • optionaloptions: DatasetClientListOptions

  Returns AsyncIterable<[number, Data], any, any> & Promise<PaginatedList<[number, Data]>>

listItems

• listItems(options): AsyncIterable<Data, any, any> & Promise<PaginatedList<Data>>

• Parameters

  • optionaloptions: DatasetClientListOptions

  Returns AsyncIterable<Data, any, any> & Promise<PaginatedList<Data>>

pushItems

• pushItems(items): Promise<void>

• Parameters

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

  Returns Promise<void>

update

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

• Parameters

  • newFields: DatasetClientUpdateOptions

  Returns Promise<Partial<DatasetInfo>>