Skip to content

Commit 7c43e24

Browse files
committed
replace .renderSync() with asynchronous .render()
Factor out stream-read-all module add CommonJS build.. add example
1 parent 4435e02 commit 7c43e24

File tree

8 files changed

+4198
-70
lines changed

8 files changed

+4198
-70
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ A programmatic interface for [jsdoc3](https://github.com/jsdoc3/jsdoc) with a fe
4646
* [jsdoc-api](#module_jsdoc-api)
4747
* _static_
4848
* [.explain([options])](#module_jsdoc-api.explain) ⇒ <code>Promise</code>
49-
* [.renderSync([options])](#module_jsdoc-api.renderSync)
49+
* [.render([options])](#module_jsdoc-api.render)
5050
* _inner_
5151
* [~JsdocOptions](#module_jsdoc-api..JsdocOptions)
5252
* [.files](#module_jsdoc-api..JsdocOptions+files) : <code>string</code> \| <code>Array.&lt;string&gt;</code>
@@ -78,9 +78,9 @@ Returns a promise for the jsdoc explain output.
7878
| --- | --- |
7979
| [options] | [<code>JsdocOptions</code>](#module_jsdoc-api..JsdocOptions) |
8080

81-
<a name="module_jsdoc-api.renderSync"></a>
81+
<a name="module_jsdoc-api.render"></a>
8282

83-
### jsdoc.renderSync([options])
83+
### jsdoc.render([options])
8484
Render jsdoc documentation.
8585

8686
**Kind**: static method of [<code>jsdoc-api</code>](#module_jsdoc-api)
@@ -92,7 +92,7 @@ Render jsdoc documentation.
9292

9393
**Example**
9494
```js
95-
jsdoc.renderSync({ files: 'lib/*', destination: 'api-docs' })
95+
await jsdoc.render({ files: 'lib/*', destination: 'api-docs' })
9696
```
9797
<a name="module_jsdoc-api..JsdocOptions"></a>
9898

0 commit comments

Comments
 (0)