Skip to content

lib: remove ERR_INVALID_OPT_VALUE and ERR_INVALID_OPT_VALUE_ENCODING

Rodrigo Muino Tomonari requested to merge github/fork/lundibundi/remove-opt-errors into master

This will be a start to generalize all argument validation errors. As currently we throw ARG/OPT, OUT_OF_RANGE, and other more specific errors. The OPT errors didn't bring much to the errors as it's just another variant of ARG error which is sometimes more confusing (some of our code used OPT errors to denote just argument validation errors presumably because of similarity of OPT to 'option' and not 'options-object') and they don't specify the name of the options object where the invalid value is located. Much better approach would be to just specify path to the invalid value in the name of the value as it is done in this PR (i.e. 'options.format', 'options.publicKey.type' etc)

Also since this decreases a variety of errors we have it'd be easier to reuse validation code across the codebase.

Refs: https://github.com/nodejs/node/pull/31251 Refs: https://github.com/nodejs/node/pull/34070#discussion_r467251009 Signed-off-by: Denys Otrishko shishugi@gmail.com

Since this is a semver-major anyway I'm also considering integrating ERR_OUT_OF_RANGE into ERR_INVALID_ARG_VALUE.RangeError as I don't see much benefit of it having a separate error code since everything will be stated in the message anyways, wdyt?

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

/cc @nodejs/crypto @nodejs/buffer @nodejs/http2 as most affected systems /cc @jasnell @tniessen

Merge request reports