Lawtext core references / core/src/parser/std/rules/$noteLike
Module: core/src/parser/std/rules/$noteLike
Table of contents
Variables
Functions
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:141 (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:259 (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:131 (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:249 (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:136 (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:254 (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
| Name | Type |
|---|---|
FormatStruct | ":format-struct:" |
NoteStruct | ":note-struct:" |
StyleStruct | ":style-struct:" |
Defined in
core/src/parser/std/rules/$noteLike.ts:21 (opens in a new tab)
Functions
makeNoteLikeRule
▸ makeNoteLikeRule<TTag>(tag): WithErrorRule<StdELType<TTag>>
Type parameters
| Name | Type |
|---|---|
TTag | extends "Style" | "Note" | "Format" |
Parameters
| Name | Type |
|---|---|
tag | TTag |
Returns
WithErrorRule<StdELType<TTag>>
Defined in
core/src/parser/std/rules/$noteLike.ts:113 (opens in a new tab)
makeNoteLikeStructRule
▸ makeNoteLikeStructRule<TTag>(tag): WithErrorRule<StdELType<TTag>>
Type parameters
| Name | Type |
|---|---|
TTag | extends "StyleStruct" | "NoteStruct" | "FormatStruct" |
Parameters
| Name | Type |
|---|---|
tag | TTag |
Returns
WithErrorRule<StdELType<TTag>>
Defined in
core/src/parser/std/rules/$noteLike.ts:149 (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
| Name | Type |
|---|---|
noteLikeStruct | NoteLikeStruct |
indentTexts | string[] |
Returns
Line[]
Defined in
core/src/parser/std/rules/$noteLike.ts:64 (opens in a new tab)
noteLikeToLines
▸ noteLikeToLines(noteLike, indentTexts): Line[]
Parameters
| Name | Type |
|---|---|
noteLike | NoteLike |
indentTexts | string[] |
Returns
Line[]
Defined in
core/src/parser/std/rules/$noteLike.ts:27 (opens in a new tab)