Skip to content

Commit 75c8925

Browse files
committed
change keepRawField to true
1 parent c789d0f commit 75c8925

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs/useCases.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -318,7 +318,7 @@ The optional `datasetVersionId` parameter can correspond to a numeric version id
318318

319319
There is an optional third parameter called `includeDeaccessioned`, which indicates whether to consider deaccessioned versions or not in the dataset search. If not set, the default value is `false`.
320320

321-
There is an optional fourth parameter called `keepRawFields`, which indicates whether or not to keep the metadata fields as they are and avoid the transformation to Markdown. The default value is `false`.
321+
There is an optional fourth parameter called `keepRawFields`, which indicates whether or not to keep the metadata fields as they are and avoid the transformation to Markdown. The default value is `true`.
322322

323323
#### Get Dataset By Private URL Token
324324

@@ -340,7 +340,7 @@ getPrivateUrlDataset.execute(token).then((dataset: Dataset) => {
340340

341341
_See [use case](../src/datasets/domain/useCases/GetPrivateUrlDataset.ts)_ definition.
342342

343-
There is an optional second parameter called `keepRawFields`, which indicates whether or not to keep the metadata fields as they are and avoid the transformation to Markdown. The default value is `false`.
343+
There is an optional second parameter called `keepRawFields`, which indicates whether or not to keep the metadata fields as they are and avoid the transformation to Markdown. The default value is `true`.
344344

345345
#### Get Dataset Citation Text
346346

src/datasets/domain/useCases/GetDataset.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ export class GetDataset implements UseCase<Dataset> {
1616
* @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
1717
* @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
1818
* @param {boolean} [includeDeaccessioned=false] - Indicates whether to consider deaccessioned versions in the dataset search or not. The default value is false
19-
* @param {boolean} [keepRawFields=false] - Indicates whether or not the use case should keep the metadata fields as they are and avoid the transformation to markdown. The default value is false.
19+
* @param {boolean} [keepRawFields=true] - Indicates whether or not the use case should keep the metadata fields as they are and avoid the transformation to markdown. The default value is true.
2020
* @returns {Promise<Dataset>}
2121
*/
2222
async execute(
2323
datasetId: number | string,
2424
datasetVersionId: string | DatasetNotNumberedVersion = DatasetNotNumberedVersion.LATEST,
2525
includeDeaccessioned = false,
26-
keepRawFields = false
26+
keepRawFields = true
2727
): Promise<Dataset> {
2828
return await this.datasetsRepository.getDataset(
2929
datasetId,

src/datasets/domain/useCases/GetPrivateUrlDataset.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ export class GetPrivateUrlDataset implements UseCase<Dataset> {
1313
* Returns a Dataset instance, given an associated Private URL Token.
1414
*
1515
* @param {string} [token] - A Private URL token.
16-
* @param {boolean} [keepRawFields=false] - Indicates whether or not the use case should keep the metadata fields as they are and avoid the transformation to markdown. The default value is false.
16+
* @param {boolean} [keepRawFields=true] - Indicates whether or not the use case should keep the metadata fields as they are and avoid the transformation to markdown. The default value is true.
1717
* @returns {Promise<Dataset>}
1818
*/
19-
async execute(token: string, keepRawFields = false): Promise<Dataset> {
19+
async execute(token: string, keepRawFields = true): Promise<Dataset> {
2020
return await this.datasetsRepository.getPrivateUrlDataset(token, keepRawFields)
2121
}
2222
}

0 commit comments

Comments
 (0)