Class ObservableDatasetsClient

Observable version of the DatasetsClient. All methods return RxJS Observables instead of Promises.

Example

client.datasets.list().subscribe(datasets => {
  console.log('Available datasets:', datasets)
})

Index

Constructors

Methods

create delete edit list

Constructors

constructor

new ObservableDatasetsClient(
client: ObservableSanityClient,
httpRequest: HttpRequest,
): ObservableDatasetsClient
Parameters
- client: ObservableSanityClient
- httpRequest: HttpRequest
Returns ObservableDatasetsClient
- Defined in src/datasets/DatasetsClient.ts:95

Methods

create

create(
name: string,
options?: { aclMode?: DatasetAclMode },
): Observable<DatasetResponse>
Create a new dataset with the given name
Parameters
- name: string
  Name of the dataset to create
- Optionaloptions: { aclMode?: DatasetAclMode }
  Options for the dataset
Returns Observable<DatasetResponse>
- Defined in src/datasets/DatasetsClient.ts:106

delete

delete(name: string): Observable<{ deleted: true }>
Delete a dataset with the given name
Parameters
- name: string
  Name of the dataset to delete
Returns Observable<{ deleted: true }>
- Defined in src/datasets/DatasetsClient.ts:125

edit

edit(
name: string,
options?: { aclMode?: DatasetAclMode },
): Observable<DatasetResponse>
Edit a dataset with the given name
Parameters
- name: string
  Name of the dataset to edit
- Optionaloptions: { aclMode?: DatasetAclMode }
  New options for the dataset
Returns Observable<DatasetResponse>
- Defined in src/datasets/DatasetsClient.ts:116

list

list(): Observable<DatasetsResponse>
Fetch a list of datasets for the configured project

Returns Observable<DatasetsResponse>
- Defined in src/datasets/DatasetsClient.ts:132