Library
core
src
parser
std
util
Readme

Lawtext core referencesDocs


Lawtext core references / core/src/parser/std/util

core/src/parser/std/util

Type Aliases

ValueRule<TValue>

ValueRule<TValue>: Rule<VirtualLine[], TValue, Env, Empty>

Type Parameters

TValue

Defined in

core/src/parser/std/util.ts:12 (opens in a new tab)


WithErrorRule<TValue>

WithErrorRule<TValue>: Rule<VirtualLine[], WithErrorValue<TValue>, Env, Empty>

Type Parameters

TValue

Defined in

core/src/parser/std/util.ts:14 (opens in a new tab)


WithErrorValue<TValue>

WithErrorValue<TValue>: object

Type Parameters

TValue

Type declaration

errors

errors: ErrorMessage[]

value

value: TValue

Defined in

core/src/parser/std/util.ts:13 (opens in a new tab)

Variables

$DEDENT

const $DEDENT: ValueRule<Dedent>

Defined in

core/src/parser/std/util.ts:28 (opens in a new tab)


$INDENT

const $INDENT: ValueRule<Indent>

Defined in

core/src/parser/std/util.ts:16 (opens in a new tab)


$blankLine

const $blankLine: Rule<VirtualLine[], object, Env, Empty>

Defined in

core/src/parser/std/util.ts:40 (opens in a new tab)


$indentBlock

const $indentBlock: ValueRule<VirtualLine[]>

Defined in

core/src/parser/std/util.ts:44 (opens in a new tab)


$optBNK_DEDENT

const $optBNK_DEDENT: ValueRule<[...PhysicalLine[], Dedent]>

Defined in

core/src/parser/std/util.ts:32 (opens in a new tab)


$optBNK_INDENT

const $optBNK_INDENT: ValueRule<[...PhysicalLine[], Indent]>

Defined in

core/src/parser/std/util.ts:20 (opens in a new tab)


captionControl

const captionControl: ":caption:" = ":caption:"

Defined in

core/src/parser/std/util.ts:231 (opens in a new tab)

Functions

isSingleParentheses()

isSingleParentheses(line): null | __Parentheses

Parameters

line: SentencesArray | VirtualLine | Line

Returns

null | __Parentheses

Defined in

core/src/parser/std/util.ts:233 (opens in a new tab)


makeDoubleIndentBlockWithCaptureRule()

makeDoubleIndentBlockWithCaptureRule<TValue>(ruleName, ruleRepeatedOneOrMore): Rule<VirtualLine[], WithErrorValue<TValue[]>, Env, Omit<Env & Omit<Env & Empty & object & object, keyof Env>, keyof Env>>

Type Parameters

TValue

Parameters

ruleName: string

ruleRepeatedOneOrMore: Rule<VirtualLine[], TValue, Env, Empty>

Returns

Rule<VirtualLine[], WithErrorValue<TValue[]>, Env, Omit<Env & Omit<Env & Empty & object & object, keyof Env>, keyof Env>>

Defined in

core/src/parser/std/util.ts:141 (opens in a new tab)


makeIndentBlockWithCaptureRule()

makeIndentBlockWithCaptureRule<TValue>(ruleName, ruleRepeatedOneOrMore): Rule<VirtualLine[], WithErrorValue<TValue[]>, Env, Omit<Env & Omit<Env & Empty & object, keyof Env>, keyof Env>>

Type Parameters

TValue

Parameters

ruleName: string

ruleRepeatedOneOrMore: Rule<VirtualLine[], TValue, Env, Empty>

Returns

Rule<VirtualLine[], WithErrorValue<TValue[]>, Env, Omit<Env & Omit<Env & Empty & object, keyof Env>, keyof Env>>

Defined in

core/src/parser/std/util.ts:67 (opens in a new tab)