Type Editor

---

Type Editor / @type-editor/model / replace / ReplaceError

Class: ReplaceError

Defined in: packages/model/src/replace.ts:29

Error type raised by Node.replace when given an invalid replacement.

This error is thrown when:

• The slice's open depth is deeper than the insertion position
• The open depths are inconsistent between start and end positions
• Attempting to join incompatible node types
• The range to remove or replace is not "flat" (spans incompatible node boundaries)

Example

try {
  node.replace(from, to, slice);
} catch (error) {
  if (error instanceof ReplaceError) {
    console.error("Invalid replacement:", error.message);
  }
}

Extends

• Error

Constructors

Constructor

new ReplaceError(message?): ReplaceError;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

Parameter	Type
message?	string

Returns

ReplaceError

Inherited from

Error.constructor;

Constructor

new ReplaceError(message?, options?): ReplaceError;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

Parameter	Type
message?	string
options?	ErrorOptions

Returns

ReplaceError

Inherited from

Error.constructor;

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
cause?	public	unknown	-	Error.cause	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26
message	public	string	-	Error.message	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077
name	public	string	-	Error.name	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076
stack?	public	string	-	Error.stack	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078
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.	Error.stackTraceLimit	node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:67

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Error.captureStackTrace;

---

isError()

static isError(error): error is Error;

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

Parameter	Type
error	unknown

Returns

error is Error

Inherited from

Error.isError;

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/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

Error.prepareStackTrace;