OptionsError
Defined in: src/util/OptionsValidator.ts:40
An option value that is well-typed but outside its domain — regardless
of whether it arrived via the builder, a plain object, or HOCON.
(Missing required broker options keep throwing BrokerOptionsError;
malformed HOCON keeps throwing ConfigError — this error is only for
domain validity of present values.)
Extends
Section titled “Extends”Error
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OptionsError(
message,options,field,value?):OptionsError
Defined in: src/util/OptionsValidator.ts:41
Parameters
Section titled “Parameters”message
Section titled “message”string
options
Section titled “options”string
Options family the value belongs to, e.g. 'MqttOptions'.
string
Offending field (dotted path for nested fields).
value?
Section titled “value?”unknown
The rejected value.
Returns
Section titled “Returns”OptionsError
Overrides
Section titled “Overrides”Error.constructor
Properties
Section titled “Properties”cause?
Section titled “cause?”
optionalcause?:unknown
Defined in: docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Section titled “Inherited from”Error.cause
readonlyfield:string
Defined in: src/util/OptionsValidator.ts:46
Offending field (dotted path for nested fields).
message
Section titled “message”message:
string
Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Section titled “Inherited from”Error.message
name:
string
Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Section titled “Inherited from”Error.name
options
Section titled “options”
readonlyoptions:string
Defined in: src/util/OptionsValidator.ts:44
Options family the value belongs to, e.g. 'MqttOptions'.
stack?
Section titled “stack?”
optionalstack?:string
Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Section titled “Inherited from”Error.stack
value?
Section titled “value?”
readonlyoptionalvalue?:unknown
Defined in: src/util/OptionsValidator.ts:48
The rejected value.
stackTraceLimit
Section titled “stackTraceLimit”
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Section titled “Inherited from”Error.stackTraceLimit
Methods
Section titled “Methods”captureStackTrace()
Section titled “captureStackTrace()”
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};Error.captureStackTrace(myObject);myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() { b();}
function b() { c();}
function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error;}
a();Parameters
Section titled “Parameters”targetObject
Section titled “targetObject”object
constructorOpt?
Section titled “constructorOpt?”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Error.captureStackTrace
prepareStackTrace()
Section titled “prepareStackTrace()”
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/@types/node/globals.d.ts:56
Parameters
Section titled “Parameters”Error
stackTraces
Section titled “stackTraces”CallSite[]
Returns
Section titled “Returns”any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Section titled “Inherited from”Error.prepareStackTrace
renderValue()
Section titled “renderValue()”
staticrenderValue(value):string
Defined in: src/util/OptionsValidator.ts:82
Render a rejected value for the (got …) tail of a message.
A static on the error rather than a second module export, so every site
that builds one of these — OptionsValidator.fail, and the two
written-out guards that have no validator to belong to
(ActorRef.ask’s assertAskTimeout, Behaviors.withStash’s
assertStashCapacity) — spells a value the same way. They did not: the
validator quoted strings and the two guards used a bare String, so
withStash('10') reported got 10 and told a JavaScript caller their
10 had been rejected for not being an integer. That is precisely the
arrival path the guards’ comments say the Number.isInteger /
Number.isFinite checks exist to catch, so the diagnostic that reports it
has to be the one that survives it.
Numbers go through String and everything else through
safeStringify, and the split is the whole rule. String is right
for a number and only for a number: it is the only renderer that keeps
NaN and Infinity legible, both of which JSON.stringify flattens to
null — and those two are the values these guards exist for. For
everything else String is what loses the diagnostic: a string arrives
indistinguishable from the number it looks like, and String([]) is the
empty string, so an array capacity reported as got named nothing at
all. safeStringify rather than JSON.stringify because this runs on a
path that is already failing — a circular object or a BigInt must not
replace the error being reported with one thrown from inside the
reporting.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”string
