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

readme #124

Merged
merged 1 commit into from
Jul 2, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Most of the API takes an `options` object, which has the following defaults:
root: '/',
files: undefined,
cache: undefined,
unset: false,
};
```

Expand Down Expand Up @@ -71,6 +72,11 @@ Most of the API takes an `options` object, which has the following defaults:
fully-qualified file name of the config file and a `root: boolean` property
that describes if the config file had a `root=true` at the top. Any other
properties in the objects should be treated as opaque.</dd>

<dt>unset</dt>
<dd>If true, after combining all properties, remove all properties whose value
remains as "unset". This is typically left for plugin authors to do, and
the conformance tests assume that this value is always false.</dd>
</dl>

### in Node.js:
Expand Down