Jast-util-to-csl NPM

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

API

`all()`

Signature

all(node: 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): any[];

Parameters

Name	Type
`node`	`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`

Returns

any[]

Defined in: lib/jast-util-to-csl.ts:250

`one()`

Signature

one(node: 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): any;

Parameters

Name	Type
`node`	`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`

Returns

any

Defined in: lib/jast-util-to-csl.ts:264

`refListToCSL()`

Signature

refListToCSL(list: RefList): CSL[];

Parameters

Name	Type
`list`	`RefList`

Returns

CSL[]

Defined in: lib/jast-util-to-csl.ts:28

`refToCSL()`

Signature

refToCSL(citation: ElementCitation, id: string): CSL;

Parameters

Name	Type
`citation`	`ElementCitation`
`id`	`string`

Returns

CSL

Defined in: lib/jast-util-to-csl.ts:42

`toCSL()`

Parses either Root, Front, or Back jast-element and returns CSL JSON

Signature

toCSL<T>(root: T): CSLConditional<T>;

Type parameters

T extends Back | Front | Root

Parameters

Name	Type
`root`	`T`

Returns

CSLConditional<T>

Defined in: lib/jast-util-to-csl.ts:219

`toCSLBack()`

Signature

toCSLBack(node: Back): CSL[] | undefined;

Parameters

Name	Type
`node`	`Back`

Returns

CSL[] | undefined

Defined in: lib/jast-util-to-csl.ts:197

`toCSLFront()`

Signature

toCSLFront(node: Front): CSL | undefined;

Parameters

Name	Type
`node`	`Front`

Returns

CSL | undefined

Defined in: lib/jast-util-to-csl.ts:189

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

jast-util-to-csl

Convert a jast citation syntax tree to list of csl objects.

jast jats-xml csl-json converter ast unified

csl-json unist-util-is xast-util-to-string jast-types xast-util-is-element xast-util-select

@everything-registry/sub-chunk-1949 jast-util-to-texast

0.1.2

1 year ago

0.1.1

1 year ago