-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: added reference to platform argument
- Loading branch information
1 parent
80ea77d
commit 4817449
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
|
||
|
@@ -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" | ||
``` |