Skip to content

Commit 9f3117b

Browse files
committed
Added: docs for #167
1 parent 498ad5f commit 9f3117b

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/useCases.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ The different use cases currently available in the package are classified below,
4343
- [File Uploading Use Cases](#file-uploading-use-cases)
4444
- [Metadata Blocks](#metadata-blocks)
4545
- [Metadata Blocks read use cases](#metadata-blocks-read-use-cases)
46+
- [Get All Facetable Dataset Fields](#get-all-facetable-dataset-fields)
4647
- [Get Metadata Block By Name](#get-metadata-block-by-name)
4748
- [Get Collection Metadata Blocks](#get-collection-metadata-blocks)
4849
- [Users](#Users)
@@ -964,6 +965,26 @@ The following error might arise from the `AddUploadedFileToDataset` use case:
964965

965966
### Metadata Blocks read use cases
966967

968+
#### Get All Facetable Dataset Fields
969+
970+
Returns a [MetadataFieldInfo](../src/metadataBlocks/domain/models/MetadataBlock.ts) array containing all facetable dataset fields defined in the installation.
971+
972+
##### Example call:
973+
974+
```typescript
975+
import { getAllFacetableMetadataFields } from '@iqss/dataverse-client-javascript'
976+
977+
/* ... */
978+
979+
getAllFacetableMetadataFields.execute().then((metadataFieldInfos: MetadataFieldInfo[]) => {
980+
/* ... */
981+
})
982+
983+
/* ... */
984+
```
985+
986+
_See [use case](../src/metadataBlocks/domain/useCases/GetAllFacetableDatasetFields.ts) implementation_.
987+
967988
#### Get Metadata Block By Name
968989

969990
Returns a [MetadataBlock](../src/metadataBlocks/domain/models/MetadataBlock.ts) instance, given its name.

0 commit comments

Comments
 (0)