@pixotope/socket.io-client 0.4.0 → 0.5.0

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.
Files changed (7) hide show
  1. package/.turbo/turbo-build.log +5 -5
  2. package/.turbo/turbo-check-types.log +1 -1
  3. package/CHANGELOG.md +6 -0
  4. package/README.md +24 -0
  5. package/package.json +2 -2
  6. package/src/index.ts +1 -0
  7. package/typedoc.json +4 -0
package/.turbo/turbo-build.log CHANGED
@@ -1,5 +1,5 @@
1
1
 
2
- > @pixotope/socket.io-client@0.4.0 build /home/circleci/project/packages/socket.io-client
2
+ > @pixotope/socket.io-client@0.5.0 build /home/circleci/project/packages/socket.io-client
3
3
  > tsup src/index.ts --format cjs,esm --dts
4
4
 
5
5
  CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
8
8
  CLI Target: esnext
9
9
  CJS Build start
10
10
  ESM Build start
11
- CJS dist/index.cjs 1.07 KB
12
- CJS ⚡️ Build success in 64ms
13
11
  ESM dist/index.js 50.00 B
14
- ESM ⚡️ Build success in 64ms
12
+ ESM ⚡️ Build success in 388ms
13
+ CJS dist/index.cjs 1.07 KB
14
+ CJS ⚡️ Build success in 390ms
15
15
  DTS Build start
16
- DTS ⚡️ Build success in 1596ms
16
+ DTS ⚡️ Build success in 3425ms
17
17
  DTS dist/index.d.cts 34.00 B
18
18
  DTS dist/index.d.ts 34.00 B
package/.turbo/turbo-check-types.log CHANGED
@@ -1,4 +1,4 @@
1
1
 
2
- > @pixotope/socket.io-client@0.4.0 check-types /home/circleci/project/packages/socket.io-client
2
+ > @pixotope/socket.io-client@0.5.0 check-types /home/circleci/project/packages/socket.io-client
3
3
  > tsc --noEmit
4
4
 
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @pixotope/socket.io-client
2
2
 
3
+ ## 0.5.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 8a28444: Include detailed documentation for every package and setup `typedoc`
8
+
3
9
  ## 0.4.0
4
10
 
5
11
  ### Minor Changes
package/README.md ADDED
@@ -0,0 +1,24 @@
1
+ # @pixotope/socket.io-client
2
+
3
+ Pinned re-export of `socket.io-client` for Pixotope Foundation.
4
+
5
+ ## Install
6
+
7
+ ```sh
8
+ pnpm add @pixotope/socket.io-client
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ This package is a thin re-export of the [`socket.io-client`](https://www.npmjs.com/package/socket.io-client) npm package, pinned to a specific version for consistency across Pixotope Foundation packages. Usage is identical to using `socket.io-client` directly - just import from `@pixotope/socket.io-client` instead:
14
+
15
+ ```ts
16
+ // Instead of:
17
+ // import { io } from "socket.io-client";
18
+
19
+ import { io } from "@pixotope/socket.io-client";
20
+
21
+ const socket = io("https://example.com");
22
+ ```
23
+
24
+ See the upstream [socket.io client API docs](https://socket.io/docs/v4/client-api/) for full usage.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@pixotope/socket.io-client",
3
- "version": "0.4.0",
4
- "description": "",
3
+ "version": "0.5.0",
4
+ "description": "Pinned re-export of socket.io-client for Pixotope Foundation",
5
5
  "private": false,
6
6
  "main": "dist/index.js",
7
7
  "module": "dist/index.js",
package/src/index.ts CHANGED
@@ -1 +1,2 @@
1
+ /** Re-exports the pinned `socket.io-client` client for use across Pixotope Foundation packages. */
1
2
  export * from "socket.io-client";
package/typedoc.json ADDED
@@ -0,0 +1,4 @@
1
+ {
2
+ "entryPoints": ["src/index.ts"],
3
+ "excludeExternals": true
4
+ }