From 83e7c96eeda57d612edbdb0f21863aa6fb7a7ace Mon Sep 17 00:00:00 2001 From: reggi Date: Thu, 5 Sep 2024 14:20:26 -0400 Subject: [PATCH] add checkDevEngines to readme --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 2dd8c7f..ac854f3 100644 --- a/README.md +++ b/README.md @@ -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`. \ No newline at end of file