Class: IOError

Defined in: src/errors.ts:156

Raised when reading from or writing to storage fails (code IO_ERROR).

Extends

• NeuroimError

Constructors

Constructor

new IOError(message, options?): IOError;

Defined in: src/errors.ts:157

Parameters

message

string

options?

NeuroimErrorOptions = {}

Returns

IOError

Overrides

NeuroimError.constructor

Properties

stackTraceLimit

static stackTraceLimit: 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

NeuroimError.stackTraceLimit

---

code

readonly code: NeuroimErrorCode;

Defined in: src/errors.ts:70

Stable, machine-readable error code.

Inherited from

NeuroimError.code

---

details?

readonly optional details?: Readonly<Record<string, unknown>>;

Defined in: src/errors.ts:72

Structured context for programmatic handling, if any.

Inherited from

NeuroimError.details

---

cause?

readonly optional cause?: unknown;

Defined in: src/errors.ts:74

The underlying error, if this error wraps another.

Inherited from

NeuroimError.cause

---

name

name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

NeuroimError.name

---

message

message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

NeuroimError.message

---

stack?

optional stack?: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

NeuroimError.stack

Methods

captureStackTrace()

static captureStackTrace(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

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

NeuroimError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

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

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

NeuroimError.prepareStackTrace