Note This repository is automatically generated from the main parser monorepo. Please submit any issues or pull requests there.

jast-jast-util-to-texast

Utility to convert a jast tree to a texast tree.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
• Syntax tree
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

When should I use this?

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as

pnpm add jast-util-to-texast
# or with yarn
# yarn add jast-util-to-texast
# or with npm
# npm install jast-util-to-texast

Use

API

all()

Convert all nodes in tree using j

Signature

all(j: J, parent: Node): TexastContent[];

Parameters

| Name | Type | Description | | :------ | :------ | :------ | | j | J | jast constructor function | | parent | Node | |

Returns

TexastContent[]

Defined in: src/lib/all.ts:10

one()

Signature

one(j: J, node: Node, parent: Parent): TexastContent | TexastContent[] | void;

Parameters

| Name | Type | | :------ | :------ | | j | J | | node | Node | | parent | Parent |

Returns

TexastContent | TexastContent[] | void

Defined in: src/lib/one.ts:7

toTexast()

Signature

toTexast(tree: TexastContent | TexastRoot, options: Options = ...): TexastContent | TexastRoot;

Parameters

| Name | Type | | :------ | :------ | | tree | TexastContent | TexastRoot | | options | Options |

Returns

TexastContent | TexastRoot

Defined in: src/lib/jast-util-to-texast.ts:24

defaultHandlers

Const object

{
    abbrev: () => void;
    abbrevJournaltitle: () => void;
    abstract: () => void;
    accessDate: () => void;
    ack: () => void;
    addrLine: () => void;
    address: () => void;
    aff: () => void;
    affAlternatives: () => void;
    altText: () => void;
    altTitle: () => void;
    alternatives: () => void;
    annotation: () => void;
    anonymous: () => void;
    answer: () => void;
    answerSet: () => void;
    app: () => void;
    appGroup: () => void;
    array: () => void;
    article: (j: J, node: Root) => TexastContent;
    articleCategories: () => void;
    articleId: () => void;
    articleMeta: () => void;
    articleTitle: (j: J, node: Parents, parent: Parent) => TexastContent;
    articleVersion: () => void;
    articleVersionalternatives: () => void;
    attrib: () => void;
    authorComment: () => void;
    authorNotes: () => void;
    awardDesc: () => void;
    awardGroup: () => void;
    awardId: () => void;
    awardName: () => void;
    back: (j: J, parent: Node) => TexastContent[];
    bio: () => void;
    blockAlternatives: () => void;
    body: (j: J, node: Root) => TexastContent;
    bold: (j: J, node: Parents, parent: Parent) => TexastContent;
    boxedText: () => void;
    break: () => void;
    caption: (j: J, node: Parents, parent: Parent) => TexastContent;
    chapterTitle: () => void;
    chemStruct: () => void;
    chemStructwrap: () => void;
    citationAlternatives: () => void;
    city: () => void;
    code: () => void;
    col: () => void;
    colgroup: () => void;
    collab: () => void;
    collabAlternatives: () => void;
    command: (j: J, node: Parents, parent: Parent) => TexastContent;
    comment: () => void;
    compoundKwd: () => void;
    compoundKwdpart: () => void;
    compoundSubject: () => void;
    compoundSubjectpart: () => void;
    confAcronym: () => void;
    confDate: () => void;
    confLoc: () => void;
    confName: () => void;
    confNum: () => void;
    confSponsor: () => void;
    confTheme: () => void;
    conference: () => void;
    contrib: () => void;
    contribGroup: (j: J, node: Node) => TexastContent[];
    contribId: () => void;
    contributedResourcegroup: () => void;
    copyrightHolder: () => void;
    copyrightStatement: () => void;
    copyrightYear: () => void;
    corresp: () => void;
    count: () => void;
    country: () => void;
    counts: () => void;
    customMeta: () => void;
    customMetagroup: () => void;
    dataTitle: () => void;
    date: () => void;
    dateIncitation: () => void;
    day: () => void;
    def: () => void;
    defHead: () => void;
    defItem: () => void;
    defList: () => void;
    degrees: () => void;
    disp-quote: (j: J, node: DispQuote) => Environment;
    dispFormula: () => void;
    dispFormulagroup: () => void;
    dispQuote: () => void;
    edition: () => void;
    elementCitation: () => void;
    elocationId: () => void;
    email: () => void;
    equationCount: () => void;
    era: () => void;
    etal: () => void;
    event: () => void;
    eventDesc: () => void;
    explanation: () => void;
    extLink: (j: J, node: ExtLink) => {
        children: CommandArg[];
        name: string;
        type: string;
    };
    extendedBy: () => void;
    fax: () => void;
    fig: (j: J, fig: Fig) => {
        children: TexastContent[];
        name: string;
        type: string;
    };
    figCount: () => void;
    figGroup: () => void;
    fixedCase: () => void;
    floatsGroup: () => void;
    fn: (j: J, parent: Node) => TexastContent[];
    fnGroup: (j: J, parent: Node) => TexastContent[];
    fpage: () => void;
    front: (j: J, node: Root) => TexastContent;
    frontStub: () => void;
    fundingGroup: () => void;
    fundingSource: () => void;
    fundingStatement: () => void;
    givenNames: () => void;
    glossary: () => void;
    glyphData: () => void;
    glyphRef: () => void;
    gov: () => void;
    graphic: (j: J, node: Graphic) => {
        children: (CommandArg | {
            type: string;
            value: string;
        })[];
        name: string;
        type: string;
    };
    history: () => void;
    hr: () => void;
    indexTerm: () => void;
    indexTermrangeend: () => void;
    inlineFormula: () => void;
    inlineGraphic: (j: J, node: Graphic) => {
        children: (CommandArg | {
            type: string;
            value: string;
        })[];
        name: string;
        type: string;
    };
    inlineMedia: () => void;
    inlineSupplementarymaterial: () => void;
    institution: () => void;
    institutionId: () => void;
    institutionWrap: () => void;
    instruction: () => void;
    isbn: () => void;
    issn: () => void;
    issnL: () => void;
    issue: () => void;
    issueId: () => void;
    issuePart: () => void;
    issueSponsor: () => void;
    issueSubtitle: () => void;
    issueTitle: () => void;
    issueTitlegroup: (j: J, node: Node) => TexastContent[];
    italic: (j: J, node: Node) => TexastContent;
    journalId: () => void;
    journalMeta: () => void;
    journalSubtitle: () => void;
    journalTitle: (j: J, node: Parents, parent: Parent) => TexastContent;
    journalTitlegroup: (j: J, node: Node) => TexastContent[];
    kwd: () => void;
    kwdGroup: () => void;
    label: (j: J, node: Parents, parent: Parent) => TexastContent;
    license: () => void;
    licenseP: () => void;
    list: (j: J, list: List) => {
        children: TexastContent[];
        name: string;
        type: string;
    };
    listItem: (j: J, item: ListItem) => TexastContent;
    longDesc: () => void;
    lpage: () => void;
    media: () => void;
    metaName: () => void;
    metaValue: () => void;
    milestoneEnd: () => void;
    milestoneStart: () => void;
    mixedCitation: () => void;
    monospace: () => void;
    month: () => void;
    name: () => void;
    nameAlternatives: () => void;
    namedContent: () => void;
    nestedKwd: () => void;
    nlmCitation: () => void;
    note: () => void;
    notes: () => void;
    objectId: () => void;
    onBehalfof: () => void;
    openAccess: () => void;
    option: () => void;
    overline: () => void;
    overlineEnd: () => void;
    overlineStart: () => void;
    p: (j: J, p: P) => TexastContent;
    pageCount: () => void;
    pageRange: () => void;
    partTitle: () => void;
    patent: () => void;
    permissions: () => void;
    personGroup: () => void;
    phone: () => void;
    postalCode: () => void;
    prefix: () => void;
    preformat: () => void;
    price: () => void;
    principalAwardrecipient: () => void;
    principalInvestigator: () => void;
    privateChar: () => void;
    processingMeta: () => void;
    product: () => void;
    pubDate: () => void;
    pubDatenotavailable: () => void;
    pubHistory: () => void;
    pubId: () => void;
    publisher: () => void;
    publisherLoc: () => void;
    publisherName: () => void;
    question: () => void;
    questionPreamble: () => void;
    questionWrap: () => void;
    questionWrapgroup: () => void;
    rb: () => void;
    ref: () => void;
    refCount: () => void;
    refList: (j: J, list: RefList) => Environment | undefined;
    relatedArticle: () => void;
    relatedObject: () => void;
    resourceId: () => void;
    resourceName: () => void;
    resourceWrap: () => void;
    response: () => void;
    restrictedBy: () => void;
    role: () => void;
    roman: () => void;
    root: (j: J, node: Root) => TexastContent;
    rp: () => void;
    rt: () => void;
    ruby: () => void;
    sansSerif: (j: J, node: Parents, parent: Parent) => TexastContent;
    sc: (j: J, node: Parents, parent: Parent) => TexastContent;
    season: () => void;
    sec: (j: J, node: Parents) => TexastContent[];
    secMeta: () => void;
    see: () => void;
    seeAlso: () => void;
    selfUri: () => void;
    series: () => void;
    seriesText: () => void;
    seriesTitle: () => void;
    sig: () => void;
    sigBlock: () => void;
    size: () => void;
    source: () => void;
    speaker: () => void;
    speech: () => void;
    state: () => void;
    statement: () => void;
    std: () => void;
    stdOrganization: () => void;
    strike: () => void;
    stringConf: () => void;
    stringDate: () => void;
    stringName: () => void;
    styledContent: () => void;
    sub: (j: J, node: Node) => TexastContent;
    subArticle: () => void;
    subjGroup: () => void;
    subject: () => void;
    subtitle: () => void;
    suffix: () => void;
    sup: (j: J, node: Node) => TexastContent;
    supplement: () => void;
    supplementaryMaterial: () => void;
    supportDescription: () => void;
    supportGroup: () => void;
    supportSource: () => void;
    surname: () => void;
    table: (j: J, table: Table) => {
        children: TexastContent[];
        name: string;
        type: string;
    };
    tableCount: () => void;
    tableWrap: (j: J, node: TableWrap) => TexastContent;
    tableWrapfoot: () => void;
    tableWrapgroup: () => void;
    target: () => void;
    tbody: (j: J, parent: Node) => TexastContent[];
    td: (j: J, node: Td) => TableCell;
    term: () => void;
    termHead: () => void;
    texMath: () => void;
    text: (j: J, node: Text) => TexastContent;
    textualForm: () => void;
    tfoot: () => void;
    th: () => void;
    thead: () => void;
    timeStamp: () => void;
    title: (j: J, parent: Node) => TexastContent[];
    titleGroup: (j: J, node: Node) => TexastContent[];
    tr: (j: J, node: Tr) => TexastContent;
    transAbstract: () => void;
    transSource: () => void;
    transSubtitle: () => void;
    transTitle: (j: J, node: Parents, parent: Parent) => TexastContent;
    transTitlegroup: (j: J, node: Node) => TexastContent[];
    underline: () => void;
    underlineEnd: () => void;
    underlineStart: () => void;
    unstructuredKwdgroup: () => void;
    uri: () => void;
    verseGroup: () => void;
    verseLine: () => void;
    version: () => void;
    volume: (j: J, node: Parents, parent: Parent) => TexastContent;
    volumeId: () => void;
    volumeIssuegroup: () => void;
    volumeSeries: (j: J, node: Parents, parent: Parent) => TexastContent;
    wordCount: () => void;
    x: () => void;
    xml: () => void;
    xref: (j: J, node: Xref) => TexastContent;
    year: () => void;
}

Type declaration

| Member | Type | | :------ | :------ | | abbrev | () => void | | abbrevJournaltitle | () => void | | abstract | () => void | | accessDate | () => void | | ack | () => void | | addrLine | () => void | | address | () => void | | aff | () => void | | affAlternatives | () => void | | altText | () => void | | altTitle | () => void | | alternatives | () => void | | annotation | () => void | | anonymous | () => void | | answer | () => void | | answerSet | () => void | | app | () => void | | appGroup | () => void | | array | () => void | | article | (j: J, node: Root) => TexastContent | | articleCategories | () => void | | articleId | () => void | | articleMeta | () => void | | articleTitle | (j: J, node: Parents, parent: Parent) => TexastContent | | articleVersion | () => void | | articleVersionalternatives | () => void | | attrib | () => void | | authorComment | () => void | | authorNotes | () => void | | awardDesc | () => void | | awardGroup | () => void | | awardId | () => void | | awardName | () => void | | back | (j: J, parent: Node) => TexastContent[] | | bio | () => void | | blockAlternatives | () => void | | body | (j: J, node: Root) => TexastContent | | bold | (j: J, node: Parents, parent: Parent) => TexastContent | | boxedText | () => void | | break | () => void | | caption | (j: J, node: Parents, parent: Parent) => TexastContent | | chapterTitle | () => void | | chemStruct | () => void | | chemStructwrap | () => void | | citationAlternatives | () => void | | city | () => void | | code | () => void | | col | () => void | | colgroup | () => void | | collab | () => void | | collabAlternatives | () => void | | command | (j: J, node: Parents, parent: Parent) => TexastContent | | comment | () => void | | compoundKwd | () => void | | compoundKwdpart | () => void | | compoundSubject | () => void | | compoundSubjectpart | () => void | | confAcronym | () => void | | confDate | () => void | | confLoc | () => void | | confName | () => void | | confNum | () => void | | confSponsor | () => void | | confTheme | () => void | | conference | () => void | | contrib | () => void | | contribGroup | (j: J, node: Node) => TexastContent[] | | contribId | () => void | | contributedResourcegroup | () => void | | copyrightHolder | () => void | | copyrightStatement | () => void | | copyrightYear | () => void | | corresp | () => void | | count | () => void | | country | () => void | | counts | () => void | | customMeta | () => void | | customMetagroup | () => void | | dataTitle | () => void | | date | () => void | | dateIncitation | () => void | | day | () => void | | def | () => void | | defHead | () => void | | defItem | () => void | | defList | () => void | | degrees | () => void | | disp-quote | (j: J, node: DispQuote) => Environment | | dispFormula | () => void | | dispFormulagroup | () => void | | dispQuote | () => void | | edition | () => void | | elementCitation | () => void | | elocationId | () => void | | email | () => void | | equationCount | () => void | | era | () => void | | etal | () => void | | event | () => void | | eventDesc | () => void | | explanation | () => void | | extLink | (j: J, node: ExtLink) => { children: CommandArg[]; name: string; type: string; } | | extendedBy | () => void | | fax | () => void | | fig | (j: J, fig: Fig) => { children: TexastContent[]; name: string; type: string; } | | figCount | () => void | | figGroup | () => void | | fixedCase | () => void | | floatsGroup | () => void | | fn | (j: J, parent: Node) => TexastContent[] | | fnGroup | (j: J, parent: Node) => TexastContent[] | | fpage | () => void | | front | (j: J, node: Root) => TexastContent | | frontStub | () => void | | fundingGroup | () => void | | fundingSource | () => void | | fundingStatement | () => void | | givenNames | () => void | | glossary | () => void | | glyphData | () => void | | glyphRef | () => void | | gov | () => void | | graphic | (j: J, node: Graphic) => { children: (CommandArg | { type: string; value: string; })[]; name: string; type: string; } | | history | () => void | | hr | () => void | | indexTerm | () => void | | indexTermrangeend | () => void | | inlineFormula | () => void | | inlineGraphic | (j: J, node: Graphic) => { children: (CommandArg | { type: string; value: string; })[]; name: string; type: string; } | | inlineMedia | () => void | | inlineSupplementarymaterial | () => void | | institution | () => void | | institutionId | () => void | | institutionWrap | () => void | | instruction | () => void | | isbn | () => void | | issn | () => void | | issnL | () => void | | issue | () => void | | issueId | () => void | | issuePart | () => void | | issueSponsor | () => void | | issueSubtitle | () => void | | issueTitle | () => void | | issueTitlegroup | (j: J, node: Node) => TexastContent[] | | italic | (j: J, node: Node) => TexastContent | | journalId | () => void | | journalMeta | () => void | | journalSubtitle | () => void | | journalTitle | (j: J, node: Parents, parent: Parent) => TexastContent | | journalTitlegroup | (j: J, node: Node) => TexastContent[] | | kwd | () => void | | kwdGroup | () => void | | label | (j: J, node: Parents, parent: Parent) => TexastContent | | license | () => void | | licenseP | () => void | | list | (j: J, list: List) => { children: TexastContent[]; name: string; type: string; } | | listItem | (j: J, item: ListItem) => TexastContent | | longDesc | () => void | | lpage | () => void | | media | () => void | | metaName | () => void | | metaValue | () => void | | milestoneEnd | () => void | | milestoneStart | () => void | | mixedCitation | () => void | | monospace | () => void | | month | () => void | | name | () => void | | nameAlternatives | () => void | | namedContent | () => void | | nestedKwd | () => void | | nlmCitation | () => void | | note | () => void | | notes | () => void | | objectId | () => void | | onBehalfof | () => void | | openAccess | () => void | | option | () => void | | overline | () => void | | overlineEnd | () => void | | overlineStart | () => void | | p | (j: J, p: P) => TexastContent | | pageCount | () => void | | pageRange | () => void | | partTitle | () => void | | patent | () => void | | permissions | () => void | | personGroup | () => void | | phone | () => void | | postalCode | () => void | | prefix | () => void | | preformat | () => void | | price | () => void | | principalAwardrecipient | () => void | | principalInvestigator | () => void | | privateChar | () => void | | processingMeta | () => void | | product | () => void | | pubDate | () => void | | pubDatenotavailable | () => void | | pubHistory | () => void | | pubId | () => void | | publisher | () => void | | publisherLoc | () => void | | publisherName | () => void | | question | () => void | | questionPreamble | () => void | | questionWrap | () => void | | questionWrapgroup | () => void | | rb | () => void | | ref | () => void | | refCount | () => void | | refList | (j: J, list: RefList) => Environment | undefined | | relatedArticle | () => void | | relatedObject | () => void | | resourceId | () => void | | resourceName | () => void | | resourceWrap | () => void | | response | () => void | | restrictedBy | () => void | | role | () => void | | roman | () => void | | root | (j: J, node: Root) => TexastContent | | rp | () => void | | rt | () => void | | ruby | () => void | | sansSerif | (j: J, node: Parents, parent: Parent) => TexastContent | | sc | (j: J, node: Parents, parent: Parent) => TexastContent | | season | () => void | | sec | (j: J, node: Parents) => TexastContent[] | | secMeta | () => void | | see | () => void | | seeAlso | () => void | | selfUri | () => void | | series | () => void | | seriesText | () => void | | seriesTitle | () => void | | sig | () => void | | sigBlock | () => void | | size | () => void | | source | () => void | | speaker | () => void | | speech | () => void | | state | () => void | | statement | () => void | | std | () => void | | stdOrganization | () => void | | strike | () => void | | stringConf | () => void | | stringDate | () => void | | stringName | () => void | | styledContent | () => void | | sub | (j: J, node: Node) => TexastContent | | subArticle | () => void | | subjGroup | () => void | | subject | () => void | | subtitle | () => void | | suffix | () => void | | sup | (j: J, node: Node) => TexastContent | | supplement | () => void | | supplementaryMaterial | () => void | | supportDescription | () => void | | supportGroup | () => void | | supportSource | () => void | | surname | () => void | | table | (j: J, table: Table) => { children: TexastContent[]; name: string; type: string; } | | tableCount | () => void | | tableWrap | (j: J, node: TableWrap) => TexastContent | | tableWrapfoot | () => void | | tableWrapgroup | () => void | | target | () => void | | tbody | (j: J, parent: Node) => TexastContent[] | | td | (j: J, node: Td) => TableCell | | term | () => void | | termHead | () => void | | texMath | () => void | | text | (j: J, node: Text) => TexastContent | | textualForm | () => void | | tfoot | () => void | | th | () => void | | thead | () => void | | timeStamp | () => void | | title | (j: J, parent: Node) => TexastContent[] | | titleGroup | (j: J, node: Node) => TexastContent[] | | tr | (j: J, node: Tr) => TexastContent | | transAbstract | () => void | | transSource | () => void | | transSubtitle | () => void | | transTitle | (j: J, node: Parents, parent: Parent) => TexastContent | | transTitlegroup | (j: J, node: Node) => TexastContent[] | | underline | () => void | | underlineEnd | () => void | | underlineStart | () => void | | unstructuredKwdgroup | () => void | | uri | () => void | | verseGroup | () => void | | verseLine | () => void | | version | () => void | | volume | (j: J, node: Parents, parent: Parent) => TexastContent | | volumeId | () => void | | volumeIssuegroup | () => void | | volumeSeries | (j: J, node: Parents, parent: Parent) => TexastContent | | wordCount | () => void | | x | () => void | | xml | () => void | | xref | (j: J, node: Xref) => TexastContent | | year | () => void |

Defined in: src/lib/handlers/index.ts:29

Context

Properties

baseFound

boolean

Defined in: src/lib/types.ts:59

bibname

string

Defined in: src/lib/types.ts:76

booktabs

boolean

Defined in: src/lib/types.ts:68

checked

string

Defined in: src/lib/types.ts:66

citationAnalyzer

Function

Type declaration

Signature`

(node: Node): string;

Parameters`

| Name | Type | | :------ | :------ | | node | Node |

Returns`

string

Defined in: src/lib/types.ts:81

columnSeparator

boolean

Defined in: src/lib/types.ts:77

document

undefined | boolean

Defined in: src/lib/types.ts:65

documentClass

object

{
    name: string;
    options?: string[];
}

Type declaration

| Member | Type | | :------ | :------ | | name | string | | options? | string[] |

Defined in: src/lib/types.ts:71

footnotes

Record<string, TexastContent[]>

Defined in: src/lib/types.ts:78

frozenBaseUrl

null | string

Defined in: src/lib/types.ts:60

handlers

object

Index signature

Type declaration

Defined in: src/lib/types.ts:64

inTable

boolean

Defined in: src/lib/types.ts:62

italics

string

Defined in: src/lib/types.ts:70

nodeById?

object

Index signature

Type declaration

Defined in: src/lib/types.ts:56

numberOfRows

number

Defined in: src/lib/types.ts:80

qNesting

number

Defined in: src/lib/types.ts:63

quotes

string[]

Defined in: src/lib/types.ts:69

rowNumber

number

Defined in: src/lib/types.ts:79

sectionDepth

number

Defined in: src/lib/types.ts:75

unchecked

string

Defined in: src/lib/types.ts:67

wrapText

boolean

Defined in: src/lib/types.ts:61

Name

Hierarchy

• Node.Name

Properties

attributes

object

{
    id?: string;
    nameStyle?: NameTypeNameStyle;
    specificUse?: string;
}

Type declaration

| Member | Type | | :------ | :------ | | id? | string | | nameStyle? | NameTypeNameStyle | | specificUse? | string |

Defined in: libs/jast/jast/src/lib/jats.ts:6790

children

(Text | GivenNames | Prefix | Suffix | Surname)[]

Defined in: libs/jast/jast/src/lib/jats.ts:6796

data?

Data

Information from the ecosystem.

Inherited from: UnistNode.data

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:27

name

"name"

Defined in: libs/jast/jast/src/lib/jats.ts:6789

position?

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: UnistNode.position

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:33

type

"element"

Overrides: UnistNode.type

Defined in: libs/jast/jast/src/lib/jats.ts:6788

Options

Properties

bibname?

string

Defined in: src/lib/types.ts:39

booktabs?

boolean

Defined in: src/lib/types.ts:41

checked?

string

Defined in: src/lib/types.ts:34

citationAnalyzer?

Function

Type declaration

Signature`

(node: Node): string;

Parameters`

| Name | Type | | :------ | :------ | | node | Node |

Returns`

string

Defined in: src/lib/types.ts:46

columnSeparator?

boolean

Defined in: src/lib/types.ts:40

document?

boolean

Defined in: src/lib/types.ts:32

documentClass?

object

{
    name: string;
    options?: string[];
}

Type declaration

| Member | Type | | :------ | :------ | | name | string | | options? | string[] |

Defined in: src/lib/types.ts:42

handlers?

object

Index signature

Type declaration

Defined in: src/lib/types.ts:31

italics?

"emph" | "textit"

Defined in: src/lib/types.ts:38

newLines?

boolean

Defined in: src/lib/types.ts:33

quotes?

string[]

Defined in: src/lib/types.ts:36

topSection?

number

Defined in: src/lib/types.ts:37

unchecked?

string

Defined in: src/lib/types.ts:35

Parent

Hierarchy

• Parent.Parent

Properties

children

(Text | Bold | FixedCase | Italic | Monospace | NamedContent | Overline | Roman | Ruby | SansSerif | Sc | Strike | StyledContent | Sub | Sup | Underline | AbbrevJournaltitle | Abbrev | Def | Abstract | Label | ObjectId | P | Sec | Title | AccessDate | Ack | KwdGroup | RefList | SubjGroup | Address | AddrLine | City | Country | Email | ExtLink | Fax | Institution | InstitutionWrap | Phone | PostalCode | State | Uri | Alternatives | ChemStruct | IndexTerm | IndexTermrangeend | InlineFormula | InlineGraphic | InlineMedia | MilestoneEnd | MilestoneStart | PrivateChar | AffAlternatives | Aff | Break | Fn | InlineSupplementarymaterial | RelatedArticle | RelatedObject | Target | Xref | Array | Code | Graphic | Media | Preformat | SupplementaryMaterial | Table | TexMath | TextualForm | AltText | AltTitle | Annotation | Anonymous | AnswerSet | Answer | Explanation | Subtitle | BlockAlternatives | BoxedText | ChemStructwrap | DefList | DispFormula | DispFormulagroup | DispQuote | Fig | FigGroup | FnGroup | Glossary | List | Question | QuestionWrap | QuestionWrapgroup | Speech | Statement | TableWrap | TableWrapgroup | VerseGroup | AppGroup | App | Permissions | SecMeta | Attrib | LongDesc | Tbody | ArticleCategories | SeriesText | SeriesTitle | ArticleId | ArticleMeta | Isbn | ArticleVersion | ArticleVersionalternatives | AuthorNotes | Conference | ContribGroup | Counts | CustomMetagroup | ElocationId | Fpage | FundingGroup | History | Issue | IssueId | IssuePart | IssueSponsor | IssueTitle | IssueTitlegroup | Lpage | PageRange | Product | PubDate | PubDatenotavailable | PubHistory | SelfUri | Supplement | SupportGroup | TitleGroup | TransAbstract | Volume | VolumeId | VolumeIssuegroup | VolumeSeries | ArticleTitle | Article | Back | Body | FloatsGroup | Front | ProcessingMeta | Response | SubArticle | AuthorComment | Corresp | AwardDesc | AwardGroup | AwardId | AwardName | FundingSource | PrincipalAwardrecipient | PrincipalInvestigator | SupportSource | Bio | Notes | SigBlock | Caption | ChapterTitle | CitationAlternatives | ElementCitation | MixedCitation | NlmCitation | Colgroup | Col | CollabAlternatives | Collab | OnBehalfof | Role | Comment | CompoundKwdpart | CompoundKwd | CompoundSubjectpart | CompoundSubject | ConfAcronym | ConfDate | ConfLoc | ConfName | ConfNum | ConfSponsor | ConfTheme | Contrib | ContribId | Degrees | Name | NameAlternatives | StringName | ContributedResourcegroup | ResourceGroup | SupportDescription | CopyrightHolder | CopyrightStatement | CopyrightYear | Count | EquationCount | FigCount | PageCount | RefCount | TableCount | WordCount | CustomMeta | MetaName | MetaValue | DataTitle | DateIncitation | Day | Era | Month | Season | Year | Date | DefHead | DefItem | Term | TermHead | Edition | Etal | Gov | Issn | IssnL | PartTitle | Patent | PersonGroup | PubId | PublisherLoc | PublisherName | Series | Size | Source | Std | StringDate | TransSource | TransTitle | Version | EventDesc | Event | ExtendedBy | FrontStub | JournalMeta | FundingStatement | OpenAccess | GivenNames | GlyphData | GlyphRef | Hr | See | SeeAlso | InstitutionId | IssueSubtitle | TransTitlegroup | JournalId | JournalTitlegroup | Publisher | JournalSubtitle | JournalTitle | Kwd | NestedKwd | LicenseP | Price | License | ListItem | Prefix | Suffix | Surname | TimeStamp | Note | Option | OverlineEnd | OverlineStart | RestrictedBy | QuestionPreamble | Rb | Ref | ResourceName | ResourceWrap | ResourceId | Rp | Rt | Sig | Speaker | StdOrganization | StringConf | Subject | Tfoot | Thead | Tr | TableWrapfoot | Td | Th | TransSubtitle | UnderlineEnd | UnderlineStart | UnstructuredKwdgroup | VerseLine | X)[]

Overrides: UnistParent.children

Defined in: libs/jast/jast/src/lib/rejour.ts:25

data?

Data

Information from the ecosystem.

Inherited from: UnistParent.data

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:27

position?

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: UnistParent.position

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:33

type

string

The variant of a node.

Inherited from: UnistParent.type

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:22

Root

Hierarchy

• Parent.Root

Properties

children

(Text | Bold | FixedCase | Italic | Monospace | NamedContent | Overline | Roman | Ruby | SansSerif | Sc | Strike | StyledContent | Sub | Sup | Underline | AbbrevJournaltitle | Abbrev | Def | Abstract | Label | ObjectId | P | Sec | Title | AccessDate | Ack | KwdGroup | RefList | SubjGroup | Address | AddrLine | City | Country | Email | ExtLink | Fax | Institution | InstitutionWrap | Phone | PostalCode | State | Uri | Alternatives | ChemStruct | IndexTerm | IndexTermrangeend | InlineFormula | InlineGraphic | InlineMedia | MilestoneEnd | MilestoneStart | PrivateChar | AffAlternatives | Aff | Break | Fn | InlineSupplementarymaterial | RelatedArticle | RelatedObject | Target | Xref | Array | Code | Graphic | Media | Preformat | SupplementaryMaterial | Table | TexMath | TextualForm | AltText | AltTitle | Annotation | Anonymous | AnswerSet | Answer | Explanation | Subtitle | BlockAlternatives | BoxedText | ChemStructwrap | DefList | DispFormula | DispFormulagroup | DispQuote | Fig | FigGroup | FnGroup | Glossary | List | Question | QuestionWrap | QuestionWrapgroup | Speech | Statement | TableWrap | TableWrapgroup | VerseGroup | AppGroup | App | Permissions | SecMeta | Attrib | LongDesc | Tbody | ArticleCategories | SeriesText | SeriesTitle | ArticleId | ArticleMeta | Isbn | ArticleVersion | ArticleVersionalternatives | AuthorNotes | Conference | ContribGroup | Counts | CustomMetagroup | ElocationId | Fpage | FundingGroup | History | Issue | IssueId | IssuePart | IssueSponsor | IssueTitle | IssueTitlegroup | Lpage | PageRange | Product | PubDate | PubDatenotavailable | PubHistory | SelfUri | Supplement | SupportGroup | TitleGroup | TransAbstract | Volume | VolumeId | VolumeIssuegroup | VolumeSeries | ArticleTitle | Article | Back | Body | FloatsGroup | Front | ProcessingMeta | Response | SubArticle | AuthorComment | Corresp | AwardDesc | AwardGroup | AwardId | AwardName | FundingSource | PrincipalAwardrecipient | PrincipalInvestigator | SupportSource | Bio | Notes | SigBlock | Caption | ChapterTitle | CitationAlternatives | ElementCitation | MixedCitation | NlmCitation | Colgroup | Col | CollabAlternatives | Collab | OnBehalfof | Role | Comment | CompoundKwdpart | CompoundKwd | CompoundSubjectpart | CompoundSubject | ConfAcronym | ConfDate | ConfLoc | ConfName | ConfNum | ConfSponsor | ConfTheme | Contrib | ContribId | Degrees | Name | NameAlternatives | StringName | ContributedResourcegroup | ResourceGroup | SupportDescription | CopyrightHolder | CopyrightStatement | CopyrightYear | Count | EquationCount | FigCount | PageCount | RefCount | TableCount | WordCount | CustomMeta | MetaName | MetaValue | DataTitle | DateIncitation | Day | Era | Month | Season | Year | Date | DefHead | DefItem | Term | TermHead | Edition | Etal | Gov | Issn | IssnL | PartTitle | Patent | PersonGroup | PubId | PublisherLoc | PublisherName | Series | Size | Source | Std | StringDate | TransSource | TransTitle | Version | EventDesc | Event | ExtendedBy | FrontStub | JournalMeta | FundingStatement | OpenAccess | GivenNames | GlyphData | GlyphRef | Hr | See | SeeAlso | InstitutionId | IssueSubtitle | TransTitlegroup | JournalId | JournalTitlegroup | Publisher | JournalSubtitle | JournalTitle | Kwd | NestedKwd | LicenseP | Price | License | ListItem | Prefix | Suffix | Surname | TimeStamp | Note | Option | OverlineEnd | OverlineStart | RestrictedBy | QuestionPreamble | Rb | Ref | ResourceName | ResourceWrap | ResourceId | Rp | Rt | Sig | Speaker | StdOrganization | StringConf | Subject | Tfoot | Thead | Tr | TableWrapfoot | Td | Th | TransSubtitle | UnderlineEnd | UnderlineStart | UnstructuredKwdgroup | VerseLine | X | Instruction | Doctype)[]

Overrides: UnistParent.children

Defined in: libs/jast/jast/src/lib/rejour.ts:20

data?

Data

Information from the ecosystem.

Inherited from: UnistParent.data

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:27

position?

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: UnistParent.position

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:33

type

"root"

Overrides: UnistParent.type

Defined in: libs/jast/jast/src/lib/rejour.ts:19

TexastLiteral

Nodes containing a value.

Type parameters

• Value = unknownSpecific value type of Literal.value such as string for Text node
• TData extends object = Data

Hierarchy

• Node<TData>.TexastLiteral

Properties

data?

TData

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:27

position?

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: Node.position

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:33

type

string

The variant of a node.

Inherited from: Node.type

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:22

value

Value

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:113

TexastParent

Hierarchy

• Parent.TexastParent

Properties

children

TexastContent[]

Overrides: UnistParent.children

Defined in: libs/texast/texast/src/lib/texast.ts:106

data?

Data

Information from the ecosystem.

Inherited from: UnistParent.data

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:27

position?

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: UnistParent.position

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:33

type

string

The variant of a node.

Inherited from: UnistParent.type

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:22

TexastRoot

Hierarchy

• TexastParent.TexastRoot

Properties

children

TexastContent[]

Inherited from: TexastParent.children

Defined in: libs/texast/texast/src/lib/texast.ts:106

data?

Data

Information from the ecosystem.

Inherited from: TexastParent.data

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:27

position?

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: TexastParent.position

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:33

type

"root"

The variant of a node.

Overrides: TexastParent.type

Defined in: libs/texast/texast/src/lib/texast.ts:86

Text

Nodes containing a value.

Hierarchy

• TexastLiteral.Text

Properties

data?

Data

Information from the ecosystem.

Inherited from: TexastLiteral.data

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:27

position?

Position

Location of a node in a source document. Must not be present if a node is generated.

Inherited from: TexastLiteral.position

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/unist/index.d.ts:33

type

"text"

The variant of a node.

Overrides: TexastLiteral.type

Defined in: libs/jast/jast/src/lib/jats.ts:43

value

string

Overrides: TexastLiteral.value

Defined in: libs/jast/jast/src/lib/jats.ts:44

Attributes

JastProperties

Defined in: src/lib/types.ts:29

Content

ValuesType<documentMap>

Defined in: libs/jast/jast/src/lib/jats.ts:13710

Element

Extract<Content, { type: "element"; }>

Defined in: libs/jast/jast/src/lib/jats.ts:13711

Handle

Function

Type declaration

Signature

(j: J, node: any, parent?: Parent): TexastContent | TexastContent[] | void;

Parameters

| Name | Type | | :------ | :------ | | j | J | | node | any | | parent? | Parent |

Returns

TexastContent | TexastContent[] | void

Defined in: src/lib/types.ts:49

J

JWithProps & JWithoutProps & Context

Defined in: src/lib/types.ts:106

JWithProps

Function

Type declaration

Signature

(
  node: Node, 
  type: string, 
  props?: Attributes, 
  children?: string | TexastContent[]): TexastContent;

Parameters

| Name | Type | | :------ | :------ | | node | Node | | type | string | | props? | Attributes | | children? | string | TexastContent[] |

Returns

TexastContent

Defined in: src/lib/types.ts:84

JWithPropsSpecific

<TNode> Function

Type parameters

• TNode extends TexastContent = TexastContent

Type declaration

Signature

(
  node: Node, 
  type: Pick<TNode, "type">, 
  props?: Attributes, 
  children?: Pick<TNode, "children">): TNode;

Parameters

| Name | Type | | :------ | :------ | | node | Node | | type | Pick<TNode, "type"> | | props? | Attributes | | children? | Pick<TNode, "children"> |

Returns

TNode

Defined in: src/lib/types.ts:97

JWithoutProps

Function

Type declaration

Signature

(node: Node, type: string, children?: string | TexastContent[]): TexastContent;

Parameters

| Name | Type | | :------ | :------ | | node | Node | | type | string | | children? | string | TexastContent[] |

Returns

TexastContent

Defined in: src/lib/types.ts:91

Node

Parent["children"][number] | Root

jast Node

Defined in: src/lib/types.ts:26

Parents

Extract<Exclude<Node, Text | Root>, { children: any[]; }>

Defined in: src/lib/types.ts:122

TexastContent

TopLevelDocumentContent | PreambleContent | AlignmentContent | MathContent | CommandContent | TexastParagraphContent | CommandArg | ListContent | Text | Comment | TabularContent | TableRowContent

Defined in: libs/texast/texast/src/lib/texast.ts:32

TexastParagraphContent

Text | InlineMath | Command | Comment

Defined in: libs/texast/texast/src/lib/texast.ts:75

Syntax tree

Types

Compatibility

Security

Related

Contribute

License

GPL-3.0-or-later © Thomas F. K. Jorna