Skip to content

Commit 524aede

Browse files
committed
docs: use case documentation
1 parent 84c923c commit 524aede

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
@@ -49,6 +49,7 @@ The different use cases currently available in the package are classified below,
4949
- [List Files in a Dataset](#list-files-in-a-dataset)
5050
- [Files write use cases](#files-write-use-cases)
5151
- [File Uploading Use Cases](#file-uploading-use-cases)
52+
- [Delete a File](#delete-a-file)
5253
- [Metadata Blocks](#metadata-blocks)
5354
- [Metadata Blocks read use cases](#metadata-blocks-read-use-cases)
5455
- [Get All Facetable Metadata Fields](#get-all-facetable-metadata-fields)
@@ -1203,6 +1204,26 @@ The following error might arise from the `AddUploadedFileToDataset` use case:
12031204

12041205
- AddUploadedFileToDatasetError: This error indicates that there was an error while adding the uploaded file to the dataset.
12051206

1207+
#### Delete a File
1208+
1209+
Deletes a File.
1210+
1211+
##### Example call:
1212+
1213+
```typescript
1214+
import { deleteFile } from '@iqss/dataverse-client-javascript'
1215+
1216+
/* ... */
1217+
1218+
const fileId = 12345
1219+
1220+
deleteFile.execute(fileId)
1221+
1222+
/* ... */
1223+
```
1224+
1225+
_See [use case](../src/files/domain/useCases/DeleteFile.ts) implementation_.
1226+
12061227
## Metadata Blocks
12071228

12081229
### Metadata Blocks read use cases

0 commit comments

Comments
 (0)