Skip to content

Commit 830c568

Browse files
committed
fix(docs): regenerate API documentation
1 parent 8bf186b commit 830c568

File tree

3 files changed

+27
-27
lines changed

3 files changed

+27
-27
lines changed

packages/core/docs/README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@ Builds patterns, copies assets, and constructs user interface
6363
**Emits**: <code>event:PATTERNLAB_BUILD_START</code>, <code>event:PATTERNLAB_BUILD_END</code>
6464
**See**: [all events](./events.md)
6565

66-
| Param | Type | Description |
67-
| --- | --- | --- |
68-
| options | <code>object</code> | an object used to control build behavior |
69-
| options.cleanPublic | <code>bool</code> | whether or not to delete the configured output location (usually `public/`) before build |
70-
| options.data | <code>object</code> | additional data to be merged with global data prior to build |
71-
| options.watch | <code>bool</code> | whether or not Pattern Lab should watch configured `source/` directories for changes to rebuild |
66+
| Param | Type | Default | Description |
67+
| --- | --- | --- | --- |
68+
| options | <code>object</code> | | an object used to control build behavior |
69+
| [options.cleanPublic] | <code>bool</code> | <code>true</code> | whether or not to delete the configured output location (usually `public/`) before build |
70+
| [options.data] | <code>object</code> | <code>{}</code> | additional data to be merged with global data prior to build |
71+
| [options.watch] | <code>bool</code> | <code>true</code> | whether or not Pattern Lab should watch configured `source/` directories for changes to rebuild |
7272

7373
<a name="patternlab+getDefaultConfig"></a>
7474

@@ -122,11 +122,11 @@ Builds patterns only, leaving existing user interface files intact
122122
**Kind**: instance property of [<code>patternlab</code>](#patternlab)
123123
**Returns**: <code>Promise</code> - a promise fulfilled when build is complete
124124

125-
| Param | Type | Description |
126-
| --- | --- | --- |
127-
| options | <code>object</code> | an object used to control build behavior |
128-
| options.cleanPublic | <code>bool</code> | whether or not to delete the configured output location (usually `public/`) before build |
129-
| options.data | <code>object</code> | additional data to be merged with global data prior to build |
125+
| Param | Type | Default | Description |
126+
| --- | --- | --- | --- |
127+
| [options.cleanPublic] | <code>bool</code> | <code>true</code> | whether or not to delete the configured output location (usually `public/`) before build |
128+
| [options.data] | <code>object</code> | <code>{}</code> | additional data to be merged with global data prior to build |
129+
| [options.watch] | <code>bool</code> | <code>true</code> | whether or not Pattern Lab should watch configured `source/` directories for changes to rebuild |
130130

131131
<a name="patternlab.getDefaultConfig"></a>
132132

@@ -162,12 +162,12 @@ Build patterns, copies assets, and constructs user interface. Watches configured
162162
**Kind**: static method of [<code>server</code>](#patternlab.server)
163163
**Returns**: <code>Promise</code> - a promise fulfilled when build is complete
164164

165-
| Param | Type | Description |
166-
| --- | --- | --- |
167-
| options | <code>object</code> | an object used to control build behavior |
168-
| options.cleanPublic | <code>bool</code> | whether or not to delete the configured output location (usually `public/`) before build |
169-
| options.data | <code>object</code> | additional data to be merged with global data prior to build |
170-
| options.watch | <code>bool</code> | **ALWAYS OVERRIDDEN to `true`** whether or not Pattern Lab should watch configured `source/` directories for changes to rebuild |
165+
| Param | Type | Default | Description |
166+
| --- | --- | --- | --- |
167+
| options | <code>object</code> | | an object used to control build behavior |
168+
| [options.cleanPublic] | <code>bool</code> | <code>true</code> | whether or not to delete the configured output location (usually `public/`) before build |
169+
| [options.data] | <code>object</code> | <code>{}</code> | additional data to be merged with global data prior to build |
170+
| [options.watch] | <code>bool</code> | <code>true</code> | whether or not Pattern Lab should watch configured `source/` directories for changes to rebuild |
171171

172172
<a name="patternlab.server.reload"></a>
173173

packages/core/docs/events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Pattern Lab emits numerous events during the [build](../docs/) process. Some uses of events:
66

77
* Core uses `patternlab-pattern-change` events when watching for changes in order to trigger another build
8-
* Plugins such as [plugin-node-tab](https://github.com/pattern-lab/plugin-node-tab) can use an event like `patternlab-pattern-write-end` to define additional code tabs to the pattern viewer / modal
8+
* Plugins such as [plugin-tab](https://github.com/pattern-lab/patternlab-node/tree/master/packages/plugin-tab) can use an event like `patternlab-pattern-write-end` to define additional code tabs to the pattern viewer / modal
99

1010
Learn more about [Creating Plugins](https://github.com/pattern-lab/patternlab-node/wiki/Creating-Plugins).
1111

packages/core/src/index.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ const patternlab_module = function(config) {
8484
* @name build
8585
* @instance
8686
* @param {object} options an object used to control build behavior
87-
* @param {bool} options.cleanPublic whether or not to delete the configured output location (usually `public/`) before build
88-
* @param {object} options.data additional data to be merged with global data prior to build
89-
* @param {bool} options.watch whether or not Pattern Lab should watch configured `source/` directories for changes to rebuild
87+
* @param {bool} [options.cleanPublic=true] whether or not to delete the configured output location (usually `public/`) before build
88+
* @param {object} [options.data={}] additional data to be merged with global data prior to build
89+
* @param {bool} [options.watch=true] whether or not Pattern Lab should watch configured `source/` directories for changes to rebuild
9090
* @emits PATTERNLAB_BUILD_START
9191
* @emits PATTERNLAB_BUILD_END
9292
* @see {@link ./events.md|all events}
@@ -231,9 +231,9 @@ const patternlab_module = function(config) {
231231
* @memberof patternlab
232232
* @name patternsonly
233233
* @instance
234-
* @param {object} options an object used to control build behavior
235-
* @param {bool} options.cleanPublic whether or not to delete the configured output location (usually `public/`) before build
236-
* @param {object} options.data additional data to be merged with global data prior to build
234+
* @param {bool} [options.cleanPublic=true] whether or not to delete the configured output location (usually `public/`) before build
235+
* @param {object} [options.data={}] additional data to be merged with global data prior to build
236+
* @param {bool} [options.watch=true] whether or not Pattern Lab should watch configured `source/` directories for changes to rebuild
237237
* @returns {Promise} a promise fulfilled when build is complete
238238
*/
239239
patternsonly: function(options) {
@@ -264,9 +264,9 @@ const patternlab_module = function(config) {
264264
* @method serve
265265
* @memberof patternlab.server
266266
* @param {object} options an object used to control build behavior
267-
* @param {bool} options.cleanPublic whether or not to delete the configured output location (usually `public/`) before build
268-
* @param {object} options.data additional data to be merged with global data prior to build
269-
* @param {bool} [true] options.watch whether or not Pattern Lab should watch configured `source/` directories for changes to rebuild
267+
* @param {bool} [options.cleanPublic=true] whether or not to delete the configured output location (usually `public/`) before build
268+
* @param {object} [options.data={}] additional data to be merged with global data prior to build
269+
* @param {bool} [options.watch=true] whether or not Pattern Lab should watch configured `source/` directories for changes to rebuild
270270
* @returns {Promise} a promise fulfilled when build is complete
271271
*/
272272
serve: options => {

0 commit comments

Comments
 (0)