@math.gl/types 4.0.1 → 4.1.0-alpha.2

package/dist/array-types.d.ts

@@ -8,7 +8,55 @@ export type TypedArrayConstructor = Int8ArrayConstructor | Uint8ArrayConstructor
  */
 export type NumericArray = TypedArray | number[];
 /**
- * TypeScript type covering all typed arrays and classic arrays consisting of numbers
- * @note alias for NumericArray
+ * TypeScript type for classic arrays consisting of numbers
+ * @note Included for completeness / orthogonality, prefer `number[]` in actual use
  */
-export type NumberArray = NumericArray;
+export type NumberArray = number[];
+/** Array with exactly 1 number */
+export type NumberArray1 = [number];
+/** Array with exactly 2 numbers */
+export type NumberArray2 = [number, number];
+/** Array with exactly 3 numbers */
+export type NumberArray3 = [number, number, number];
+/** Array with exactly 4 numbers */
+export type NumberArray4 = [number, number, number, number];
+/** Array with exactly 6 numbers */
+export type NumberArray6 = [number, number, number, number, number, number];
+/** Array with exactly 8 numbers */
+export type NumberArray8 = [number, number, number, number, number, number, number, number];
+/** Array with exactly 9 numbers */
+export type NumberArray9 = [number, number, number, number, number, number, number, number, number];
+/** Array with exactly 12 numbers */
+export type NumberArray12 = [
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+];
+/** Array with exactly 16 numbers */
+export type NumberArray16 = [
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+];

package/dist/array-types.js

@@ -1 +1,4 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 export {};

package/dist/bigint.js

@@ -1,3 +1,6 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 // BigInt compatibility layer
 // Inspired by ArrowJS (under Apache2 license)
 // https://github.com/apache/arrow/blob/master/js/src/util/compat.ts

package/dist/bounds-types.d.ts

@@ -0,0 +1,10 @@
+/** 2 dimensional bounds [[minX, minY], [maxX, maxY]] */
+export type Bounds2D = [[number, number], [number, number]];
+/** 3 dimensional bounds [[minX, minY, minZ], [maxX, maxY, maxZ]] */
+export type Bounds3D = [[number, number, number], [number, number, number]];
+/** 2 or 3 dimensional bounds [[minX, minY], [maxX, maxY]] or [[minX, minY, minZ], [maxX, maxY, maxZ]] */
+export type Bounds = [[number, number], [number, number]] | [[number, number, number], [number, number, number]];
+/** Checks if a `Bounds` is a `Bounds2D` */
+export declare function isBounds2D(bounds: Bounds): bounds is Bounds2D;
+/** Accepts 2D and 3D bounds and returns a 2D bound, truncating 3D dimension if necessary */
+export declare function getBounds2D(bounds: Bounds): Bounds2D;

package/dist/bounds-types.js

@@ -0,0 +1,16 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+/** Checks if a `Bounds` is a `Bounds2D` */
+export function isBounds2D(bounds) {
+    return bounds.length === 2;
+}
+/** Accepts 2D and 3D bounds and returns a 2D bound, truncating 3D dimension if necessary */
+export function getBounds2D(bounds) {
+    return isBounds2D(bounds)
+        ? bounds
+        : [
+            [bounds[0][0], bounds[0][1]],
+            [bounds[1][0], bounds[1][1]]
+        ];
+}

package/dist/index.cjs

@@ -19,6 +19,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // dist/index.js
 var dist_exports = {};
 __export(dist_exports, {
+  isNumberArray: () => isNumberArray,
   isNumericArray: () => isNumericArray,
   isTypedArray: () => isTypedArray
 });
@@ -26,12 +27,15 @@ module.exports = __toCommonJS(dist_exports);
 
 // dist/is-array.js
 function isTypedArray(value) {
-  return ArrayBuffer.isView(value) && !(value instanceof DataView) ? value : null;
+  return ArrayBuffer.isView(value) && !(value instanceof DataView);
 }
-function isNumericArray(value) {
+function isNumberArray(value) {
   if (Array.isArray(value)) {
-    return value.length === 0 || typeof value[0] === "number" ? value : null;
+    return value.length === 0 || typeof value[0] === "number";
   }
-  return isTypedArray(value);
+  return false;
+}
+function isNumericArray(value) {
+  return isTypedArray(value) || isNumberArray(value);
 }
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["index.js", "is-array.js"],
-  "sourcesContent": ["export { isTypedArray, isNumericArray } from \"./is-array.js\";\n", "/**\n * Check is an array is a typed array\n * @param value value to be tested\n * @returns input as TypedArray, or null\n */\nexport function isTypedArray(value) {\n    return ArrayBuffer.isView(value) && !(value instanceof DataView) ? value : null;\n}\n/**\n * Check is an array is a numeric array (typed array or array of numbers)\n * @param value value to be tested\n * @returns input as NumericArray, or null\n */\nexport function isNumericArray(value) {\n    if (Array.isArray(value)) {\n        return value.length === 0 || typeof value[0] === 'number' ? value : null;\n    }\n    return isTypedArray(value);\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACKO,SAAS,aAAa,OAAO;AAChC,SAAO,YAAY,OAAO,KAAK,KAAK,EAAE,iBAAiB,YAAY,QAAQ;AAC/E;AAMO,SAAS,eAAe,OAAO;AAClC,MAAI,MAAM,QAAQ,KAAK,GAAG;AACtB,WAAO,MAAM,WAAW,KAAK,OAAO,MAAM,OAAO,WAAW,QAAQ;AAAA,EACxE;AACA,SAAO,aAAa,KAAK;AAC7B;",
+  "sourcesContent": ["// math.gl\n// SPDX-License-Identifier: MIT\n// Copyright (c) vis.gl contributors\nexport { isTypedArray, isNumberArray, isNumericArray } from \"./is-array.js\";\n", "// math.gl\n// SPDX-License-Identifier: MIT\n// Copyright (c) vis.gl contributors\n/**\n * Check is an array is a typed array\n * @param value value to be tested\n * @returns input with type narrowed to TypedArray, or null\n */\nexport function isTypedArray(value) {\n    return ArrayBuffer.isView(value) && !(value instanceof DataView);\n}\n/**\n * Check is an array is an array of numbers)\n * @param value value to be tested\n * @returns input with type narrowed to NumberArray, or null\n */\nexport function isNumberArray(value) {\n    if (Array.isArray(value)) {\n        return value.length === 0 || typeof value[0] === 'number';\n    }\n    return false;\n}\n/**\n * Check is an array is a numeric array (typed array or array of numbers)\n * @param value value to be tested\n * @returns input with type narrowed to NumericArray, or null\n */\nexport function isNumericArray(value) {\n    return isTypedArray(value) || isNumberArray(value);\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACQO,SAAS,aAAa,OAAO;AAChC,SAAO,YAAY,OAAO,KAAK,KAAK,EAAE,iBAAiB;AAC3D;AAMO,SAAS,cAAc,OAAO;AACjC,MAAI,MAAM,QAAQ,KAAK,GAAG;AACtB,WAAO,MAAM,WAAW,KAAK,OAAO,MAAM,OAAO;AAAA,EACrD;AACA,SAAO;AACX;AAMO,SAAS,eAAe,OAAO;AAClC,SAAO,aAAa,KAAK,KAAK,cAAc,KAAK;AACrD;",
   "names": []
 }

package/dist/index.d.ts

@@ -1,2 +1,3 @@
-export type { TypedArray, TypedArrayConstructor, NumericArray, NumberArray } from "./array-types.js";
-export { isTypedArray, isNumericArray } from "./is-array.js";
+export type { TypedArray, TypedArrayConstructor, NumericArray, NumberArray, NumberArray1, NumberArray2, NumberArray3, NumberArray4, NumberArray6, NumberArray8, NumberArray9, NumberArray12, NumberArray16 } from "./array-types.js";
+export { isTypedArray, isNumberArray, isNumericArray } from "./is-array.js";
+export type { Bounds, Bounds2D, Bounds3D } from "./bounds-types.js";

package/dist/index.js

@@ -1 +1,4 @@
-export { isTypedArray, isNumericArray } from "./is-array.js";
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+export { isTypedArray, isNumberArray, isNumericArray } from "./is-array.js";

package/dist/is-array.d.ts

@@ -1,13 +1,19 @@
-import { TypedArray, NumericArray } from "./array-types.js";
+import { TypedArray, NumericArray, NumberArray } from "./array-types.js";
 /**
  * Check is an array is a typed array
  * @param value value to be tested
- * @returns input as TypedArray, or null
+ * @returns input with type narrowed to TypedArray, or null
  */
-export declare function isTypedArray(value: unknown): TypedArray | null;
+export declare function isTypedArray(value: unknown): value is TypedArray;
+/**
+ * Check is an array is an array of numbers)
+ * @param value value to be tested
+ * @returns input with type narrowed to NumberArray, or null
+ */
+export declare function isNumberArray(value: unknown): value is NumberArray;
 /**
  * Check is an array is a numeric array (typed array or array of numbers)
  * @param value value to be tested
- * @returns input as NumericArray, or null
+ * @returns input with type narrowed to NumericArray, or null
  */
-export declare function isNumericArray(value: unknown): NumericArray | null;
+export declare function isNumericArray(value: unknown): value is NumericArray;

package/dist/is-array.js

@@ -1,19 +1,30 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 /**
  * Check is an array is a typed array
  * @param value value to be tested
- * @returns input as TypedArray, or null
+ * @returns input with type narrowed to TypedArray, or null
  */
 export function isTypedArray(value) {
-    return ArrayBuffer.isView(value) && !(value instanceof DataView) ? value : null;
+    return ArrayBuffer.isView(value) && !(value instanceof DataView);
 }
 /**
- * Check is an array is a numeric array (typed array or array of numbers)
+ * Check is an array is an array of numbers)
  * @param value value to be tested
- * @returns input as NumericArray, or null
+ * @returns input with type narrowed to NumberArray, or null
  */
-export function isNumericArray(value) {
+export function isNumberArray(value) {
     if (Array.isArray(value)) {
-        return value.length === 0 || typeof value[0] === 'number' ? value : null;
+        return value.length === 0 || typeof value[0] === 'number';
     }
-    return isTypedArray(value);
+    return false;
+}
+/**
+ * Check is an array is a numeric array (typed array or array of numbers)
+ * @param value value to be tested
+ * @returns input with type narrowed to NumericArray, or null
+ */
+export function isNumericArray(value) {
+    return isTypedArray(value) || isNumberArray(value);
 }

package/package.json

@@ -6,7 +6,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "4.0.1",
+  "version": "4.1.0-alpha.2",
   "keywords": [
     "typescript",
     "javascript",
@@ -35,5 +35,5 @@
   "sideEffects": [
     "./src/bigint.js"
   ],
-  "gitHead": "33f369ba3a259f79acc3fa8181190c9da8841648"
+  "gitHead": "59eb434870991d06aecff5b1dee38078af0ca447"
 }

package/src/array-types.ts

@@ -1,3 +1,7 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 /**
  * TypeScript type covering all typed arrays
  */
@@ -33,7 +37,64 @@ export type TypedArrayConstructor =
 export type NumericArray = TypedArray | number[];
 
 /**
- * TypeScript type covering all typed arrays and classic arrays consisting of numbers
- * @note alias for NumericArray
+ * TypeScript type for classic arrays consisting of numbers
+ * @note Included for completeness / orthogonality, prefer `number[]` in actual use
  */
-export type NumberArray = NumericArray;
+export type NumberArray = number[];
+
+/** Array with exactly 1 number */
+export type NumberArray1 = [number];
+
+/** Array with exactly 2 numbers */
+export type NumberArray2 = [number, number];
+
+/** Array with exactly 3 numbers */
+export type NumberArray3 = [number, number, number];
+
+/** Array with exactly 4 numbers */
+export type NumberArray4 = [number, number, number, number];
+
+/** Array with exactly 6 numbers */
+export type NumberArray6 = [number, number, number, number, number, number];
+
+/** Array with exactly 8 numbers */
+export type NumberArray8 = [number, number, number, number, number, number, number, number];
+
+/** Array with exactly 9 numbers */
+export type NumberArray9 = [number, number, number, number, number, number, number, number, number];
+
+/** Array with exactly 12 numbers */
+export type NumberArray12 = [
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number
+];
+
+/** Array with exactly 16 numbers */
+export type NumberArray16 = [
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number,
+  number
+];

package/src/bigint.ts

@@ -1,3 +1,7 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
 // BigInt compatibility layer
 // Inspired by ArrowJS (under Apache2 license)
 // https://github.com/apache/arrow/blob/master/js/src/util/compat.ts

package/src/bounds-types.ts

@@ -0,0 +1,29 @@
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+/** 2 dimensional bounds [[minX, minY], [maxX, maxY]] */
+export type Bounds2D = [[number, number], [number, number]];
+
+/** 3 dimensional bounds [[minX, minY, minZ], [maxX, maxY, maxZ]] */
+export type Bounds3D = [[number, number, number], [number, number, number]];
+
+/** 2 or 3 dimensional bounds [[minX, minY], [maxX, maxY]] or [[minX, minY, minZ], [maxX, maxY, maxZ]] */
+export type Bounds =
+  | [[number, number], [number, number]]
+  | [[number, number, number], [number, number, number]];
+
+/** Checks if a `Bounds` is a `Bounds2D` */
+export function isBounds2D(bounds: Bounds): bounds is Bounds2D {
+  return bounds.length === 2;
+}
+
+/** Accepts 2D and 3D bounds and returns a 2D bound, truncating 3D dimension if necessary */
+export function getBounds2D(bounds: Bounds): Bounds2D {
+  return isBounds2D(bounds)
+    ? bounds
+    : [
+      [bounds[0][0], bounds[0][1]],
+      [bounds[1][0], bounds[1][1]]
+    ];
+}

package/src/index.ts

@@ -1,2 +1,23 @@
-export type {TypedArray, TypedArrayConstructor, NumericArray, NumberArray} from './array-types';
-export {isTypedArray, isNumericArray} from './is-array';
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+export type {
+  TypedArray,
+  TypedArrayConstructor,
+  NumericArray,
+  NumberArray,
+  NumberArray1,
+  NumberArray2,
+  NumberArray3,
+  NumberArray4,
+  NumberArray6,
+  NumberArray8,
+  NumberArray9,
+  NumberArray12,
+  NumberArray16
+} from './array-types';
+
+export {isTypedArray, isNumberArray, isNumericArray} from './is-array';
+
+export type {Bounds, Bounds2D, Bounds3D} from './bounds-types';

package/src/is-array.ts

@@ -1,22 +1,35 @@
-import {TypedArray, NumericArray} from './array-types';
+// math.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
+
+import {TypedArray, NumericArray, NumberArray} from './array-types';
 
 /**
  * Check is an array is a typed array
  * @param value value to be tested
- * @returns input as TypedArray, or null
+ * @returns input with type narrowed to TypedArray, or null
  */
-export function isTypedArray(value: unknown): TypedArray | null {
-  return ArrayBuffer.isView(value) && !(value instanceof DataView) ? (value as TypedArray) : null;
+export function isTypedArray(value: unknown): value is TypedArray {
+  return ArrayBuffer.isView(value) && !(value instanceof DataView);
 }
 
 /**
- * Check is an array is a numeric array (typed array or array of numbers)
+ * Check is an array is an array of numbers)
  * @param value value to be tested
- * @returns input as NumericArray, or null
+ * @returns input with type narrowed to NumberArray, or null
  */
-export function isNumericArray(value: unknown): NumericArray | null {
+export function isNumberArray(value: unknown): value is NumberArray {
   if (Array.isArray(value)) {
-    return value.length === 0 || typeof value[0] === 'number' ? (value as number[]) : null;
+    return value.length === 0 || typeof value[0] === 'number';
   }
-  return isTypedArray(value);
+  return false;
+}
+
+/**
+ * Check is an array is a numeric array (typed array or array of numbers)
+ * @param value value to be tested
+ * @returns input with type narrowed to NumericArray, or null
+ */
+export function isNumericArray(value: unknown): value is NumericArray {
+  return isTypedArray(value) || isNumberArray(value);
 }