Lawtext core references

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

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

Variables

$format

const $format: WithErrorRule<Format>

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

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.

$formatStruct

const $formatStruct: WithErrorRule<FormatStruct>

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

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.

$note

const $note: WithErrorRule<Note>

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

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.

$noteStruct

const $noteStruct: WithErrorRule<NoteStruct>

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

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.

$style

const $style: WithErrorRule<Style>

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

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.

$styleStruct

const $styleStruct: WithErrorRule<StyleStruct>

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

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.

noteLikeStructControl

const noteLikeStructControl: object

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

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:"

Functions

makeNoteLikeRule()

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

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

Type Parameters

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

Parameters

tag

TTag

Returns

WithErrorRule<StdELType<TTag>>

makeNoteLikeStructRule()

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

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

Type Parameters

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

Parameters

tag

TTag

Returns

WithErrorRule<StdELType<TTag>>

noteLikeStructToLines()

noteLikeStructToLines(noteLikeStruct, indentTexts): Line[]

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

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

noteLikeToLines()

noteLikeToLines(noteLike, indentTexts): Line[]

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

Parameters

noteLike

indentTexts

string[]

Returns