@xylabs/platform 5.0.83 → 5.0.86

package/README.md

@@ -15,6 +15,8 @@
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+
+
 ## Reference
 
 **@xylabs/platform**
@@ -23,8 +25,10 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Modules
 
-- [index-browser](#index-browser/README)
-- [index-node](#index-node/README)
+| Module | Description |
+| ------ | ------ |
+| [index-browser](#index-browser/README) | - |
+| [index-node](#index-node/README) | - |
 
 ### index-browser
 
@@ -40,6 +44,8 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 function isBrowser(): boolean;
 ```
 
+Returns whether the current environment is a browser window (not a web worker).
+
 ## Returns
 
 `boolean`
@@ -54,6 +60,8 @@ function isBrowser(): boolean;
 function isNode(): boolean;
 ```
 
+Returns whether the current environment is Node.js. Always returns false in the browser entry point.
+
 ## Returns
 
 `boolean`
@@ -68,6 +76,8 @@ function isNode(): boolean;
 function isWebworker(): boolean;
 ```
 
+Returns whether the current environment is a dedicated web worker.
+
 ## Returns
 
 `boolean`
@@ -84,6 +94,8 @@ function isWebworker(): boolean;
 const subtle: SubtleCrypto;
 ```
 
+The Web Crypto API's SubtleCrypto interface, sourced from the browser's globalThis.crypto.
+
 ### index-node
 
   ### functions
@@ -98,6 +110,8 @@ const subtle: SubtleCrypto;
 function isBrowser(): boolean;
 ```
 
+Returns whether the current environment is a browser. Always returns false in Node.js.
+
 ## Returns
 
 `boolean`
@@ -112,6 +126,8 @@ function isBrowser(): boolean;
 function isNode(): boolean;
 ```
 
+Returns whether the current environment is Node.js. Always returns true in this entry point.
+
 ## Returns
 
 `boolean`
@@ -126,6 +142,8 @@ function isNode(): boolean;
 function isWebworker(): boolean;
 ```
 
+Returns whether the current environment is a web worker. Always returns false in Node.js.
+
 ## Returns
 
 `boolean`

package/dist/browser/browser/index.d.ts

@@ -1,6 +1,10 @@
 import type { subtle as subtleType } from 'node:crypto';
+/** Returns whether the current environment is a browser window (not a web worker). */
 export declare const isBrowser: () => boolean;
+/** Returns whether the current environment is a dedicated web worker. */
 export declare const isWebworker: () => boolean;
+/** Returns whether the current environment is Node.js. Always returns false in the browser entry point. */
 export declare const isNode: () => boolean;
+/** The Web Crypto API's SubtleCrypto interface, sourced from the browser's globalThis.crypto. */
 export declare const subtle: typeof subtleType;
 //# sourceMappingURL=index.d.ts.map

package/dist/browser/browser/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/browser/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,aAAa,CAAA;AAEvD,eAAO,MAAM,SAAS,eAErB,CAAA;AAED,eAAO,MAAM,WAAW,eAEvB,CAAA;AAED,eAAO,MAAM,MAAM,eAElB,CAAA;AAED,eAAO,MAAM,MAAM,EAA+B,OAAO,UAAU,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/browser/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,aAAa,CAAA;AAEvD,sFAAsF;AACtF,eAAO,MAAM,SAAS,eAErB,CAAA;AAED,yEAAyE;AACzE,eAAO,MAAM,WAAW,eAEvB,CAAA;AAED,2GAA2G;AAC3G,eAAO,MAAM,MAAM,eAElB,CAAA;AAED,iGAAiG;AACjG,eAAO,MAAM,MAAM,EAA+B,OAAO,UAAU,CAAA"}

package/dist/browser/index-browser.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/browser/index.ts"],"sourcesContent":["import type { subtle as subtleType } from 'node:crypto'\n\nexport const isBrowser = () => {\n  return !isWebworker() && globalThis.constructor?.name === 'Window'\n}\n\nexport const isWebworker = () => {\n  return typeof globalThis === 'object' && globalThis.constructor?.name === 'DedicatedWorkerGlobalScope'\n}\n\nexport const isNode = () => {\n  return false\n}\n\nexport const subtle = globalThis.crypto.subtle as typeof subtleType\n"],"mappings":";AAEO,IAAM,YAAY,MAAM;AAC7B,SAAO,CAAC,YAAY,KAAK,WAAW,aAAa,SAAS;AAC5D;AAEO,IAAM,cAAc,MAAM;AAC/B,SAAO,OAAO,eAAe,YAAY,WAAW,aAAa,SAAS;AAC5E;AAEO,IAAM,SAAS,MAAM;AAC1B,SAAO;AACT;AAEO,IAAM,SAAS,WAAW,OAAO;","names":[]}
+{"version":3,"sources":["../../src/browser/index.ts"],"sourcesContent":["import type { subtle as subtleType } from 'node:crypto'\n\n/** Returns whether the current environment is a browser window (not a web worker). */\nexport const isBrowser = () => {\n  return !isWebworker() && globalThis.constructor?.name === 'Window'\n}\n\n/** Returns whether the current environment is a dedicated web worker. */\nexport const isWebworker = () => {\n  return typeof globalThis === 'object' && globalThis.constructor?.name === 'DedicatedWorkerGlobalScope'\n}\n\n/** Returns whether the current environment is Node.js. Always returns false in the browser entry point. */\nexport const isNode = () => {\n  return false\n}\n\n/** The Web Crypto API's SubtleCrypto interface, sourced from the browser's globalThis.crypto. */\nexport const subtle = globalThis.crypto.subtle as typeof subtleType\n"],"mappings":";AAGO,IAAM,YAAY,MAAM;AAC7B,SAAO,CAAC,YAAY,KAAK,WAAW,aAAa,SAAS;AAC5D;AAGO,IAAM,cAAc,MAAM;AAC/B,SAAO,OAAO,eAAe,YAAY,WAAW,aAAa,SAAS;AAC5E;AAGO,IAAM,SAAS,MAAM;AAC1B,SAAO;AACT;AAGO,IAAM,SAAS,WAAW,OAAO;","names":[]}

package/dist/browser/node/index.d.ts

@@ -1,5 +1,9 @@
+/** The Web Crypto API's SubtleCrypto interface, re-exported from Node.js crypto module. */
 export { subtle } from 'node:crypto';
+/** Returns whether the current environment is a browser. Always returns false in Node.js. */
 export declare const isBrowser: () => boolean;
+/** Returns whether the current environment is a web worker. Always returns false in Node.js. */
 export declare const isWebworker: () => boolean;
+/** Returns whether the current environment is Node.js. Always returns true in this entry point. */
 export declare const isNode: () => boolean;
 //# sourceMappingURL=index.d.ts.map

package/dist/browser/node/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/node/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,eAAO,MAAM,SAAS,eAErB,CAAA;AAED,eAAO,MAAM,WAAW,eAEvB,CAAA;AAED,eAAO,MAAM,MAAM,eAElB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/node/index.ts"],"names":[],"mappings":"AAAA,2FAA2F;AAC3F,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,6FAA6F;AAC7F,eAAO,MAAM,SAAS,eAErB,CAAA;AAED,gGAAgG;AAChG,eAAO,MAAM,WAAW,eAEvB,CAAA;AAED,mGAAmG;AACnG,eAAO,MAAM,MAAM,eAElB,CAAA"}

package/dist/node/browser/index.d.ts

@@ -1,6 +1,10 @@
 import type { subtle as subtleType } from 'node:crypto';
+/** Returns whether the current environment is a browser window (not a web worker). */
 export declare const isBrowser: () => boolean;
+/** Returns whether the current environment is a dedicated web worker. */
 export declare const isWebworker: () => boolean;
+/** Returns whether the current environment is Node.js. Always returns false in the browser entry point. */
 export declare const isNode: () => boolean;
+/** The Web Crypto API's SubtleCrypto interface, sourced from the browser's globalThis.crypto. */
 export declare const subtle: typeof subtleType;
 //# sourceMappingURL=index.d.ts.map

package/dist/node/browser/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/browser/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,aAAa,CAAA;AAEvD,eAAO,MAAM,SAAS,eAErB,CAAA;AAED,eAAO,MAAM,WAAW,eAEvB,CAAA;AAED,eAAO,MAAM,MAAM,eAElB,CAAA;AAED,eAAO,MAAM,MAAM,EAA+B,OAAO,UAAU,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/browser/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,MAAM,aAAa,CAAA;AAEvD,sFAAsF;AACtF,eAAO,MAAM,SAAS,eAErB,CAAA;AAED,yEAAyE;AACzE,eAAO,MAAM,WAAW,eAEvB,CAAA;AAED,2GAA2G;AAC3G,eAAO,MAAM,MAAM,eAElB,CAAA;AAED,iGAAiG;AACjG,eAAO,MAAM,MAAM,EAA+B,OAAO,UAAU,CAAA"}

package/dist/node/index-node.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/node/index.ts"],"sourcesContent":["export { subtle } from 'node:crypto'\n\nexport const isBrowser = () => {\n  return false\n}\n\nexport const isWebworker = () => {\n  return false\n}\n\nexport const isNode = () => {\n  return true\n}\n"],"mappings":";AAAA,SAAS,cAAc;AAEhB,IAAM,YAAY,MAAM;AAC7B,SAAO;AACT;AAEO,IAAM,cAAc,MAAM;AAC/B,SAAO;AACT;AAEO,IAAM,SAAS,MAAM;AAC1B,SAAO;AACT;","names":[]}
+{"version":3,"sources":["../../src/node/index.ts"],"sourcesContent":["/** The Web Crypto API's SubtleCrypto interface, re-exported from Node.js crypto module. */\nexport { subtle } from 'node:crypto'\n\n/** Returns whether the current environment is a browser. Always returns false in Node.js. */\nexport const isBrowser = () => {\n  return false\n}\n\n/** Returns whether the current environment is a web worker. Always returns false in Node.js. */\nexport const isWebworker = () => {\n  return false\n}\n\n/** Returns whether the current environment is Node.js. Always returns true in this entry point. */\nexport const isNode = () => {\n  return true\n}\n"],"mappings":";AACA,SAAS,cAAc;AAGhB,IAAM,YAAY,MAAM;AAC7B,SAAO;AACT;AAGO,IAAM,cAAc,MAAM;AAC/B,SAAO;AACT;AAGO,IAAM,SAAS,MAAM;AAC1B,SAAO;AACT;","names":[]}

package/dist/node/node/index.d.ts

@@ -1,5 +1,9 @@
+/** The Web Crypto API's SubtleCrypto interface, re-exported from Node.js crypto module. */
 export { subtle } from 'node:crypto';
+/** Returns whether the current environment is a browser. Always returns false in Node.js. */
 export declare const isBrowser: () => boolean;
+/** Returns whether the current environment is a web worker. Always returns false in Node.js. */
 export declare const isWebworker: () => boolean;
+/** Returns whether the current environment is Node.js. Always returns true in this entry point. */
 export declare const isNode: () => boolean;
 //# sourceMappingURL=index.d.ts.map

package/dist/node/node/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/node/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,eAAO,MAAM,SAAS,eAErB,CAAA;AAED,eAAO,MAAM,WAAW,eAEvB,CAAA;AAED,eAAO,MAAM,MAAM,eAElB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/node/index.ts"],"names":[],"mappings":"AAAA,2FAA2F;AAC3F,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,6FAA6F;AAC7F,eAAO,MAAM,SAAS,eAErB,CAAA;AAED,gGAAgG;AAChG,eAAO,MAAM,WAAW,eAEvB,CAAA;AAED,mGAAmG;AACnG,eAAO,MAAM,MAAM,eAElB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/platform",
-  "version": "5.0.83",
+  "version": "5.0.86",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "platform",
@@ -48,8 +48,8 @@
     "!**/*.test.*"
   ],
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.16",
+    "@xylabs/tsconfig": "~7.4.16",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
   },