Lawtext core references • Docs

Lawtext core references / core/src/parser/std/rules/$noteLike

core/src/parser/std/rules/$noteLike

Variables

$format

const $format: WithErrorRule<Format>

The parser rule for std.Format. Please see the source code for the detailed syntax, and the test code (opens in a new tab) for examples.

Defined in

core/src/parser/std/rules/$noteLike.ts:144 (opens in a new tab)

$formatStruct

const $formatStruct: WithErrorRule<FormatStruct>

The parser rule for std.FormatStruct. Please see the source code for the detailed syntax, and the test code (opens in a new tab) for examples.

Defined in

core/src/parser/std/rules/$noteLike.ts:262 (opens in a new tab)

$note

const $note: WithErrorRule<Note>

The parser rule for std.Note. Please see the source code for the detailed syntax, and the test code (opens in a new tab) for examples.

Defined in

core/src/parser/std/rules/$noteLike.ts:134 (opens in a new tab)

$noteStruct

const $noteStruct: WithErrorRule<NoteStruct>

The parser rule for std.NoteStruct. Please see the source code for the detailed syntax, and the test code (opens in a new tab) for examples.

Defined in

core/src/parser/std/rules/$noteLike.ts:252 (opens in a new tab)

$style

const $style: WithErrorRule<Style>

The parser rule for std.Style. Please see the source code for the detailed syntax, and the test code (opens in a new tab) for examples.

Defined in

core/src/parser/std/rules/$noteLike.ts:139 (opens in a new tab)

$styleStruct

const $styleStruct: WithErrorRule<StyleStruct>

The parser rule for std.StyleStruct. Please see the source code for the detailed syntax, and the test code (opens in a new tab) for examples.

Defined in

core/src/parser/std/rules/$noteLike.ts:257 (opens in a new tab)

noteLikeStructControl

const noteLikeStructControl: object

The renderer for note-like item (NoteLike). Please see the source code for the detailed syntax, and the test code (opens in a new tab) for examples.

Type declaration

FormatStruct

readonly FormatStruct: ":format-struct:" = ":format-struct:"

NoteStruct

readonly NoteStruct: ":note-struct:" = ":note-struct:"

StyleStruct

readonly StyleStruct: ":style-struct:" = ":style-struct:"

Defined in

core/src/parser/std/rules/$noteLike.ts:24 (opens in a new tab)

Functions

makeNoteLikeRule()

makeNoteLikeRule<TTag>(tag): WithErrorRule<StdELType<TTag>>

Type Parameters

• TTag extends "Style" | "Note" | "Format"

Parameters

• tag: TTag

Returns

WithErrorRule<StdELType<TTag>>

Defined in

core/src/parser/std/rules/$noteLike.ts:116 (opens in a new tab)

makeNoteLikeStructRule()

makeNoteLikeStructRule<TTag>(tag): WithErrorRule<StdELType<TTag>>

Type Parameters

• TTag extends "StyleStruct" | "NoteStruct" | "FormatStruct"

Parameters

• tag: TTag

Returns

WithErrorRule<StdELType<TTag>>

Defined in

core/src/parser/std/rules/$noteLike.ts:152 (opens in a new tab)

noteLikeStructToLines()

noteLikeStructToLines(noteLikeStruct, indentTexts): Line[]

The renderer for note-like struct item (NoteLikeStruct). Please see the source code for the detailed syntax, and the test code (opens in a new tab) for examples.

Parameters

• noteLikeStruct: NoteLikeStruct

• indentTexts: string[]

Returns

Line[]

Defined in

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

noteLikeToLines()

noteLikeToLines(noteLike, indentTexts): Line[]

Parameters

• noteLike: NoteLike

• indentTexts: string[]

Returns

Line[]

Defined in

core/src/parser/std/rules/$noteLike.ts:30 (opens in a new tab)