@pacem/pacem-networking 1.0.0-amaldi → 1.0.0-archimedes
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/README.md +48 -0
- package/dist/browser/pacem-networking.js +1 -1
- package/dist/browser/pacem-networking.min.js +1 -1
- package/dist/bundle/pacem-networking.min.mjs +1 -1
- package/dist/bundle/pacem-networking.mjs +1 -1
- package/dist/esm/hub-proxy.js +1 -1
- package/dist/esm/index-components-networking.js +1 -1
- package/dist/esm/index-components.js +1 -1
- package/dist/esm/index-iife.js +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/sse-proxy.js +1 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
[](https://www.npmjs.com/package/@pacem/pacem-networking)
|
|
2
|
+
[](https://github.com/pacem-it/pacem/blob/main/LICENSE)
|
|
3
|
+
|
|
4
|
+
# @pacem/pacem-networking
|
|
5
|
+
|
|
6
|
+
Realtime networking for the [Pacem JS](https://js.pacem.it) ecosystem: `pacem-hub-proxy`/`pacem-hub-listener` for [SignalR](https://learn.microsoft.com/aspnet/core/signalr) hubs, and `pacem-sse-proxy`/`pacem-sse-listener` for Server-Sent Events — 4 custom elements in total.
|
|
7
|
+
|
|
8
|
+
Depends on [`@pacem/pacem-foundation`](https://www.npmjs.com/package/@pacem/pacem-foundation) and [`@pacem/pacem-core`](https://www.npmjs.com/package/@pacem/pacem-core).
|
|
9
|
+
|
|
10
|
+
Part of the [Pacem JS](https://js.pacem.it) ecosystem. Install [`@pacem/pacem`](https://www.npmjs.com/package/@pacem/pacem) instead if you want every package bundled together.
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
```sh
|
|
15
|
+
npm install @pacem/pacem-networking
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Usage
|
|
19
|
+
|
|
20
|
+
### As an ES module
|
|
21
|
+
|
|
22
|
+
```js
|
|
23
|
+
import { Components } from '@pacem/pacem-networking';
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### In the browser, without a bundler
|
|
27
|
+
|
|
28
|
+
```html
|
|
29
|
+
<script src="node_modules/@pacem/pacem-foundation/dist/browser/pacem-foundation.min.js"></script>
|
|
30
|
+
<script src="node_modules/@pacem/pacem-core/dist/browser/pacem-core.min.js"></script>
|
|
31
|
+
<script src="node_modules/@pacem/pacem-networking/dist/browser/pacem-networking.min.js"></script>
|
|
32
|
+
|
|
33
|
+
<pacem-sse-proxy url="/events">
|
|
34
|
+
<pacem-sse-listener method="message"></pacem-sse-listener>
|
|
35
|
+
</pacem-sse-proxy>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### TypeScript
|
|
39
|
+
|
|
40
|
+
Typings ship in `typings/index.d.ts` and are resolved automatically via the package's `exports` field — both for the ES module import style and for the ambient `Pacem` global used by the plain `<script>` include above.
|
|
41
|
+
|
|
42
|
+
## Custom elements
|
|
43
|
+
|
|
44
|
+
`pacem-hub-proxy`, `pacem-hub-listener`, `pacem-sse-proxy`, `pacem-sse-listener` — see [`@pacem/pacem`](https://www.npmjs.com/package/@pacem/pacem)'s `dist/vscode.html-custom.json` for attributes and editor IntelliSense support.
|
|
45
|
+
|
|
46
|
+
## License
|
|
47
|
+
|
|
48
|
+
[Apache-2.0](https://github.com/pacem-it/pacem/blob/main/LICENSE) © [Pacem](https://pacem.it)
|
package/dist/esm/hub-proxy.js
CHANGED
package/dist/esm/index-iife.js
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/esm/sse-proxy.js
CHANGED