@podium/client 5.0.2 → 5.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/README.md +13 -13
- package/client.d.ts +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
## [5.0.3](https://github.com/podium-lib/client/compare/v5.0.2...v5.0.3) (2023-12-06)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* export default now that package is esm ([a1739e8](https://github.com/podium-lib/client/commit/a1739e8bcdde25e3cbb396534705e02411beb7cf))
|
|
7
|
+
|
|
1
8
|
## [5.0.2](https://github.com/podium-lib/client/compare/v5.0.1...v5.0.2) (2023-12-01)
|
|
2
9
|
|
|
3
10
|
|
package/README.md
CHANGED
|
@@ -21,8 +21,8 @@ $ npm install @podium/client
|
|
|
21
21
|
Connect to a Podium component server and stream the HTML content:
|
|
22
22
|
|
|
23
23
|
```js
|
|
24
|
-
|
|
25
|
-
|
|
24
|
+
import { HttpIncoming } from '@podium/utils';
|
|
25
|
+
import Client from '@podium/client';
|
|
26
26
|
const client = new Client();
|
|
27
27
|
|
|
28
28
|
const component = client.register({
|
|
@@ -47,8 +47,8 @@ stream.pipe(process.stdout);
|
|
|
47
47
|
Connect to a podium component server and fetch the HTML content:
|
|
48
48
|
|
|
49
49
|
```js
|
|
50
|
-
|
|
51
|
-
|
|
50
|
+
import { HttpIncoming } from '@podium/utils';
|
|
51
|
+
import Client from '@podium/client';
|
|
52
52
|
const client = new Client();
|
|
53
53
|
|
|
54
54
|
const component = client.register({
|
|
@@ -74,7 +74,7 @@ component
|
|
|
74
74
|
Create a new Client instance.
|
|
75
75
|
|
|
76
76
|
```js
|
|
77
|
-
|
|
77
|
+
import Client from '@podium/client';
|
|
78
78
|
const client = new Client(options);
|
|
79
79
|
```
|
|
80
80
|
|
|
@@ -82,7 +82,7 @@ The client instance is iterable and holds a reference to each registered
|
|
|
82
82
|
resource.
|
|
83
83
|
|
|
84
84
|
```js
|
|
85
|
-
|
|
85
|
+
import Client from '@podium/client';
|
|
86
86
|
const client = new Client();
|
|
87
87
|
|
|
88
88
|
client.register({ uri: 'http://foo.site.com/manifest.json', name: 'fooBar' });
|
|
@@ -117,7 +117,7 @@ Registers a component.
|
|
|
117
117
|
Example:
|
|
118
118
|
|
|
119
119
|
```js
|
|
120
|
-
|
|
120
|
+
import Client from '@podium/client';
|
|
121
121
|
const client = new Client();
|
|
122
122
|
|
|
123
123
|
const component = client.register({
|
|
@@ -134,7 +134,7 @@ It is stored with the `name` as its property name.
|
|
|
134
134
|
Example:
|
|
135
135
|
|
|
136
136
|
```js
|
|
137
|
-
|
|
137
|
+
import Client from '@podium/client';
|
|
138
138
|
const client = new Client();
|
|
139
139
|
|
|
140
140
|
client.register({ uri: 'http://foo.site.com/manifest.json', name: 'fooBar' });
|
|
@@ -159,7 +159,7 @@ Retrieve list of all JavaScript references from all registered and fetched
|
|
|
159
159
|
components.
|
|
160
160
|
|
|
161
161
|
```js
|
|
162
|
-
|
|
162
|
+
import Client from '@podium/client';
|
|
163
163
|
const client = new Client();
|
|
164
164
|
|
|
165
165
|
const foo = client.register({
|
|
@@ -182,7 +182,7 @@ Retrieve a list of all CSS references from all registered and fetched
|
|
|
182
182
|
components.
|
|
183
183
|
|
|
184
184
|
```js
|
|
185
|
-
|
|
185
|
+
import Client from '@podium/client';
|
|
186
186
|
const client = new Client();
|
|
187
187
|
|
|
188
188
|
const foo = client.register({
|
|
@@ -214,7 +214,7 @@ If a manifest is successfully fetched, this method will resolve with a `true`
|
|
|
214
214
|
value. If a manifest is not successfully fetched, it will resolve with `false`.
|
|
215
215
|
|
|
216
216
|
```js
|
|
217
|
-
|
|
217
|
+
import Client from '@podium/client';
|
|
218
218
|
const client = new Client();
|
|
219
219
|
|
|
220
220
|
client.register({ uri: 'http://foo.site.com/manifest.json', name: 'foo' });
|
|
@@ -233,7 +233,7 @@ Refreshes the manifests of all registered resources. Does so by calling the
|
|
|
233
233
|
`.refresh()` method on all resources under the hood.
|
|
234
234
|
|
|
235
235
|
```js
|
|
236
|
-
|
|
236
|
+
import Client from '@podium/client';
|
|
237
237
|
const client = new Client();
|
|
238
238
|
|
|
239
239
|
client.register({ uri: 'http://foo.site.com/manifest.json', name: 'foo' });
|
|
@@ -499,7 +499,7 @@ fallback or the content then it can then be acted upon.
|
|
|
499
499
|
Example:
|
|
500
500
|
|
|
501
501
|
```js
|
|
502
|
-
|
|
502
|
+
import Client from '@podium/client';
|
|
503
503
|
const client = new Client();
|
|
504
504
|
|
|
505
505
|
const foo = client.register({
|
package/client.d.ts
CHANGED