diff --git a/docs/useCases.md b/docs/useCases.md index 23a30118..f7b5d79a 100644 --- a/docs/useCases.md +++ b/docs/useCases.md @@ -8,6 +8,35 @@ The different use cases currently available in the package are classified below, ## Datasets +### Read operations + +#### [GetAllDatasetPreviews](../src/datasets/domain/useCases/GetAllDatasetPreviews.ts) + +Returns an instance of [DatasetPreviewSubset](../src/datasets/domain/models/DatasetPreviewSubset.ts) that contains information for each dataset that the calling user can access in the installation. + +##### Example call: + +````typescript +import { getAllDatasetPreviews } from '@iqss/dataverse-client-javascript' + +/* ... */ + +const limit = 10; +const offset = 20; + +getAllDatasetPreviews + .execute(limit, offset) + .then((subset: DatasetPreviewSubset) => { + /* ... */ + }); + +/* ... */ +```` + +Note that `limit` and `offset` are optional parameters for pagination. + +#### [GetDataset](../src/datasets/domain/useCases/GetDataset.ts) + TODO ## Files diff --git a/src/datasets/domain/useCases/GetAllDatasetPreviews.ts b/src/datasets/domain/useCases/GetAllDatasetPreviews.ts index e10cd9c3..66266a9f 100644 --- a/src/datasets/domain/useCases/GetAllDatasetPreviews.ts +++ b/src/datasets/domain/useCases/GetAllDatasetPreviews.ts @@ -9,6 +9,13 @@ export class GetAllDatasetPreviews implements UseCase { this.datasetsRepository = datasetsRepository; } + /** + * Returns an instance of DatasetPreviewSubset that contains information for each dataset that the calling user can access in the installation. + * + * @param {number} [limit] - Limit for pagination (optional). + * @param {number} [offset] - Offset for pagination (optional). + * @returns {Promise} + */ async execute(limit?: number, offset?: number): Promise { return await this.datasetsRepository.getAllDatasetPreviews(limit, offset); }