@xylabs/platform 5.0.95 → 5.0.97

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 (2) hide show
  1. package/README.md +47 -67
  2. package/package.json +6 -7
package/README.md CHANGED
@@ -1,40 +1,54 @@
1
1
  # @xylabs/platform
2
2
 
3
- [![logo][]](https://xylabs.com)
3
+ [![npm][npm-badge]][npm-link]
4
+ [![license][license-badge]][license-link]
4
5
 
5
- [![main-build][]][main-build-link]
6
- [![npm-badge][]][npm-link]
7
- [![npm-downloads-badge][]][npm-link]
8
- [![jsdelivr-badge][]][jsdelivr-link]
9
- [![npm-license-badge][]](LICENSE)
10
- [![codacy-badge][]][codacy-link]
11
- [![codeclimate-badge][]][codeclimate-link]
12
- [![snyk-badge][]][snyk-link]
13
- [![socket-badge][]][socket-link]
6
+ > Base functionality used throughout XY Labs TypeScript/JavaScript libraries
14
7
 
8
+ ## Install
15
9
 
16
- Base functionality used throughout XY Labs TypeScript/JavaScript libraries
10
+ Using npm:
17
11
 
12
+ ```sh
13
+ npm install {{name}}
14
+ ```
18
15
 
16
+ Using yarn:
19
17
 
20
- ## Reference
18
+ ```sh
19
+ yarn add {{name}}
20
+ ```
21
21
 
22
- **@xylabs/platform**
22
+ Using pnpm:
23
23
 
24
- ***
24
+ ```sh
25
+ pnpm add {{name}}
26
+ ```
27
+
28
+ Using bun:
29
+
30
+ ```sh
31
+ bun add {{name}}
32
+ ```
33
+
34
+
35
+ ## License
36
+
37
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
38
+
39
+ ## Reference
25
40
 
26
- ## Modules
41
+ ### packages
27
42
 
28
- | Module | Description |
29
- | ------ | ------ |
30
- | [index-browser](#index-browser/README) | - |
31
- | [index-node](#index-node/README) | - |
43
+ ### platform
32
44
 
33
- ### index-browser
45
+ ### .temp-typedoc
34
46
 
35
- ### functions
47
+ ### index-browser
36
48
 
37
- ### <a id="isBrowser"></a>isBrowser
49
+ ### functions
50
+
51
+ ### <a id="isBrowser"></a>isBrowser
38
52
 
39
53
  [**@xylabs/platform**](#../../README)
40
54
 
@@ -50,7 +64,7 @@ Returns whether the current environment is a browser window (not a web worker).
50
64
 
51
65
  `boolean`
52
66
 
53
- ### <a id="isNode"></a>isNode
67
+ ### <a id="isNode"></a>isNode
54
68
 
55
69
  [**@xylabs/platform**](#../../README)
56
70
 
@@ -66,7 +80,7 @@ Returns whether the current environment is Node.js. Always returns false in the
66
80
 
67
81
  `boolean`
68
82
 
69
- ### <a id="isWebworker"></a>isWebworker
83
+ ### <a id="isWebworker"></a>isWebworker
70
84
 
71
85
  [**@xylabs/platform**](#../../README)
72
86
 
@@ -82,9 +96,9 @@ Returns whether the current environment is a dedicated web worker.
82
96
 
83
97
  `boolean`
84
98
 
85
- ### variables
99
+ ### variables
86
100
 
87
- ### <a id="subtle"></a>subtle
101
+ ### <a id="subtle"></a>subtle
88
102
 
89
103
  [**@xylabs/platform**](#../../README)
90
104
 
@@ -96,11 +110,11 @@ const subtle: SubtleCrypto;
96
110
 
97
111
  The Web Crypto API's SubtleCrypto interface, sourced from the browser's globalThis.crypto.
98
112
 
99
- ### index-node
113
+ ### index-node
100
114
 
101
- ### functions
115
+ ### functions
102
116
 
103
- ### <a id="isBrowser"></a>isBrowser
117
+ ### <a id="isBrowser"></a>isBrowser
104
118
 
105
119
  [**@xylabs/platform**](#../../README)
106
120
 
@@ -116,7 +130,7 @@ Returns whether the current environment is a browser. Always returns false in No
116
130
 
117
131
  `boolean`
118
132
 
119
- ### <a id="isNode"></a>isNode
133
+ ### <a id="isNode"></a>isNode
120
134
 
121
135
  [**@xylabs/platform**](#../../README)
122
136
 
@@ -132,7 +146,7 @@ Returns whether the current environment is Node.js. Always returns true in this
132
146
 
133
147
  `boolean`
134
148
 
135
- ### <a id="isWebworker"></a>isWebworker
149
+ ### <a id="isWebworker"></a>isWebworker
136
150
 
137
151
  [**@xylabs/platform**](#../../README)
138
152
 
@@ -149,41 +163,7 @@ Returns whether the current environment is a web worker. Always returns false in
149
163
  `boolean`
150
164
 
151
165
 
152
- Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
153
-
154
- ## Maintainers
155
-
156
- - [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
157
- - [Matt Jones](https://github.com/jonesmac)
158
- - [Joel Carter](https://github.com/JoelBCarter)
159
- - [Jordan Trouw](https://github.com/jordantrouw)
160
-
161
- ## License
162
-
163
- > See the [LICENSE](LICENSE) file for license details
164
-
165
- ## Credits
166
-
167
- [Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
168
-
169
- [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
170
-
171
- [main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
172
- [main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
173
166
  [npm-badge]: https://img.shields.io/npm/v/@xylabs/platform.svg
174
167
  [npm-link]: https://www.npmjs.com/package/@xylabs/platform
175
- [codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
176
- [codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
177
- [codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
178
- [codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
179
- [snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
180
- [snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
181
-
182
- [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/platform
183
- [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/platform
184
-
185
- [jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/platform/badge
186
- [jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/platform
187
-
188
- [socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/platform
189
- [socket-link]: https://socket.dev/npm/package/@xylabs/platform
168
+ [license-badge]: https://img.shields.io/npm/l/@xylabs/platform.svg
169
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xylabs/platform",
3
- "version": "5.0.95",
3
+ "version": "5.0.97",
4
4
  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
5
5
  "keywords": [
6
6
  "platform",
@@ -47,14 +47,13 @@
47
47
  "README.md"
48
48
  ],
49
49
  "devDependencies": {
50
- "@types/node": "^25.5.2",
51
- "@xylabs/ts-scripts-common": "~7.8.4",
52
- "@xylabs/ts-scripts-pnpm": "~7.8.4",
53
- "@xylabs/tsconfig": "~7.8.4",
50
+ "@types/node": "^25.6.0",
51
+ "@xylabs/toolchain": "~7.10.4",
52
+ "@xylabs/tsconfig": "~7.10.4",
54
53
  "esbuild": "^0.28.0",
55
54
  "typescript": "^5",
56
- "vite": "^8.0.5",
57
- "vitest": "^4.1.2"
55
+ "vite": "^8.0.8",
56
+ "vitest": "^4.1.4"
58
57
  },
59
58
  "engines": {
60
59
  "node": ">=18"