forked from uncch-rdmc/dataverse-client-javascript
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGetFile.ts
22 lines (20 loc) · 1.18 KB
/
GetFile.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import { IFilesRepository } from '../repositories/IFilesRepository'
import { File } from '../models/File'
import { DatasetNotNumberedVersion } from '../../../datasets'
import { UseCase } from '../../../core/domain/useCases/UseCase'
export class GetFile implements UseCase<File> {
constructor(private readonly filesRepository: IFilesRepository) {}
/**
* Returns a File instance, given the search parameters to identify it.
*
* @param {number | string} [fileId] - The File identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
* @param {string | DatasetNotNumberedVersion} [datasetVersionId=DatasetNotNumberedVersion.LATEST] - The dataset version identifier, which can be a version-specific numeric string (for example, 1.0) or a DatasetNotNumberedVersion enum value. If this parameter is not set, the default value is: DatasetNotNumberedVersion.LATEST
* @returns {Promise<File>}
*/
async execute(
fileId: number | string,
datasetVersionId: string | DatasetNotNumberedVersion = DatasetNotNumberedVersion.LATEST
): Promise<File> {
return (await this.filesRepository.getFile(fileId, datasetVersionId, false)) as File
}
}