ChainGraph API Documentation / @badaitech/chaingraph-codegen / JSDocParser

Class: JSDocParser

Defined in: core/JSDocParser.ts:15

Constructors

Constructor

new JSDocParser(): JSDocParser

Returns

JSDocParser

Methods

getTag()

getTag(jsDocs, tagName): string | undefined

Defined in: core/JSDocParser.ts:80

Get specific tag value

Parameters

jsDocs

JSDoc[]

tagName

string

Returns

string | undefined

---

hasTag()

hasTag(jsDocs, tagName): boolean

Defined in: core/JSDocParser.ts:67

Check if JSDoc has a specific tag

Parameters

jsDocs

JSDoc[]

tagName

string

Returns

boolean

---

parseTags()

parseTags(jsDocs): Record<string, string>

Defined in: core/JSDocParser.ts:19

Parse JSDoc tags into a key-value map

Parameters

jsDocs

JSDoc[]

Returns

Record<string, string>