Skip to content

Commit

Permalink
add checkDevEngines to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
reggi committed Sep 5, 2024
1 parent 38d2f39 commit 83e7c96
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,10 @@ Check if a package's `os`, `cpu` and `libc` match the running system.
`environment` overrides the execution environment which comes from `process.platform` `process.arch` and current `libc` environment by default. `environment.os` `environment.cpu` and `environment.libc` are available.

Error code: 'EBADPLATFORM'


### .checkDevEngines(wanted, current, opts)

Check if a package's `devEngines` property matches the current system environment.

Returns an array of `Error` objects, some of which may be warnings, this can be checked with `.isError` and `.isWarn`. Errors correspond to an error for a given "engine" failure, reasons for each engine "dependency" failure can be found within `.errors`.

0 comments on commit 83e7c96

Please sign in to comment.