Skip to content

Commit

Permalink
fix: update readme and dependencies
Browse files Browse the repository at this point in the history
Release-as: v1.0.0
  • Loading branch information
targos committed Mar 24, 2021
1 parent cd099b0 commit 7ae8169
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 25 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Expand Up @@ -31,7 +31,7 @@ jobs:
if: ${{ steps.release.outputs.release_created }}
- run: npm install
if: ${{ steps.release.outputs.release_created }}
- run: npm publish --access public
- run: npm publish --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_BOT_TOKEN }}
if: ${{ steps.release.outputs.release_created }}
22 changes: 9 additions & 13 deletions README.md
Expand Up @@ -5,36 +5,32 @@
[![Test coverage][codecov-image]][codecov-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');

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
[build-image]: https://github.com/cheminfo/is-any-array/workflows/Node.js%20CI/badge.svg
[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
[codecov-image]: https://img.shields.io/codecov/c/github/cheminfo/is-any-array.svg?style=flat-square
[codecov-url]: https://codecov.io/gh/cheminfo/is-any-array
[download-image]: https://img.shields.io/npm/dm/is-any-array.svg?style=flat-square
[download-image]: https://img.shields.io/npm/dm/is-any-array.svg
[download-url]: https://www.npmjs.com/package/is-any-array
18 changes: 7 additions & 11 deletions package.json
@@ -1,7 +1,7 @@
{
"name": "is-any-array",
"version": "0.1.1",
"description": "Check if toString.call ends with Array",
"description": "Check if a value is any kind of array",
"main": "lib/index.js",
"module": "src/index.js",
"files": [
Expand All @@ -12,10 +12,9 @@
"eslint": "eslint src",
"eslint-fix": "npm run eslint -- --fix",
"prepublishOnly": "rollup -c",
"test": "run-s testonly eslint",
"testonly": "jest",
"test": "npm run test-coverage && npm run eslint",
"test-coverage": "jest --coverage",
"build": "cheminfo-build --entry src/index.js"
"test-only": "jest"
},
"repository": {
"type": "git",
Expand All @@ -32,14 +31,11 @@
"testEnvironment": "node"
},
"devDependencies": {
"@babel/plugin-transform-modules-commonjs": "^7.12.13",
"cheminfo-build": "^1.1.9",
"eslint": "^7.19.0",
"eslint-config-cheminfo": "^5.2.2",
"eslint-plugin-jest": "^24.1.3",
"@babel/plugin-transform-modules-commonjs": "^7.13.8",
"eslint": "^7.22.0",
"eslint-config-cheminfo": "^5.2.3",
"jest": "^26.6.3",
"npm-run-all": "^4.1.5",
"prettier": "^2.2.1",
"rollup": "^2.38.5"
"rollup": "^2.42.3"
}
}

0 comments on commit 7ae8169

Please sign in to comment.