Skip to content

Commit

Permalink
Minor readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed Nov 20, 2020
1 parent be69402 commit 556c95e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 6 deletions.
4 changes: 1 addition & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,9 +266,7 @@ console.log(config.get('foo.bar.foobar'));
type: `boolean`\
Default: `false`

Watch for any changes in the config file and call the callback for `onDidChange` if set. This is useful if there are multiple processes changing the same config file.

**Currently this option doesn't work on Node.js 8 on macOS.**
Watch for any changes in the config file and call the callback for `onDidChange` or `onDidAnyChange` if set. This is useful if there are multiple processes changing the same config file.

### Instance

Expand Down
4 changes: 1 addition & 3 deletions source/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,7 @@ export interface Options<T> {
readonly accessPropertiesByDotNotation?: boolean;

/**
Watch for any changes in the config file and call the callback for `onDidChange` if set. This is useful if there are multiple processes changing the same config file.
__Currently this option doesn't work on Node.js 8 on macOS.__
Watch for any changes in the config file and call the callback for `onDidChange` or `onDidAnyChange` if set. This is useful if there are multiple processes changing the same config file.
@default false
*/
Expand Down

0 comments on commit 556c95e

Please sign in to comment.