diff --git a/guide/build-guide.sh b/guide/build-guide.sh index def52f38..dc87ea7b 100755 --- a/guide/build-guide.sh +++ b/guide/build-guide.sh @@ -33,7 +33,7 @@ wasm-pack build --release -t bundler -d $WASM_OUTPUT_REACT_DIR --scope fs # build the results viewer (which includes putting the output into the book's src) cd $RESULTS_VIEWER_REACT_DIR -npm install +npm ci npm run build # build the book diff --git a/guide/serve-guide.sh b/guide/serve-guide.sh index aaf1a43c..c3339107 100755 --- a/guide/serve-guide.sh +++ b/guide/serve-guide.sh @@ -33,7 +33,7 @@ wasm-pack build --release -t bundler -d $WASM_OUTPUT_REACT_DIR --scope fs # build the results viewer (which includes putting the output into the book's src) cd $RESULTS_VIEWER_REACT_DIR -npm install +npm ci npm run build # build the book diff --git a/guide/src/config/providers-section.md b/guide/src/config/providers-section.md index 6adec59c..f810d8a6 100644 --- a/guide/src/config/providers-section.md +++ b/guide/src/config/providers-section.md @@ -15,7 +15,7 @@ Example: ```yaml providers: - session: - - endpoint: + - response: auto_return: force - username: - file: @@ -166,6 +166,16 @@ The `file` *provider_type* reads data from a file. Every line in the file is rea When enabled there is no sense of "fairness" in the randomization. Any record in the file could be used more than once before other records are used. +**Example**, the following: +```yaml +providers: + - username: + - file: + path: "usernames.csv" + repeat: true + random: true +``` + ## response Unlike other *provider_type*s `response` does not automatically receive data from a source. Instead a `response` provider is available to be a "sink" for data originating from an HTTP response. The `response` provider has the following parameters. @@ -173,6 +183,15 @@ Unlike other *provider_type*s `response` does not automatically receive data fro - **`buffer`** *Optional* - Specifies the soft limit for a provider's buffer. This can be indicated with an integer greater than zero or the value `auto`. The value `auto` indicates that if the provider's buffer becomes empty it will automatically increase the buffer size to help prevent the provider from becoming empty again in the future. Defaults to `auto`. - **`unique`** - *Optional* A boolean value which when `true` makes the provider a "unique" provider--meaning each item within the provider will be a unique JSON value without duplicates. Defaults to `false`. +**Example**, the following: +```yaml +providers: + - session: + - response: + buffer: 1000 + auto_return: if_not_full +``` + ## list The `list` *provider_type* creates a means of specifying an array of static values to be used as a provider. A `list` provider can be specified in two forms, either implicitly or explicitly. The explicit form has the following parameters: