Skip to content

Commit b4f14f3

Browse files
committed
docs: add use case to docs
1 parent 0ff4767 commit b4f14f3

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/useCases.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ The different use cases currently available in the package are classified below,
4141
- [Get Dataset Templates](#get-dataset-templates)
4242
- [Get Dataset Available Dataset Types](#get-dataset-available-dataset-types)
4343
- [Get Dataset Available Dataset Type](#get-dataset-available-dataset-type)
44+
- [Get Dataset Storage Driver](#get-dataset-storage-driver)
4445
- [Datasets write use cases](#datasets-write-use-cases)
4546
- [Create a Dataset](#create-a-dataset)
4647
- [Update a Dataset](#update-a-dataset)
@@ -856,6 +857,28 @@ getDatasetAvailableDatasetType.execute().then((datasetType: DatasetType) => {
856857

857858
_See [use case](../src/datasets/domain/useCases/GetDatasetAvailableDatasetType.ts) implementation_.
858859

860+
#### Get Dataset Storage Driver
861+
862+
Returns the current [StorageDriver](../src/core/domain/models/StorageDriver.ts) used for a dataset.
863+
864+
##### Example call:
865+
866+
```typescript
867+
import { getDatasetStorageDriver } from '@iqss/dataverse-client-javascript'
868+
869+
/* ... */
870+
871+
const datasetId = 'doi:10.77777/FK2/AAAAAA'
872+
873+
getDatasetStorageDriver.execute(datasetId).then((storageDriver: StorageDriver) => {
874+
/* ... */
875+
})
876+
877+
/* ... */
878+
```
879+
880+
_See [use case](../src/datasets/domain/useCases/GetDatasetStorageDriver.ts) implementation_.
881+
859882
### Datasets Write Use Cases
860883

861884
#### Create a Dataset

0 commit comments

Comments
 (0)