lib/extractor - jsdoc-scribe API

Functions(21)

#getScriptKind

Parameter	Type	Optional	Description
`file`	`any`

Returns: any

Signature

getScriptKind(file: any): any

#modifiersOf

line 16

Parameter	Type	Optional	Description
`node`	`any`

Returns: any

Signature

modifiersOf(node: any): any

#typeText

line 29

Parameter	Type	Optional	Description
`node`	`any`

Returns: any

Signature

typeText(node: any): any

#hasReturnWithValue

line 31

Parameter	Type	Optional	Description
`block`	`any`

Returns: any

Signature

hasReturnWithValue(block: any): any

#inferReturnType

line 39

Parameter	Type	Optional	Description
`fnNode`	`any`

Returns: any

Signature

inferReturnType(fnNode: any): any

#inferTypeFromInitializer

line 48

Parameter	Type	Optional	Description
`init`	`any`

Returns: any

Signature

inferTypeFromInitializer(init: any): any

#extractParams

line 66

Parameter	Type	Optional	Description
`params`	`any`

Returns: any

Signature

extractParams(params: any): any

#getLineNumber

line 74

Parameter	Type	Optional	Description
`sourceFile`	`any`
`node`	`any`

Returns: any

Signature

getLineNumber(sourceFile: any, node: any): any

#emptyJSDoc

line 84

Empty jsdoc result used as default

Returns: any

Signature

emptyJSDoc(): any

#parseJSDocBlock

line 99

Parse a raw /** ... *\/ comment block. Returns: { description, example, since, deprecated, params, returns, throws } - description: text before the first @tag line - example: text after @example - since: string after @since - deprecated: message after @deprecated (or empty string if bare tag) - params: [{ name, type, description }] from @param {type} name desc - returns: { type, description } from @returns {type} desc - throws: [{ type, description }] from @throws {type} desc

Parameter	Type	Optional	Description
`raw`	`any`

Returns: any

Signature

parseJSDocBlock(raw: any): any

#extractBraced

line 119

Parameter	Type	Optional	Description
`str`	`any`

Returns: any

Signature

extractBraced(str: any): any

#looksLikeIntendedJSDoc

line 202

Heuristic: does a raw leading comment look like it was intended as a JSDoc block but is malformed (wrong asterisk count) while still carrying an @tag inside? Used by lib/lint.js's no-bad-blocks rule. Deterministic, no fuzzy/AI scoring — a fixed structural check.

Parameter	Type	Optional	Description
`text`	`any`

Returns: any

Signature

looksLikeIntendedJSDoc(text: any): any

#readJSDoc

line 214

Read the nearest leading /** ... *\/ block for a node. Also surfaces rawComment (the exact block text, for lib/lint.js's text-level rules) and badComment (a near-miss malformed block, if no proper /** block was found — see looksLikeIntendedJSDoc above).

Parameter	Type	Optional	Description
`sourceFile`	`any`
`node`	`any`

Returns: any

Signature

readJSDoc(sourceFile: any, node: any): any

#extractModuleDoc

line 245

Extract top-of-file /** @module ... *\/ block. Returns { moduleName, description, since } or all-null.

Parameter	Type	Optional	Description
`sourceFile`	`any`

Returns: any

Signature

extractModuleDoc(sourceFile: any): any

#extractFunction

line 268

Parameter	Type	Optional	Description
`node`	`any`
`sourceFile`	`any`
`nameOverride`	`any`

Returns: any

Signature

extractFunction(node: any, sourceFile: any, nameOverride: any): any

#extractClass

line 292

Parameter	Type	Optional	Description
`node`	`any`
`sourceFile`	`any`

Returns: any

Signature

extractClass(node: any, sourceFile: any): any

#extractInterface

line 385

Parameter	Type	Optional	Description
`node`	`any`
`sourceFile`	`any`

Returns: any

Signature

extractInterface(node: any, sourceFile: any): any

#extractTypeAlias

line 416

Parameter	Type	Optional	Description
`node`	`any`
`sourceFile`	`any`

Returns: any

Signature

extractTypeAlias(node: any, sourceFile: any): any

#extractEnum

line 432

Parameter	Type	Optional	Description
`node`	`any`
`sourceFile`	`any`

Returns: any

Signature

extractEnum(node: any, sourceFile: any): any

#extractModule

line 455

Parameter	Type	Optional	Description
`filePath`	`any`

Returns: any

Signature

extractModule(filePath: any): any

#visit

line 467

Parameter	Type	Optional	Description
`node`	`any`

Signature

visit(node: any)

Variables & Constants(68)

#path

line 3

const path: any

const

Signature

const path: any

#ts

line 4

const ts: any

const

Signature

const ts: any

#{ findFirstDescendant, asFunctionLike, asClass }

line 5

const { findFirstDescendant, asFunctionLike, asClass }: any

const

Signature

const { findFirstDescendant, asFunctionLike, asClass }: any

#kinds

line 17

const kinds: Set

const

Signature

const kinds: Set

#explicit

line 40

const explicit: any

const

Signature

const explicit: any

#body

line 42

const body: any

const

Signature

const body: any

#lines

line 100

const lines: any

const

Signature

const lines: any

#descLines

line 106

const descLines: Array

const

Signature

const descLines: Array

#exampleLines

line 107

let exampleLines: any

var

Signature

let exampleLines: any

#inExample

line 108

let inExample: boolean

var

Signature

let inExample: boolean

#since

line 109

let since: any

var

Signature

let since: any

#deprecated

line 110

let deprecated: any

var

Signature

let deprecated: any

#params

line 111

const params: Array

const

Signature

const params: Array

#returns

line 112

let returns: any

var

Signature

let returns: any

#throws

line 113

const throws: Array

const

Signature

const throws: Array

#depth

line 121

let depth: number

var

Signature

let depth: number

#rest

line 139

const rest: any

const

Signature

const rest: any

#rest

line 143

const rest: any

const

Signature

const rest: any

#{ type, rest: nameAndDesc }

line 144

const { type, rest: nameAndDesc }: any

const

Signature

const { type, rest: nameAndDesc }: any

#m2

line 145

const m2: any

const

Signature

const m2: any

#rawName

line 147

const rawName: any

const

Signature

const rawName: any

#optional

line 148

const optional: any

const

Signature

const optional: any

#name

line 149

const name: any

const

Signature

const name: any

#rest

line 154

const rest: any

const

Signature

const rest: any

#{ type, rest: desc }

line 155

const { type, rest: desc }: any

const

Signature

const { type, rest: desc }: any

#rest

line 159

const rest: any

const

Signature

const rest: any

#{ type, rest: desc }

line 160

const { type, rest: desc }: any

const

Signature

const { type, rest: desc }: any

#descText

line 170

const descText: any

const

Signature

const descText: any

#description

line 184

const description: any

const

Signature

const description: any

#example

line 186

let example: any

var

Signature

let example: any

#opensBad

line 204

const opensBad: any

const

Signature

const opensBad: any

#ranges

line 215

const ranges: any

const

Signature

const ranges: any

#badComment

line 216

let badComment: any

var

Signature

let badComment: any

line 218

const r: any

const

Signature

const r: any

#text

line 219

const text: any

const

Signature

const text: any

#parsed

line 221

const parsed: any

const

Signature

const parsed: any

#empty

line 232

const empty: any

const

Signature

const empty: any

#text

line 247

const text: any

const

Signature

const text: any

#ranges

line 248

const ranges: any

const

Signature

const ranges: any

#block

line 250

const block: any

const

Signature

const block: any

#parsed

line 252

const parsed: any

const

Signature

const parsed: any

#modMatch

line 254

const modMatch: any

const

Signature

const modMatch: any

#mods

line 269

const mods: any

const

Signature

const mods: any

#jsdoc

line 270

const jsdoc: any

const

Signature

const jsdoc: any

#mods

line 293

const mods: any

const

Signature

const mods: any

#name

line 294

const name: any

const

Signature

const name: any

#jsdoc

line 295

const jsdoc: any

const

Signature

const jsdoc: any

#result

line 296

const result: Object

const

Signature

const result: Object

#target

line 318

const target: any

const

Signature

const target: any

#mjsdoc

line 323

const mjsdoc: any

const

Signature

const mjsdoc: any

#mm

line 335

const mm: any

const

Signature

const mm: any

#visibility

line 336

const visibility: any

const

Signature

const visibility: any

#mm

line 357

const mm: any

const

Signature

const mm: any

#mm

line 360

const mm: any

const

Signature

const mm: any

#mm

line 363

const mm: any

const

Signature

const mm: any

#visibility

line 364

const visibility: any

const

Signature

const visibility: any

#jsdoc

line 386

const jsdoc: any

const

Signature

const jsdoc: any

#jsdoc

line 417

const jsdoc: any

const

Signature

const jsdoc: any

#jsdoc

line 433

const jsdoc: any

const

Signature

const jsdoc: any

#fs

line 456

const fs: any

const

Signature

const fs: any

#sourceText

line 457

const sourceText: any

const

Signature

const sourceText: any

#sourceFile

line 458

const sourceFile: any

const

Signature

const sourceFile: any

#moduleDoc

line 464

const moduleDoc: any

const

Signature

const moduleDoc: any

#result

line 465

const result: Object

const

Signature

const result: Object

#mods

line 480

const mods: any

const

Signature

const mods: any

#isConst

line 481

const isConst: any

const

Signature

const isConst: any

#stmtJsdoc

line 482

const stmtJsdoc: any

const

Signature

const stmtJsdoc: any

#init

line 484

const init: any

const

Signature

const init: any