Skip to content

Commit

Permalink
Minor readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Apr 2, 2019
1 parent b25c837 commit c233707
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ declare namespace Conf {
// [Error: Config schema violation: `foo` should be number]
```
**Note:** The `default` value will be overwritten by `defaults` option if set.
**Note:** The `default` value will be overwritten by the `defaults` option if set.
*/
readonly schema?: {[key: string]: JSONSchema};

Expand Down
6 changes: 3 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,13 +58,13 @@ Type: `Object`

Type: `Object`

Config used if there are no existing config.
Default values for the config items.

**Note:** The values in `defaults` will overwrite the `default` key in the `schema` option.

#### schema

type: `Object`
Type: `Object`

[JSON Schema](https://json-schema.org) to validate your config data.

Expand Down Expand Up @@ -99,7 +99,7 @@ config.set('foo', '1');
// [Error: Config schema violation: `foo` should be number]
```

**Note:** The `default` value will be overwritten by `defaults` option if set.
**Note:** The `default` value will be overwritten by the `defaults` option if set.

#### configName

Expand Down

0 comments on commit c233707

Please sign in to comment.