UnreachableCodeError
Represents an error that occurs when unreachable code is executed. This error always indicates a bug in the Tevm VM.
Unreachable code errors can occur due to:
- Defensive programming checks to ensure all cases in a switch or if statement are covered.
To handle this error take the following steps:
- ensure you did not modify the tevm VM in any unsupported way.
- Open an issue with a minimal reproducable example
Example
import { UnreachableCodeError } from '@tevm/errors'
const x: 'a' | 'b' = 'a'
if (x === 'a') { console.log('A')} else if (x === 'b') { console.log('B')} else { throw new UnreachableCodeError(x, 'Unreachable code executed.')}
Param
The value that should be of type never.
Param
A human-readable error message.
Param
Additional parameters for the BaseError.
Extends
Constructors
new UnreachableCodeError()
new UnreachableCodeError(
value
,message
?,args
?,tag
?):UnreachableCodeError
Constructs an UnreachableCodeError.
Parameters
• value: never
The value that should be of type never.
• message?: string
= ...
Human-readable error message.
• args?: UnreachableCodeErrorParameters
= {}
Additional parameters for the BaseError.
• tag?: string
= 'UnreachableCodeError'
The tag for the error.
Returns
Overrides
Defined in
packages/errors/src/defensive/UnreachableCodeError.js:60
Properties
_tag
_tag:
string
Same as name, used internally.
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:81
cause
cause:
any
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:113
code
code:
number
Error code, analogous to the code in JSON RPC error.
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:111
details
details:
string
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:90
docsPath
docsPath:
undefined
|string
Path to the documentation for this error.
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:95
message
message:
string
Human-readable error message.
Inherited from
Defined in
node_modules/.pnpm/typescript@5.5.2/node_modules/typescript/lib/lib.es5.d.ts:1077
meta
meta:
undefined
|object
Optional object containing additional information about the error.
Inherited from
Defined in
packages/errors/src/ethereum/InternalErrorError.js:64
metaMessages
metaMessages:
undefined
|string
[]
Additional meta messages for more context.
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:99
name
name:
string
The name of the error, used to discriminate errors.
Inherited from
Defined in
node_modules/.pnpm/typescript@5.5.2/node_modules/typescript/lib/lib.es5.d.ts:1076
shortMessage
shortMessage:
string
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:103
stack?
optional
stack:string
Inherited from
Defined in
node_modules/.pnpm/typescript@5.5.2/node_modules/typescript/lib/lib.es5.d.ts:1078
version
version:
string
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:107
prepareStackTrace()?
static
optional
prepareStackTrace: (err
,stackTraces
) =>any
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
• err: Error
• stackTraces: CallSite
[]
Returns
any
Inherited from
InternalError
.prepareStackTrace
Defined in
node_modules/.pnpm/@types+node@20.14.8/node_modules/@types/node/globals.d.ts:28
stackTraceLimit
static
stackTraceLimit:number
Inherited from
Defined in
node_modules/.pnpm/@types+node@20.14.8/node_modules/@types/node/globals.d.ts:30
Methods
walk()
walk(
fn
?):unknown
Walks through the error chain.
Parameters
• fn?: Function
A function to execute on each error in the chain.
Returns
unknown
The first error that matches the function, or the original error.
Inherited from
Defined in
packages/errors/src/ethereum/BaseError.js:136
captureStackTrace()
captureStackTrace(targetObject, constructorOpt)
static
captureStackTrace(targetObject
,constructorOpt
?):void
Create .stack property on a target object
Parameters
• targetObject: object
• constructorOpt?: Function
Returns
void
Inherited from
InternalError
.captureStackTrace
Defined in
node_modules/.pnpm/@types+node@20.14.8/node_modules/@types/node/globals.d.ts:21
captureStackTrace(targetObject, constructorOpt)
static
captureStackTrace(targetObject
,constructorOpt
?):void
Create .stack property on a target object
Parameters
• targetObject: object
• constructorOpt?: Function
Returns
void
Inherited from
InternalError
.captureStackTrace
Defined in
node_modules/.pnpm/@types+node@22.1.0/node_modules/@types/node/globals.d.ts:22
captureStackTrace(targetObject, constructorOpt)
static
captureStackTrace(targetObject
,constructorOpt
?):void
Create .stack property on a target object
Parameters
• targetObject: object
• constructorOpt?: Function
Returns
void
Inherited from
InternalError
.captureStackTrace
Defined in
node_modules/.pnpm/bun-types@1.1.18/node_modules/bun-types/globals.d.ts:1613
captureStackTrace(targetObject, constructorOpt)
static
captureStackTrace(targetObject
,constructorOpt
?):void
Create .stack property on a target object
Parameters
• targetObject: object
• constructorOpt?: Function
Returns
void
Inherited from
InternalError
.captureStackTrace
Defined in
node_modules/.pnpm/@types+node@20.12.14/node_modules/@types/node/globals.d.ts:21