Jast-types NPM

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

jast

jast (journal article/abstract syntax tree) is a syntax for abstract syntax trees representing JATS XML, specifically the "Green" publishing tag set. The jast package provides types for this ast.

While it is generated by xast-util-from-xml, the syntax mimics that of hast rather than xast (name instead of name, attributes instead of attributes) in order to make it easier to port rehype plugins to rejour.

jast

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-types
# or with yarn
# yarn add jast-types
# or with npm
# npm install jast-types

Use

API

`isElement()`

Signature

isElement(node: Node<Data>): node is Element;

Parameters

Name	Type
`node`	`Node`<`Data`>

Returns

node is Element

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

`isParagraphContent()`

Signature

isParagraphContent(node: Node<Data>): node is Text | Bold | FixedCase | Italic | Monospace | NamedContent | Overline | Roman | Ruby | SansSerif | Sc | Strike | StyledContent | Sub | Sup | Underline | Abbrev | Address | Email | ExtLink | Uri | Alternatives | ChemStruct | IndexTerm | IndexTermrangeend | InlineFormula | InlineGraphic | InlineMedia | MilestoneEnd | MilestoneStart | PrivateChar | Fn | InlineSupplementarymaterial | RelatedArticle | RelatedObject | Target | Xref | Array | Code | Graphic | Media | Preformat | SupplementaryMaterial | TexMath | AnswerSet | Answer | Explanation | BlockAlternatives | BoxedText | ChemStructwrap | DefList | DispFormula | DispFormulagroup | DispQuote | Fig | FigGroup | List | Question | QuestionWrap | QuestionWrapgroup | Speech | Statement | TableWrap | TableWrapgroup | VerseGroup | AwardId | FundingSource | CitationAlternatives | ElementCitation | MixedCitation | NlmCitation | OpenAccess;

Parameters

Name	Type
`node`	`Node`<`Data`>

Returns

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

`isValidJATSName()`

Signature

isValidJATSName(tag: string): tag is Names;

Parameters

Name	Type
`tag`	`string`

Returns

tag is Names

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

`docMap`

documentMap

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

`pMap`

PChildrenMap

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

`Abbrev`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Abbrev

Properties

`attributes`

object

{
    alt?: string;
    hreflang?: string;
    id?: string;
    specificUse?: string;
}

Type declaration

Member	Type
`alt`?	`string`
`hreflang`?	`string`
`id`?	`string`
`specificUse`?	`string`

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

`children`

(Text | Def)[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"abbrev"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`AbbrevChildrenMap`

Properties

`def?`

Def[]

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

`text?`

Text

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

`AbbrevJournaltitle`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.AbbrevJournaltitle

Properties

`attributes`

object

{
    abbrevType?: string;
    id?: string;
    specificUse?: string;
}

Type declaration

Member	Type
`abbrevType`?	`string`
`id`?	`string`
`specificUse`?	`string`

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

`children`

[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"abbrevJournaltitle"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`Abstract`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Abstract

Properties

`attributes`

object

{
    abstractType?: string;
    id?: string;
    specificUse?: string;
}

Type declaration

Member	Type
`abstractType`?	`string`
`id`?	`string`
`specificUse`?	`string`

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

`children`

(Label | ObjectId | P | Sec | Title)[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"abstract"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`AbstractChildrenMap`

Properties

`label?`

Label

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

`objectId?`

ObjectId[]

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

`p?`

P[]

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

`sec?`

Sec[]

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

`title?`

Title

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

`AccessDate`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.AccessDate

Properties

`attributes`

object

{
    calendar?: string;
    id?: string;
    iso8601Date?: string;
    specificUse?: string;
}

Type declaration

Member	Type
`calendar`?	`string`
`id`?	`string`
`iso8601Date`?	`string`
`specificUse`?	`string`

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

`children`

Text[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"accessDate"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`AccessDateChildrenMap`

Properties

`text?`

Text

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

`Ack`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Ack

Properties

`attributes`

object

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

Type declaration

Member	Type
`id`?	`string`
`specificUse`?	`string`

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

`children`

(Text | Abstract | Label | ObjectId | P | Sec | Title | KwdGroup | RefList | SubjGroup)[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"ack"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`AckChildrenMap`

Properties

`abstract?`

Abstract[]

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

`kwdGroup?`

KwdGroup[]

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

`label?`

Label

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

`objectId?`

ObjectId[]

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

`p?`

P[]

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

`refList?`

RefList[]

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

`sec?`

Sec[]

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

`subjGroup?`

SubjGroup[]

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

`text?`

Text

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

`title?`

Title

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

`AddrLine`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.AddrLine

Properties

`attributes`

object

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

Type declaration

Member	Type
`id`?	`string`
`specificUse`?	`string`

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

`children`

(Text | Bold | FixedCase | Italic | Monospace | NamedContent | Overline | Roman | Ruby | SansSerif | Sc | Strike | StyledContent | Sub | Sup | Underline | Abbrev | City | Country | Fax | Institution | InstitutionWrap | Phone | PostalCode | State | Alternatives | ChemStruct | IndexTerm | IndexTermrangeend | InlineFormula | InlineGraphic | InlineMedia | MilestoneEnd | MilestoneStart | PrivateChar)[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"addrLine"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`AddrLineChildrenMap`

Properties

`abbrev?`

Abbrev[]

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

`alternatives?`

Alternatives[]

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

`bold?`

Bold[]

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

`chemStruct?`

ChemStruct[]

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

`city?`

City[]

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

`country?`

Country[]

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

`fax?`

Fax[]

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

`fixedCase?`

FixedCase[]

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

`indexTerm?`

IndexTerm[]

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

`indexTermrangeend?`

IndexTermrangeend[]

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

`inlineFormula?`

InlineFormula[]

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

`inlineGraphic?`

InlineGraphic[]

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

`inlineMedia?`

InlineMedia[]

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

`institution?`

Institution[]

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

`institutionWrap?`

InstitutionWrap[]

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

`italic?`

Italic[]

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

`milestoneEnd?`

MilestoneEnd[]

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

`milestoneStart?`

MilestoneStart[]

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

`monospace?`

Monospace[]

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

`namedContent?`

NamedContent[]

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

`overline?`

Overline[]

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

`phone?`

Phone[]

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

`postalCode?`

PostalCode[]

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

`privateChar?`

PrivateChar[]

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

`roman?`

Roman[]

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

`ruby?`

Ruby[]

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

`sansSerif?`

SansSerif[]

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

`sc?`

Sc[]

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

`state?`

State[]

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

`strike?`

Strike[]

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

`styledContent?`

StyledContent[]

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

`sub?`

Sub[]

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

`sup?`

Sup[]

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

`text?`

Text

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

`underline?`

Underline[]

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

`Address`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Address

Properties

`attributes`

object

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

Type declaration

Member	Type
`id`?	`string`
`specificUse`?	`string`

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

`children`

(Text | AddrLine | City | Country | Email | ExtLink | Fax | Institution | InstitutionWrap | Phone | PostalCode | State | Uri)[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"address"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`AddressChildrenMap`

Properties

`addrLine?`

AddrLine[]

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

`city?`

City[]

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

`country?`

Country[]

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

`email?`

Email[]

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

`extLink?`

ExtLink[]

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

`fax?`

Fax[]

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

`institution?`

Institution[]

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

`institutionWrap?`

InstitutionWrap[]

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

`phone?`

Phone[]

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

`postalCode?`

PostalCode[]

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

`state?`

State[]

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

`text?`

Text

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

`uri?`

Uri[]

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

`Aff`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Aff

Properties

`attributes`

object

{
    id?: string;
    rid?: string;
    specificUse?: string;
}

Type declaration

Member	Type
`id`?	`string`
`rid`?	`string`
`specificUse`?	`string`

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

`children`

(Text | Bold | FixedCase | Italic | Monospace | Overline | Roman | Ruby | SansSerif | Sc | Strike | Sub | Sup | Underline | Label | AddrLine | City | Country | Email | ExtLink | Fax | Institution | InstitutionWrap | Phone | PostalCode | State | Uri | Break | Fn | InlineSupplementarymaterial | RelatedArticle | RelatedObject | Target | Xref)[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"aff"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`AffAlternatives`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.AffAlternatives

Properties

`attributes`

object

{
    id?: string;
}

Type declaration

Member	Type
`id`?	`string`

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

`children`

Aff[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"affAlternatives"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`AffAlternativesChildrenMap`

Properties

`aff`

Aff[]

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

`AffChildrenMap`

Properties

`addrLine?`

AddrLine[]

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

`bold?`

Bold[]

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

`break?`

Break[]

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

`city?`

City[]

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

`country?`

Country[]

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

`email?`

Email[]

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

`extLink?`

ExtLink[]

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

`fax?`

Fax[]

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

`fixedCase?`

FixedCase[]

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

`fn?`

Fn[]

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

`inlineSupplementarymaterial?`

InlineSupplementarymaterial[]

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

`institution?`

Institution[]

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

`institutionWrap?`

InstitutionWrap[]

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

`italic?`

Italic[]

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

`label?`

Label[]

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

`monospace?`

Monospace[]

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

`overline?`

Overline[]

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

`phone?`

Phone[]

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

`postalCode?`

PostalCode[]

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

`relatedArticle?`

RelatedArticle[]

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

`relatedObject?`

RelatedObject[]

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

`roman?`

Roman[]

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

`ruby?`

Ruby[]

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

`sansSerif?`

SansSerif[]

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

`sc?`

Sc[]

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

`state?`

State[]

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

`strike?`

Strike[]

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

`sub?`

Sub[]

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

`sup?`

Sup[]

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

`target?`

Target[]

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

`text?`

Text

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

`underline?`

Underline[]

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

`uri?`

Uri[]

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

`xref?`

Xref[]

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

`AltText`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.AltText

Properties

`attributes`

object

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

Type declaration

Member	Type
`id`?	`string`
`specificUse`?	`string`

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

`children`

Text[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"altText"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`AltTextChildrenMap`

Properties

`text?`

Text

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

`AltTitle`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.AltTitle

Properties

`attributes`

object

{
    altTitletype?: string;
    id?: string;
    specificUse?: string;
}

Type declaration

Member	Type
`altTitletype`?	`string`
`id`?	`string`
`specificUse`?	`string`

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

`children`

(Bold | FixedCase | Italic | Monospace | NamedContent | Overline | Roman | Ruby | SansSerif | Sc | Strike | StyledContent | Sub | Sup | Underline | Abbrev | Email | ExtLink | Uri | Alternatives | ChemStruct | IndexTerm | IndexTermrangeend | InlineFormula | InlineGraphic | InlineMedia | MilestoneEnd | MilestoneStart | PrivateChar | Break | Fn | InlineSupplementarymaterial | RelatedArticle | RelatedObject | Target | Xref | TexMath)[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"altTitle"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`AltTitleChildrenMap`

Properties

`abbrev?`

Abbrev[]

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

`alternatives?`

Alternatives[]

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

`bold?`

Bold[]

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

`break?`

Break[]

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

`chemStruct?`

ChemStruct[]

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

`email?`

Email[]

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

`extLink?`

ExtLink[]

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

`fixedCase?`

FixedCase[]

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

`fn?`

Fn[]

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

`indexTerm?`

IndexTerm[]

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

`indexTermrangeend?`

IndexTermrangeend[]

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

`inlineFormula?`

InlineFormula[]

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

`inlineGraphic?`

InlineGraphic[]

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

`inlineMedia?`

InlineMedia[]

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

`inlineSupplementarymaterial?`

InlineSupplementarymaterial[]

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

`italic?`

Italic[]

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

`milestoneEnd?`

MilestoneEnd[]

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

`milestoneStart?`

MilestoneStart[]

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

`monospace?`

Monospace[]

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

`namedContent?`

NamedContent[]

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

`overline?`

Overline[]

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

`privateChar?`

PrivateChar[]

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

`relatedArticle?`

RelatedArticle[]

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

`relatedObject?`

RelatedObject[]

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

`roman?`

Roman[]

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

`ruby?`

Ruby[]

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

`sansSerif?`

SansSerif[]

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

`sc?`

Sc[]

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

`strike?`

Strike[]

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

`styledContent?`

StyledContent[]

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

`sub?`

Sub[]

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

`sup?`

Sup[]

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

`target?`

Target[]

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

`texMath?`

TexMath[]

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

`underline?`

Underline[]

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

`uri?`

Uri[]

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

`xref?`

Xref[]

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

`Alternatives`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Alternatives

Properties

`attributes`

object

{
    id?: string;
}

Type declaration

Member	Type
`id`?	`string`

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

`children`

(ObjectId | ChemStruct | InlineGraphic | InlineMedia | PrivateChar | InlineSupplementarymaterial | Array | Code | Graphic | Media | Preformat | SupplementaryMaterial | Table | TexMath | TextualForm)[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"alternatives"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`AlternativesChildrenMap`

Properties

`array`

Array[]

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

`chemStruct`

ChemStruct[]

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

`code`

Code[]

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

`graphic`

Graphic[]

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

`inlineGraphic`

InlineGraphic[]

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

`inlineMedia`

InlineMedia[]

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

`inlineSupplementarymaterial`

InlineSupplementarymaterial[]

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

`media`

Media[]

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

`objectId?`

ObjectId[]

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

`preformat`

Preformat[]

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

`privateChar`

PrivateChar[]

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

`supplementaryMaterial`

SupplementaryMaterial[]

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

`table`

Table[]

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

`texMath`

TexMath[]

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

`textualForm`

TextualForm[]

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

`Annotation`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Annotation

Properties

`attributes`

object

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

Type declaration

Member	Type
`id`?	`string`
`specificUse`?	`string`

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

`children`

(Text | P)[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"annotation"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`AnnotationChildrenMap`

Properties

`p`

P[]

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

`text?`

Text

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

`Anonymous`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Anonymous

Properties

`attributes`

object

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

Type declaration

Member	Type
`id`?	`string`
`specificUse`?	`string`

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

`children`

[]

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

`data?`

Data

Information from the ecosystem.

Inherited from: Node.data

Defined in: node_modules/.pnpm/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:27

`name`

"anonymous"

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

`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/@types+unist\@2.0.6/node_modules/@types/unist/index.d.ts:33

`type`

"element"

The variant of a node.

Overrides: Node.type

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

`Answer`

Syntactic units in unist syntax trees are called nodes.

Hierarchy

Node.Answer

Properties

`attributes`

object

{
    id?: string;
    pointerToquestion: string;
    specificUse?: string;
}

Type declaration

Member	Type
`id`?	`str

jats-xml jats typescript tree ast unified

utility-types

@everything-registry/sub-chunk-1949 jast-util-to-csl jast-util-to-texast jast-util-from-csl ooxast-util-to-jast rejour-parse rejour-stringify reoff-rejour

0.1.2

1 year ago

0.1.1

1 year ago

jast

Contents

What is this?

When should I use this?

Install

Use

API

isElement()

Signature

Parameters

Returns

isParagraphContent()

Signature

Parameters

Returns

isValidJATSName()

Signature

Parameters

Returns

docMap

pMap

Abbrev

Hierarchy

Properties

attributes

Type declaration

children

data?

name

position?

type

AbbrevChildrenMap

Properties

def?

text?

AbbrevJournaltitle

Hierarchy

Properties

attributes

Type declaration

children

data?

name

position?

type

Abstract

Hierarchy

Properties

attributes

Type declaration

children

data?

name

position?

type

AbstractChildrenMap

Properties

label?

objectId?

p?

sec?

title?

AccessDate

Hierarchy

Properties

attributes

Type declaration

children

data?

name

position?

type

AccessDateChildrenMap

Properties

text?

Ack

Hierarchy

Properties

attributes

Type declaration

`isElement()`

`isParagraphContent()`

`isValidJATSName()`

`docMap`

`pMap`

`Abbrev`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`AbbrevChildrenMap`

`def?`

`text?`

`AbbrevJournaltitle`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`Abstract`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`AbstractChildrenMap`

`label?`

`objectId?`

`p?`

`sec?`

`title?`

`AccessDate`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`AccessDateChildrenMap`

`text?`

`Ack`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`AckChildrenMap`

`abstract?`

`kwdGroup?`

`label?`

`objectId?`

`p?`

`refList?`

`sec?`

`subjGroup?`

`text?`

`title?`

`AddrLine`

`attributes`

`children`

`data?`

`name`

`position?`

`type`

`AddrLineChildrenMap`

`abbrev?`

`alternatives?`

`bold?`

`chemStruct?`

`city?`

`country?`

`fax?`

`fixedCase?`

`indexTerm?`

`indexTermrangeend?`