lib/inferrer - jsdoc-scribe API

Functions(6)

#splitCamel

Parameter	Type	Optional	Description
`name`	`any`

Returns: any

Signature

splitCamel(name: any): any

#cap

line 25

Parameter	Type	Optional	Description
`str`	`any`

Returns: any

Signature

cap(str: any): any

#phrase

line 26

Parameter	Type	Optional	Description
`words`	`any`

Returns: any

Signature

phrase(words: any): any

#inferFunctionDescription

line 436

Infer a one-line description for a function from its name and modifiers. Examples: getUserById(...) → "Returns the user by id." isActive(...) → "Returns whether the active." calculate(...) → "Calculates."

Parameter	Type	Optional	Description
`name`	`string\|null`		- Function name.
`mods`	`{ isAsync?: boolean }`	yes	- Modifier flags from the AST.

Returns: string — A sentence ending with a full stop.

Signature

inferFunctionDescription(name: any, mods: any): any

#inferParamDescription

line 458

Infer a short description for a parameter from its name. Falls back to a humanised version of the camelCase name.

Parameter	Type	Optional	Description
`paramName`	`string`		- The parameter name as written in source.

Returns: string — A lowercase description phrase (no trailing period).

Signature

inferParamDescription(paramName: any): any

#inferClassDescription

line 485

Infer a one-line description for a class from its name. Recognises common suffix patterns (Service, Repository, Error, etc.).

Parameter	Type	Optional	Description
`name`	`string\|null`		- Class name.

Returns: string — A sentence ending with a full stop.

Signature

inferClassDescription(name: any): any

Variables & Constants(16)

#VERB_TEMPLATES

line 33

let VERB_TEMPLATES: Object

var

Signature

let VERB_TEMPLATES: Object

#PARAM_DESCRIPTIONS

line 188

let PARAM_DESCRIPTIONS: Object

var

Signature

let PARAM_DESCRIPTIONS: Object

#CLASS_SUFFIX_TEMPLATES

line 361

let CLASS_SUFFIX_TEMPLATES: Object

var

Signature

let CLASS_SUFFIX_TEMPLATES: Object

#words

line 442

let words: any

var

Signature

let words: any

#verb

line 443

let verb: any

var

Signature

let verb: any

#rest

line 444

let rest: any

var

Signature

let rest: any

#template

line 445

let template: any

var

Signature

let template: any

#lower

line 459

let lower: any

var

Signature

let lower: any

#words

line 463

let words: any

var

Signature

let words: any

#last

line 465

let last: any

var

Signature

let last: any

#desc2

line 467

let desc2: any

var

Signature

let desc2: any

#prefix

line 470

let prefix: any

var

Signature

let prefix: any

#words

line 487

let words: any

var

Signature

let words: any

#last

line 488

let last: any

var

Signature

let last: any

#rest

line 489

let rest: any

var

Signature

let rest: any

#suffixFn

line 490

let suffixFn: any

var

Signature

let suffixFn: any