Skip to content

Commit 4817449

Browse files
UlisesGasconRafaelGSS
authored andcommitted
docs: added reference to platform argument
1 parent 80ea77d commit 4817449

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,14 @@ const { isNodeVulnerable } = require('is-my-node-vulnerable')
7979
isNodeVulnerable('19.0.0') // true
8080
```
8181

82+
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()`.
83+
84+
```js
85+
const { isNodeVulnerable } = require('is-my-node-vulnerable')
86+
87+
isNodeVulnerable('19.0.0', 'linux') // true
88+
```
89+
8290
[Node.js Security Database]: https://github.com/nodejs/security-wg/tree/main/vuln
8391

8492

@@ -101,4 +109,15 @@ jobs:
101109
uses: RafaelGSS/[email protected]
102110
with:
103111
node-version: "18.14.1"
112+
```
113+
114+
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()`.
115+
116+
```yml
117+
- uses: actions/checkout@v3
118+
- name: Check Node.js
119+
uses: RafaelGSS/[email protected]
120+
with:
121+
node-version: "18.14.1"
122+
platform: "linux"
104123
```

0 commit comments

Comments
 (0)