Skip to content

Commit

Permalink
docs: add description of defaultValue for File and Table parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
csm-thu committed Feb 25, 2022
1 parent 6297f13 commit 7e01013
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/scenarioParametersConfiguration.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,7 @@ file](../src/config/ScenarioParameters.js):
file browser
- `connectorId`: the connector id to use in the dataset object that will be created with the Cosmo Tech API
- `description`: the description to use in the dataset object that will be created with the Cosmo Tech API
- `defaultValue`: if you want to have a default file instead of no file uploaded by default, you can provide the id of an existing dataset in the `defaultValue` property

Example:

Expand Down Expand Up @@ -254,6 +255,7 @@ are slightly different:
- `columns`: an array describing the expected columns of the table (see section below "Columns definition")
- `dateFormat`: a string describing the expected format of dates in the table based on
[date-fns format patterns](https://date-fns.org/v2.25.0/docs/parse) (default: 'yyyy-MM-dd')
- `defaultValue`: if you want to have a default table instead of the default empty table, you can provide the id of an existing dataset in the `defaultValue` property (this dataset must be a CSV file, without header, values separated by commas)

#### Columns definition

Expand Down

0 comments on commit 7e01013

Please sign in to comment.