Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve options object docs. #14

Open
brannonh opened this issue Feb 25, 2021 · 0 comments
Open

Improve options object docs. #14

brannonh opened this issue Feb 25, 2021 · 0 comments
Labels
chore Improvements that don't add functionality or fix anything documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@brannonh
Copy link
Owner

value-sculptor/README.md

Lines 141 to 158 in 4d4315d

#### options
The `options` argument is a `SculptOptions` object (or array of `SculptOptions` objects) that may contain the following key-value pairs. If `options` is an array, a separate value will be generated for each object in the array.
| Key | Type | GeneratorType | Required | Default | Description |
| --- | --- | --- | :--: | --- | --- |
| charSet | `string` | `String` | | | A string of possible characters |
| length | `integer` | `String` | :heavy_check_mark: | | The length of the string |
| max | `integer` | `Number` | :heavy_check_mark: | | The maximum value to generate (inclusive) |
| min | `integer` | `Number` | | `0` | The minimum value to generate (inclusive) |
| padCharLeft | `string` | `String` | | space | The character to use for padding on the left, omit for spaces |
| padCharRight | `string` | `String` | | space | The character to use for padding on the right, omit for spaces |
| padLengthLeft | `integer` | `String` | | | The length of the string after padding on the left, **required** if `padType` is `PadType.Both` or `PadType.Left` |
| padLengthRight | `integer` | `String` | | | The length of the string after padding on the right, **required** if `padType` is `PadType.Both` or `PadType.Right` |
| padPriority | `PadType` | `String` | | | The side of the string to pad first, **required** if `padType` is `PadType.Both` |
| padType | `PadType` | `String` | | | The type of padding to use (see [PadType](#PadType)), omit for no padding |
| possibles | `string[]` | `Select` | :heavy_check_mark: | | An array of possible strings from which to choose one |
| type | `GeneratorType` | | :heavy_check_mark: | | The type of value to create (see [GeneratorType](#GeneratorType)) |

This table should be split up into the different generator types.

@brannonh brannonh added documentation Improvements or additions to documentation good first issue Good for newcomers chore Improvements that don't add functionality or fix anything labels Feb 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Improvements that don't add functionality or fix anything documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant