lib/drift - jsdoc-scribe API

Functions(4)

#detectDrift

Diff AST-truth vs JSDoc-truth for every function/method/constructor in a module and return the list of drift issues found.

Parameter	Type	Optional	Description
`moduleData`	`object`		- extractModule() output for one file.

Returns: Array<{symbol: string, kind: string, detail: object, line: (number|null)}>

Signature

detectDrift(moduleData: any): any

#diffParams

Parameter	Type	Optional	Description
`symbol`	`any`
`params`	`any`
`jsdocParams`	`any`
`line`	`any`

Signature

diffParams(symbol: any, params: any, jsdocParams: any, line: any)

#diffReturn

Parameter	Type	Optional	Description
`symbol`	`any`
`returnType`	`any`
`returns`	`any`
`line`	`any`

Signature

diffReturn(symbol: any, returnType: any, returns: any, line: any)

#hasBlock

Parameter	Type	Optional	Description
`jsdocParams`	`any`
`returns`	`any`

Returns: any

Signature

hasBlock(jsdocParams: any, returns: any): any

Variables & Constants(4)

#issues

let issues: Array

var

Signature

let issues: Array

#astNames

let astNames: any

var

Signature

let astNames: any

#docNames

let docNames: any

var

Signature

let docNames: any

#symbol

let symbol: any

var

Signature

let symbol: any