tyneq

---

tyneq / ArgumentOutOfRangeError

Class: ArgumentOutOfRangeError

Defined in: src/core/errors/argument/ArgumentOutOfRangeError.ts:15

Thrown when an argument is outside the valid range.

Example

try { Tyneq.from([1, 2]).take(-1); }
catch (e) { if (e instanceof ArgumentOutOfRangeError) { console.log(e.actualValue); } }

See

ArgumentError

Extends

• ArgumentError

Constructors

Constructor

new ArgumentOutOfRangeError(paramName, message?, actualValue?, inner?): ArgumentOutOfRangeError

Defined in: src/core/errors/argument/ArgumentOutOfRangeError.ts:19

Parameters

Parameter	Type
paramName	string
message?	string
actualValue?	unknown
inner?	Error

Returns

ArgumentOutOfRangeError

Overrides

ArgumentError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
stackTraceLimit	static	number	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.	ArgumentError.stackTraceLimit	node_modules/@types/node/globals.d.ts:67
inner	public	Maybe<Error>	The underlying error that caused this error, if any.	ArgumentError.inner	src/core/errors/TyneqError.ts:17
paramName?	readonly	string	The name of the parameter that caused the error.	ArgumentError.paramName	src/core/errors/argument/ArgumentError.ts:17
actualValue?	readonly	unknown	The actual value that was out of range.	-	src/core/errors/argument/ArgumentOutOfRangeError.ts:17
name	public	string	-	ArgumentError.name	node_modules/typescript/lib/lib.es5.d.ts:1076
message	public	string	-	ArgumentError.message	node_modules/typescript/lib/lib.es5.d.ts:1077
stack?	public	string	-	ArgumentError.stack	node_modules/typescript/lib/lib.es5.d.ts:1078

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

ArgumentError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

ArgumentError.prepareStackTrace