Skip to content

Commit 8d65e43

Browse files
committed
chore: check in updates from npm run build on master
1 parent 2ca0f14 commit 8d65e43

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/NODE_API.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ of lint information intended for human-readable output.
3434
that defines what external modules will be whitelisted and included in the
3535
generated documentation.
3636
* `args.shallow` **[boolean][20]** whether to avoid dependency parsing
37-
even in JavaScript code. (optional, default `false`)
37+
even in JavaScript code. (optional, default `false`)
3838
* `args.inferPrivate` **[string][18]?** a valid regular expression string
3939
to infer whether a code element should be private, given its naming structure.
4040
For instance, you can specify `inferPrivate: '^_'` to automatically treat
@@ -71,14 +71,14 @@ comments, given a root file as a path.
7171
that defines what external modules will be whitelisted and included in the
7272
generated documentation.
7373
* `args.shallow` **[boolean][20]** whether to avoid dependency parsing
74-
even in JavaScript code. (optional, default `false`)
74+
even in JavaScript code. (optional, default `false`)
7575
* `args.order` **[Array][17]<([string][18] | [Object][19])>** optional array that
76-
defines sorting order of documentation (optional, default `[]`)
76+
defines sorting order of documentation&#x20;(optional, default `[]`)
7777
* `args.access` **[Array][17]<[string][18]>** an array of access levels
78-
to output in documentation (optional, default `[]`)
78+
to output in documentation&#x20;(optional, default `[]`)
7979
* `args.hljs` **[Object][19]?** hljs optional args
8080

81-
* `args.hljs.highlightAuto` **[boolean][20]** hljs automatically detect language (optional, default `false`)
81+
* `args.hljs.highlightAuto` **[boolean][20]** hljs automatically detect language&#x20;(optional, default `false`)
8282
* `args.hljs.languages` **[Array][17]?** languages for hljs to choose from
8383
* `args.inferPrivate` **[string][18]?** a valid regular expression string
8484
to infer whether a code element should be private, given its naming structure.
@@ -120,7 +120,7 @@ Formats documentation as HTML.
120120
* `comments` **[Array][17]<[Comment][22]>** parsed comments
121121
* `config` **[Object][19]** Options that can customize the output
122122

123-
* `config.theme` **[string][18]** Name of a module used for an HTML theme. (optional, default `'default_theme'`)
123+
* `config.theme` **[string][18]** Name of a module used for an HTML theme.&#x20;(optional, default `'default_theme'`)
124124

125125
### Examples
126126

@@ -181,7 +181,7 @@ documentation.build(['index.js'])
181181
});
182182
```
183183

184-
Returns **[Promise][21]<[string][18]>**
184+
Returns **[Promise][21]<[string][18]>**&#x20;
185185

186186
[1]: #lint
187187

0 commit comments

Comments
 (0)