Skip to main content

Class: BreakIteration

An error thrown to indicate a Liquid for loop should be broken.

Extends​

Constructors​

new BreakIteration()​

new BreakIteration(message): BreakIteration

Parameters​

• message: string

Returns​

BreakIteration

Overrides​

LiquidInterrupt.constructor

Defined in​

src/errors.ts:591

Properties​

cause?​

optional cause: unknown

Inherited from​

LiquidInterrupt.cause

Defined in​

docs/node_modules/typescript/lib/lib.es2022.error.d.ts:24

message​

message: string

Inherited from​

LiquidInterrupt.message

Defined in​

src/errors.ts:591

name​

name: string

Inherited from​

LiquidInterrupt.name

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1076

stack?​

optional stack: string

Inherited from​

LiquidInterrupt.stack

Defined in​

docs/node_modules/typescript/lib/lib.es5.d.ts:1078

prepareStackTrace()?​

static optional prepareStackTrace: (err, stackTraces) => any

Optional override for formatting stack traces

Parameters​

• err: Error

• stackTraces: CallSite[]

Returns​

any

See​

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

Inherited from​

LiquidInterrupt.prepareStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:28

stackTraceLimit​

static stackTraceLimit: number

Inherited from​

LiquidInterrupt.stackTraceLimit

Defined in​

node_modules/@types/node/globals.d.ts:30

Methods​

withToken()​

withToken(token, templateName?): LiquidError

Parameters​

• token: Token

• templateName?: string

Returns​

LiquidError

Defined in​

src/errors.ts:596

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters​

• targetObject: object

• constructorOpt?: Function

Returns​

void

Inherited from​

LiquidInterrupt.captureStackTrace

Defined in​

node_modules/@types/node/globals.d.ts:21