is-any-array 0.1.0 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+## [2.0.0](https://www.github.com/cheminfo/is-any-array/compare/v1.0.1...v2.0.0) (2021-10-15)
+
+
+### ⚠ BREAKING CHANGES
+
+When using this project you will need to use a named import: `import { isAnyArray } from 'is-any-array'`.
+
+### Code Refactoring
+
+* setup project for TypeScript ([#7](https://www.github.com/cheminfo/is-any-array/issues/7)) ([21e47a0](https://www.github.com/cheminfo/is-any-array/commit/21e47a02e36987208b5aa22906c1cbfee3322775))
+
+### [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/README.md

@@ -1,43 +1,35 @@
 # is-any-array
 
 [![NPM version][npm-image]][npm-url]
-[![build status][travis-image]][travis-url]
-[![Test coverage][codecov-image]][codecov-url]
-[![David deps][david-image]][david-url]
+[![build status][build-image]][build-url]
 [![npm download][download-image]][download-url]
 
-Check if toString.call ends with Array
+Check if a value is any kind of array.
 
 ## Installation
 
 `$ npm install is-any-array`
 
-## [API Documentation](https://cheminfo-js.github.io/is-any-array/)
-
 ## Example
 
 ```js
-const isAnyArray = require('is-any-array');
+const {isAnyArray} = require('is-any-array');
 
-  isAnyArray(1); // false
-  isAnyArray('ab'); // false
-  isAnyArray({ a: 1 }); // false
+isAnyArray(1); // false
+isAnyArray('ab'); // false
+isAnyArray({ a: 1 }); // false
 
-  isAnyArray([1, 2, 3]); // true
-  isAnyArray(new Uint16Array(2))) // true;
+isAnyArray([1, 2, 3]); // true
+isAnyArray(new Uint16Array(2))) // true;
 ```
 
 ## License
 
 [MIT](./LICENSE)
 
-[npm-image]: https://img.shields.io/npm/v/is-any-array.svg?style=flat-square
+[npm-image]: https://img.shields.io/npm/v/is-any-array.svg
 [npm-url]: https://www.npmjs.com/package/is-any-array
-[travis-image]: https://img.shields.io/travis/cheminfo-js/is-any-array/master.svg?style=flat-square
-[travis-url]: https://travis-ci.org/cheminfo-js/is-any-array
-[codecov-image]: https://img.shields.io/codecov/c/github/cheminfo-js/is-any-array.svg?style=flat-square
-[codecov-url]: https://codecov.io/gh/cheminfo-js/is-any-array
-[david-image]: https://img.shields.io/david/cheminfo-js/is-any-array.svg?style=flat-square
-[david-url]: https://david-dm.org/cheminfo-js/is-any-array
-[download-image]: https://img.shields.io/npm/dm/is-any-array.svg?style=flat-square
+[build-image]: https://github.com/cheminfo/is-any-array/workflows/Node.js%20CI/badge.svg?branch=master
+[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,8 @@
+/**
+ * Checks if an object is an instance of an Array (array or typed array).
+ *
+ * @param {any} value - Object to check.
+ * @returns {boolean} True if the object is an array.
+ */
+export function isAnyArray(value: any): boolean;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,kCAHW,GAAG,GACD,OAAO,CAInB"}

package/lib/index.js

@@ -1,11 +1,15 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAnyArray = void 0;
 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).
+ *
+ * @param {any} value - Object to check.
+ * @returns {boolean} True if the object is an array.
+ */
+function isAnyArray(value) {
+    return toString.call(value).endsWith('Array]');
 }
-
-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.js"],"names":[],"mappings":";;;AAAA,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;AAE3C;;;;;GAKG;AACH,SAAgB,UAAU,CAAC,KAAK;IAC9B,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACjD,CAAC;AAFD,gCAEC"}

package/lib-esm/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Checks if an object is an instance of an Array (array or typed array).
+ *
+ * @param {any} value - Object to check.
+ * @returns {boolean} True if the object is an array.
+ */
+export function isAnyArray(value: any): boolean;
+//# 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.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,kCAHW,GAAG,GACD,OAAO,CAInB"}

package/lib-esm/index.js

@@ -0,0 +1,11 @@
+const toString = Object.prototype.toString;
+/**
+ * Checks if an object is an instance of an Array (array or typed array).
+ *
+ * @param {any} value - Object to check.
+ * @returns {boolean} True if the object is an array.
+ */
+export function isAnyArray(value) {
+    return toString.call(value).endsWith('Array]');
+}
+//# sourceMappingURL=index.js.map

package/lib-esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"AAAA,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,KAAK;IAC9B,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACjD,CAAC"}

package/package.json

@@ -1,21 +1,29 @@
 {
   "name": "is-any-array",
-  "version": "0.1.0",
-  "description": "Check if toString.call ends with Array",
-  "main": "lib/index.js",
-  "module": "src/index.js",
+  "version": "2.0.0",
+  "description": "Check if a value is any kind of array",
+  "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",
-    "prepublishOnly": "rollup -c",
-    "test": "run-s testonly eslint",
-    "test-travis": "eslint src && jest --coverage && codecov",
-    "testonly": "jest",
-    "build": "cheminfo-build --entry src/index.js"
+    "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-coverage && npm run eslint && npm run check-types",
+    "test-coverage": "jest --coverage",
+    "test-only": "jest"
   },
   "repository": {
     "type": "git",
@@ -28,24 +36,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.8.3",
-    "cheminfo-build": "^1.0.7",
-    "cheminfo-tools": "^1.23.3",
-    "codecov": "^3.6.5",
-    "eslint": "^6.8.0",
-    "eslint-config-cheminfo": "^2.0.4",
-    "eslint-plugin-import": "^2.20.1",
-    "eslint-plugin-jest": "^23.8.0",
-    "eslint-plugin-prettier": "^3.1.2",
-    "jest": "^25.1.0",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^1.19.1"
-  },
-  "dependencies": {
-    "rollup": "^1.31.1"
+    "@types/jest": "^27.0.2",
+    "eslint": "^8.0.1",
+    "eslint-config-cheminfo-typescript": "^10.1.1",
+    "jest": "^27.2.5",
+    "prettier": "^2.4.1",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^27.0.6",
+    "typescript": "^4.4.4"
   }
 }

package/src/__tests__/test.js

@@ -1,4 +1,4 @@
-import isAnyArray from '..';
+import { isAnyArray } from '..';
 
 test('isArray', () => {
   expect(isAnyArray(1)).toBe(false);

package/src/index.js

@@ -1,5 +1,11 @@
 const toString = Object.prototype.toString;
 
-export default function isAnyArray(object) {
-  return toString.call(object).endsWith('Array]');
+/**
+ * Checks if an object is an instance of an Array (array or typed array).
+ *
+ * @param {any} value - Object to check.
+ * @returns {boolean} True if the object is an array.
+ */
+export function isAnyArray(value) {
+  return toString.call(value).endsWith('Array]');
 }

package/History.md

@@ -1,14 +0,0 @@
-# [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)
-
-
-