@@ -19,21 +19,20 @@ const patternlab = require('@pattern-lab/core')(config);
19
19
Build thoughtful, pattern-driven user interfaces using atomic design principles.
20
20
Many of these functions are exposed to users within [ Editions] ( https://github.com/pattern-lab/patternlab-node#editions ) , but [ direct consumption] ( https://github.com/pattern-lab/patternlab-node#direct-consumption ) is also encouraged.
21
21
22
- ** Kind** : global namespace
22
+ ** Kind** : global namespace
23
23
** See**
24
24
25
25
- [ patternlab.io] ( patternlab.io ) for more documentation.
26
26
- [ https://github.com/pattern-lab/patternlab-node ] ( https://github.com/pattern-lab/patternlab-node ) for code, issues, and releases
27
27
28
- ** License** : MIT
28
+ ** License** : MIT
29
29
30
30
* [ ` patternlab ` ] ( #patternlab ) : <code >object</code >
31
31
* _ instance_
32
32
* [ ` .version ` ] ( #patternlab+version ) ⇒ <code >string</code >
33
33
* [ ` .build ` ] ( #patternlab+build ) ⇒ <code >Promise</code >
34
34
* [ ` .getDefaultConfig ` ] ( #patternlab+getDefaultConfig ) ⇒ <code >object</code >
35
35
* [ ` .getSupportedTemplateExtensions ` ] ( #patternlab+getSupportedTemplateExtensions ) ⇒ <code >Array.< ; string> ; </code >
36
- * [ ` .installplugin ` ] ( #patternlab+installplugin ) ⇒ <code >void</code >
37
36
* [ ` .liststarterkits ` ] ( #patternlab+liststarterkits ) ⇒ <code >Promise</code >
38
37
* [ ` .loadstarterkit ` ] ( #patternlab+loadstarterkit ) ⇒ <code >void</code >
39
38
* [ ` .patternsonly ` ] ( #patternlab+patternsonly ) ⇒ <code >Promise</code >
@@ -51,17 +50,17 @@ Many of these functions are exposed to users within [Editions](https://github.co
51
50
### ` patternlab.version ` ⇒ <code >string</code >
52
51
Returns current version
53
52
54
- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
55
- ** Returns** : <code >string</code > - current patternlab-node version as defined in ` package.json ` , as string
53
+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
54
+ ** Returns** : <code >string</code > - current patternlab-node version as defined in ` package.json ` , as string
56
55
<a name =" patternlab+build " ></a >
57
56
58
57
### ` patternlab.build ` ⇒ <code >Promise</code >
59
58
Builds patterns, copies assets, and constructs user interface
60
59
61
- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
62
- ** Returns** : <code >Promise</code > - a promise fulfilled when build is complete
63
- ** Emits** : <code >event: PATTERNLAB_BUILD_START </code >, <code >event: PATTERNLAB_BUILD_END </code >
64
- ** See** : [ all events] ( ./events.md )
60
+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
61
+ ** Returns** : <code >Promise</code > - a promise fulfilled when build is complete
62
+ ** Emits** : <code >event: PATTERNLAB_BUILD_START </code >, <code >event: PATTERNLAB_BUILD_END </code >
63
+ ** See** : [ all events] ( ./events.md )
65
64
66
65
| Param | Type | Default | Description |
67
66
| --- | --- | --- | --- |
@@ -75,39 +74,29 @@ Builds patterns, copies assets, and constructs user interface
75
74
### ` patternlab.getDefaultConfig ` ⇒ <code >object</code >
76
75
Returns the standardized default config used to run Pattern Lab. This method can be called statically or after instantiation.
77
76
78
- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
79
- ** Returns** : <code >object</code > - Returns the object representation of the ` patternlab-config.json `
77
+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
78
+ ** Returns** : <code >object</code > - Returns the object representation of the ` patternlab-config.json `
80
79
<a name =" patternlab+getSupportedTemplateExtensions " ></a >
81
80
82
81
### ` patternlab.getSupportedTemplateExtensions ` ⇒ <code >Array.< ; string> ; </code >
83
82
Returns all file extensions supported by installed PatternEngines
84
83
85
- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
86
- ** Returns** : <code >Array.< ; string> ; </code > - all supported file extensions
87
- <a name =" patternlab+installplugin " ></a >
88
-
89
- ### ` patternlab.installplugin ` ⇒ <code >void</code >
90
- Installs plugin already available via ` node_modules/ `
91
-
92
- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
93
-
94
- | Param | Type | Description |
95
- | --- | --- | --- |
96
- | pluginName | <code >string</code > | name of plugin |
84
+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
85
+ ** Returns** : <code >Array.< ; string> ; </code > - all supported file extensions
97
86
98
87
<a name =" patternlab+liststarterkits " ></a >
99
88
100
89
### ` patternlab.liststarterkits ` ⇒ <code >Promise</code >
101
90
Fetches starterkit repositories from pattern-lab github org that contain 'starterkit' in their name
102
91
103
- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
104
- ** Returns** : <code >Promise</code > - Returns an Array<{name,url}> for the starterkit repos
92
+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
93
+ ** Returns** : <code >Promise</code > - Returns an Array<{name,url}> for the starterkit repos
105
94
<a name =" patternlab+loadstarterkit " ></a >
106
95
107
96
### ` patternlab.loadstarterkit ` ⇒ <code >void</code >
108
97
Loads starterkit already available via ` node_modules/ `
109
98
110
- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
99
+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
111
100
112
101
| Param | Type | Description |
113
102
| --- | --- | --- |
@@ -119,8 +108,8 @@ Loads starterkit already available via `node_modules/`
119
108
### ` patternlab.patternsonly ` ⇒ <code >Promise</code >
120
109
Builds patterns only, leaving existing user interface files intact
121
110
122
- ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
123
- ** Returns** : <code >Promise</code > - a promise fulfilled when build is complete
111
+ ** Kind** : instance property of [ <code >patternlab</code >] ( #patternlab )
112
+ ** Returns** : <code >Promise</code > - a promise fulfilled when build is complete
124
113
125
114
| Param | Type | Default | Description |
126
115
| --- | --- | --- | --- |
@@ -133,21 +122,21 @@ Builds patterns only, leaving existing user interface files intact
133
122
### ` patternlab.getDefaultConfig ` ⇒ <code >object</code >
134
123
Static method that returns the standardized default config used to run Pattern Lab. This method can be called statically or after instantiation.
135
124
136
- ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
137
- ** Returns** : <code >object</code > - Returns the object representation of the ` patternlab-config.json `
125
+ ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
126
+ ** Returns** : <code >object</code > - Returns the object representation of the ` patternlab-config.json `
138
127
<a name =" patternlab.getVersion " ></a >
139
128
140
129
### ` patternlab.getVersion ` ⇒ <code >string</code >
141
130
Static method that returns current version
142
131
143
- ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
144
- ** Returns** : <code >string</code > - current @pattern-lab/core version as defined in ` package.json `
132
+ ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
133
+ ** Returns** : <code >string</code > - current @pattern-lab/core version as defined in ` package.json `
145
134
<a name =" patternlab.server " ></a >
146
135
147
136
### ` patternlab.server ` : <code >object</code >
148
137
Server module
149
138
150
- ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
139
+ ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
151
140
152
141
* [ ` .server ` ] ( #patternlab.server ) : <code >object</code >
153
142
* [ ` .serve(options) ` ] ( #patternlab.server.serve ) ⇒ <code >Promise</code >
@@ -159,8 +148,8 @@ Server module
159
148
#### ` server.serve(options) ` ⇒ <code >Promise</code >
160
149
Build patterns, copies assets, and constructs user interface. Watches configured ` source/ ` directories, and serves all output locally
161
150
162
- ** Kind** : static method of [ <code >server</code >] ( #patternlab.server )
163
- ** Returns** : <code >Promise</code > - a promise fulfilled when build is complete
151
+ ** Kind** : static method of [ <code >server</code >] ( #patternlab.server )
152
+ ** Returns** : <code >Promise</code > - a promise fulfilled when build is complete
164
153
165
154
| Param | Type | Default | Description |
166
155
| --- | --- | --- | --- |
@@ -174,19 +163,19 @@ Build patterns, copies assets, and constructs user interface. Watches configured
174
163
#### ` server.reload() ` ⇒ <code >Promise</code >
175
164
Reloads any active live-server instances
176
165
177
- ** Kind** : static method of [ <code >server</code >] ( #patternlab.server )
178
- ** Returns** : <code >Promise</code > - a promise fulfilled when operation is complete
166
+ ** Kind** : static method of [ <code >server</code >] ( #patternlab.server )
167
+ ** Returns** : <code >Promise</code > - a promise fulfilled when operation is complete
179
168
<a name =" patternlab.server.refreshCSS " ></a >
180
169
181
170
#### ` server.refreshCSS() ` ⇒ <code >Promise</code >
182
171
Reloads CSS on any active live-server instances
183
172
184
- ** Kind** : static method of [ <code >server</code >] ( #patternlab.server )
185
- ** Returns** : <code >Promise</code > - a promise fulfilled when operation is complete
173
+ ** Kind** : static method of [ <code >server</code >] ( #patternlab.server )
174
+ ** Returns** : <code >Promise</code > - a promise fulfilled when operation is complete
186
175
<a name =" patternlab.events " ></a >
187
176
188
177
### ` patternlab.events ` : <code >EventEmitter</code >
189
- ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
178
+ ** Kind** : static property of [ <code >patternlab</code >] ( #patternlab )
190
179
** See**
191
180
192
181
- [ EventEmitter] ( https://nodejs.org/api/events.html#events_class_eventemitter )
0 commit comments