is-any-array 1.0.1 → 2.0.1

package/README.md

@@ -13,7 +13,7 @@ Check if a value is any kind of array.
 ## Example
 
 ```js
-const isAnyArray = require('is-any-array');
+const {isAnyArray} = require('is-any-array');
 
 isAnyArray(1); // false
 isAnyArray('ab'); // false
@@ -29,7 +29,7 @@ isAnyArray(new Uint16Array(2))) // true;
 
 [npm-image]: https://img.shields.io/npm/v/is-any-array.svg
 [npm-url]: https://www.npmjs.com/package/is-any-array
-[build-image]: https://github.com/cheminfo/is-any-array/workflows/Node.js%20CI/badge.svg?branch=master
+[build-image]: https://github.com/cheminfo/is-any-array/workflows/Node.js%20CI/badge.svg?branch=main
 [build-url]: https://github.com/cheminfo/is-any-array/actions?query=workflow%3A%22Node.js+CI%22
 [download-image]: https://img.shields.io/npm/dm/is-any-array.svg
 [download-url]: https://www.npmjs.com/package/is-any-array

package/lib/index.d.ts

@@ -0,0 +1,9 @@
+export type AnyArray = any[] | Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array;
+/**
+ * Checks if an object is an instance of an Array (array or typed array, except those that contain bigint values).
+ *
+ * @param value - Object to check.
+ * @returns True if the object is an array or a typed array.
+ */
+export declare function isAnyArray(value: unknown): value is AnyArray;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,QAAQ,GAChB,GAAG,EAAE,GACL,SAAS,GACT,UAAU,GACV,iBAAiB,GACjB,UAAU,GACV,WAAW,GACX,UAAU,GACV,WAAW,GACX,YAAY,GACZ,YAAY,CAAC;AAEjB;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAG5D"}

package/lib/index.js

@@ -1,11 +1,17 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAnyArray = void 0;
+// eslint-disable-next-line @typescript-eslint/unbound-method
 const toString = Object.prototype.toString;
-
-function isAnyArray(object) {
-  return toString.call(object).endsWith('Array]');
+/**
+ * Checks if an object is an instance of an Array (array or typed array, except those that contain bigint values).
+ *
+ * @param value - Object to check.
+ * @returns True if the object is an array or a typed array.
+ */
+function isAnyArray(value) {
+    const tag = toString.call(value);
+    return tag.endsWith('Array]') && !tag.includes('Big');
 }
-
-exports['default'] = isAnyArray;
+exports.isAnyArray = isAnyArray;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,6DAA6D;AAC7D,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;AAc3C;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,KAAc;IACvC,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,OAAO,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC;AAHD,gCAGC"}

package/lib-esm/index.d.ts

@@ -0,0 +1,9 @@
+export type AnyArray = any[] | Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array;
+/**
+ * Checks if an object is an instance of an Array (array or typed array, except those that contain bigint values).
+ *
+ * @param value - Object to check.
+ * @returns True if the object is an array or a typed array.
+ */
+export declare function isAnyArray(value: unknown): value is AnyArray;
+//# sourceMappingURL=index.d.ts.map

package/lib-esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,QAAQ,GAChB,GAAG,EAAE,GACL,SAAS,GACT,UAAU,GACV,iBAAiB,GACjB,UAAU,GACV,WAAW,GACX,UAAU,GACV,WAAW,GACX,YAAY,GACZ,YAAY,CAAC;AAEjB;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAG5D"}

package/lib-esm/index.js

@@ -0,0 +1,13 @@
+// eslint-disable-next-line @typescript-eslint/unbound-method
+const toString = Object.prototype.toString;
+/**
+ * Checks if an object is an instance of an Array (array or typed array, except those that contain bigint values).
+ *
+ * @param value - Object to check.
+ * @returns True if the object is an array or a typed array.
+ */
+export function isAnyArray(value) {
+    const tag = toString.call(value);
+    return tag.endsWith('Array]') && !tag.includes('Big');
+}
+//# sourceMappingURL=index.js.map

package/lib-esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,6DAA6D;AAC7D,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;AAc3C;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,OAAO,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC"}

package/package.json

@@ -1,20 +1,28 @@
 {
   "name": "is-any-array",
-  "version": "1.0.1",
+  "version": "2.0.1",
   "description": "Check if a value is any kind of array",
-  "main": "lib/index.js",
-  "module": "src/index.js",
+  "main": "./lib/index.js",
+  "module": "./lib-esm/index.js",
+  "types": "./lib/index.d.ts",
   "files": [
     "lib",
+    "lib-esm",
     "src"
   ],
   "scripts": {
+    "check-types": "tsc --noEmit",
+    "clean": "rimraf lib lib-esm",
     "eslint": "eslint src",
     "eslint-fix": "npm run eslint -- --fix",
-    "prepack": "rollup -c",
-    "test": "npm run test-coverage && npm run eslint",
-    "test-coverage": "jest --coverage",
-    "test-only": "jest"
+    "prepack": "npm run tsc",
+    "prettier": "prettier --check src",
+    "prettier-write": "prettier --write src",
+    "tsc": "npm run clean && npm run tsc-cjs && npm run tsc-esm",
+    "tsc-cjs": "tsc --project tsconfig.cjs.json",
+    "tsc-esm": "tsc --project tsconfig.esm.json",
+    "test": "npm run test-only && npm run eslint && npm run check-types",
+    "test-only": "jest --coverage"
   },
   "repository": {
     "type": "git",
@@ -27,22 +35,14 @@
     "url": "https://github.com/cheminfo-js/is-any-array/issues"
   },
   "homepage": "https://github.com/cheminfo-js/is-any-array#readme",
-  "jest": {
-    "testEnvironment": "node"
-  },
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "^7.14.5",
-    "cheminfo-build": "^1.1.11",
-    "cheminfo-tools": "^1.23.3",
-    "codecov": "^3.8.2",
-    "eslint": "^7.29.0",
-    "eslint-config-cheminfo": "^5.2.4",
-    "eslint-plugin-import": "^2.23.4",
-    "eslint-plugin-jest": "^24.3.6",
-    "eslint-plugin-prettier": "^3.4.0",
-    "jest": "^27.0.6",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^2.3.2",
-    "rollup": "^2.52.4"
+    "@types/jest": "^29.5.1",
+    "eslint": "^8.39.0",
+    "eslint-config-cheminfo-typescript": "^11.3.1",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.8",
+    "rimraf": "^5.0.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.4"
   }
 }

package/src/__tests__/{test.js → test.ts}

@@ -1,4 +1,4 @@
-import isAnyArray from '..';
+import { isAnyArray } from '..';
 
 test('isArray', () => {
   expect(isAnyArray(1)).toBe(false);
@@ -8,4 +8,5 @@ test('isArray', () => {
   expect(isAnyArray([])).toBe(true);
   expect(isAnyArray([1, 2, 3])).toBe(true);
   expect(isAnyArray(new Uint16Array(2))).toBe(true);
+  expect(isAnyArray(new BigUint64Array(1))).toBe(false);
 });

package/src/index.ts

@@ -0,0 +1,25 @@
+// eslint-disable-next-line @typescript-eslint/unbound-method
+const toString = Object.prototype.toString;
+
+export type AnyArray =
+  | any[] // eslint-disable-line @typescript-eslint/no-explicit-any
+  | Int8Array
+  | Uint8Array
+  | Uint8ClampedArray
+  | Int16Array
+  | Uint16Array
+  | Int32Array
+  | Uint32Array
+  | Float32Array
+  | Float64Array;
+
+/**
+ * Checks if an object is an instance of an Array (array or typed array, except those that contain bigint values).
+ *
+ * @param value - Object to check.
+ * @returns True if the object is an array or a typed array.
+ */
+export function isAnyArray(value: unknown): value is AnyArray {
+  const tag = toString.call(value);
+  return tag.endsWith('Array]') && !tag.includes('Big');
+}

package/CHANGELOG.md

@@ -1,29 +0,0 @@
-# Changelog
-
-### [1.0.1](https://www.github.com/cheminfo/is-any-array/compare/v1.0.0...v1.0.1) (2021-06-30)
-
-
-### Bug Fixes
-
-* rollup in dependencies ! ([7c26c34](https://www.github.com/cheminfo/is-any-array/commit/7c26c3416287c57eaeb9fc481fb2a7b107cfa984))
-
-## [1.0.0](https://www.github.com/cheminfo/is-any-array/compare/v0.1.1...v1.0.0) (2021-03-24)
-
-
-### Bug Fixes
-
-* update readme and dependencies ([7ae8169](https://www.github.com/cheminfo/is-any-array/commit/7ae8169b1105bc9e3586f6a73315897326bb1bd4))
-
-### [0.1.1](https://github.com/cheminfo-js/is-any-array/compare/v0.1.0...v0.1.1) (2021-02-11)
-
-# [0.1.0](https://github.com/cheminfo-js/is-any-array/compare/v0.0.3...v0.1.0) (2020-02-25)
-
-
-
-<a name="0.0.3"></a>
-## [0.0.3](https://github.com/cheminfo-js/is-any-array/compare/v0.0.2...v0.0.3) (2018-10-26)
-
-
-
-<a name="0.0.2"></a>
-## 0.0.2 (2018-10-26)

package/src/index.js

@@ -1,5 +0,0 @@
-const toString = Object.prototype.toString;
-
-export default function isAnyArray(object) {
-  return toString.call(object).endsWith('Array]');
-}