Skip to content

Commit

Permalink
docs: added reference to platform argument
Browse files Browse the repository at this point in the history
  • Loading branch information
UlisesGascon authored and RafaelGSS committed Mar 21, 2023
1 parent 80ea77d commit 4817449
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@ const { isNodeVulnerable } = require('is-my-node-vulnerable')
isNodeVulnerable('19.0.0') // true
```

Optionally you can define the platform with the argument `platform` to limit the scope. The available platforms are [the same values](https://nodejs.org/api/os.html#osplatform) available in for `os.platform()`.

```js
const { isNodeVulnerable } = require('is-my-node-vulnerable')

isNodeVulnerable('19.0.0', 'linux') // true
```

[Node.js Security Database]: https://github.com/nodejs/security-wg/tree/main/vuln


Expand All @@ -101,4 +109,15 @@ jobs:
uses: RafaelGSS/[email protected]
with:
node-version: "18.14.1"
```
Optionally you can define the platform with the argument `platform` to limit the scope. The available platforms are [the same values](https://nodejs.org/api/os.html#osplatform) available in for `os.platform()`.

```yml
- uses: actions/checkout@v3
- name: Check Node.js
uses: RafaelGSS/[email protected]
with:
node-version: "18.14.1"
platform: "linux"
```

0 comments on commit 4817449

Please sign in to comment.