Lawtext core references / core/src/parser/std/rules/$paragraphItem
Module: core/src/parser/std/rules/$paragraphItem
Table of contents
References
Variables
- $autoParagraphItem
- $autoParagraphItemChildrenOuter
- $noControlAnonymParagraph
- $requireControlParagraphItem
Functions
- $paragraphItem
- isAutoParagraphItem
- isAutoParagraphItemSentence
- isAutoParagraphItemTitle
- paragraphItemFromAuto
- paragraphItemToLines
References
default
Renames and re-exports $paragraphItem
Variables
$autoParagraphItem
• Const $autoParagraphItem: WithErrorRule<ParagraphItem | __AutoParagraphItem>
Defined in
core/src/parser/std/rules/$paragraphItem.ts:506 (opens in a new tab)
$autoParagraphItemChildrenOuter
• Const $autoParagraphItemChildrenOuter: WithErrorRule<(ParagraphItem["children"][number] | __AutoParagraphItem)[]>
Defined in
core/src/parser/std/rules/$paragraphItem.ts:356 (opens in a new tab)
$noControlAnonymParagraph
• Const $noControlAnonymParagraph: WithErrorRule<Paragraph>
Defined in
core/src/parser/std/rules/$paragraphItem.ts:656 (opens in a new tab)
$requireControlParagraphItem
• Const $requireControlParagraphItem: WithErrorRule<ParagraphItem>
Defined in
core/src/parser/std/rules/$paragraphItem.ts:619 (opens in a new tab)
Functions
$paragraphItem
▸ $paragraphItem(defautTag): WithErrorRule<ParagraphItem>
The parser rule for Paragraph, Item and subitem (ParagraphItem). Please see the source code for the detailed syntax, and the test code (opens in a new tab) for examples.
Parameters
| Name | Type |
|---|---|
defautTag | "Paragraph" | "Item" | "Subitem1" | "Subitem2" | "Subitem3" | "Subitem4" | "Subitem5" | "Subitem6" | "Subitem7" | "Subitem8" | "Subitem9" | "Subitem10" |
Returns
Defined in
core/src/parser/std/rules/$paragraphItem.ts:646 (opens in a new tab)
isAutoParagraphItem
▸ isAutoParagraphItem(el): el is __AutoParagraphItem
Parameters
| Name | Type |
|---|---|
el | string | EL |
Returns
el is __AutoParagraphItem
Defined in
core/src/parser/std/rules/$paragraphItem.ts:444 (opens in a new tab)
isAutoParagraphItemSentence
▸ isAutoParagraphItemSentence(el): el is __AutoParagraphItem
Parameters
| Name | Type |
|---|---|
el | string | EL |
Returns
el is __AutoParagraphItem
Defined in
core/src/parser/std/rules/$paragraphItem.ts:452 (opens in a new tab)
isAutoParagraphItemTitle
▸ isAutoParagraphItemTitle(el): el is __AutoParagraphItem
Parameters
| Name | Type |
|---|---|
el | string | EL |
Returns
el is __AutoParagraphItem
Defined in
core/src/parser/std/rules/$paragraphItem.ts:448 (opens in a new tab)
paragraphItemFromAuto
▸ paragraphItemFromAuto(defautTag, paragraphItem): ParagraphItem
Parameters
| Name | Type |
|---|---|
defautTag | "Paragraph" | "Item" | "Subitem1" | "Subitem2" | "Subitem3" | "Subitem4" | "Subitem5" | "Subitem6" | "Subitem7" | "Subitem8" | "Subitem9" | "Subitem10" |
paragraphItem | ParagraphItem | __AutoParagraphItem |
Returns
Defined in
core/src/parser/std/rules/$paragraphItem.ts:455 (opens in a new tab)
paragraphItemToLines
▸ paragraphItemToLines(el, indentTexts, options?): Line[]
The renderer for Paragraph, Item and subitem (ParagraphItem). Please see the source code for the detailed syntax, and the test code (opens in a new tab) for examples.
Parameters
| Name | Type |
|---|---|
el | ParagraphItem |
indentTexts | string[] |
options? | ParagraphItemToLinesOptions |
Returns
Line[]
Defined in
core/src/parser/std/rules/$paragraphItem.ts:40 (opens in a new tab)