Class Helpers

constructor

• new Helpers(): Helpers

• Returns Helpers

Static completionCheck

Static regexToReplace

Static url

Static boldWrap

• boldWrap(item): string

• Parameters

  • item: string

  Returns string

Static cbWrap

• cbWrap(item): string

• Parameters

  • item: string

  Returns string

Static checkDesc

• checkDesc(desc): string

• Checks if the description exists and appends a new line

  Parameters

  • desc: any

    The description to check

  Returns string

  The description followed by '\n\n' if it exists, '\n\n' otherwise

Static checkDocsMatch

• checkDocsMatch(expression, ...keys): undefined | string | Record<string, any>

• Checks if the expression matches any of the keys in the documentation

  Parameters

  • expression: string

    The expression to check

  • Rest ...keys: string[]

    The keys to check against

  Returns undefined | string | Record<string, any>

  The type if a match is found, null otherwise

Static checkSyntax

• checkSyntax(syntaxContent, isMethod?): string

• Checks the syntax content and replaces certain patterns

  Parameters

  • syntaxContent: string

    The syntax content to check

  • isMethod: boolean = false

    Whether the syntax content is a method

  Returns string

  The modified syntax content

Static formatArgsForSyntax

• formatArgsForSyntax(doc, modifiedSyntax): string

• Formats the arguments for the syntax

  Parameters

  • doc: any

    The documentation object containing the arguments

  • modifiedSyntax: string

    The syntax to modify

  Returns string

  The modified syntax

Static formatSyntax

• formatSyntax(name, doc, isMethod, namespace?): string

• Formats the syntax

  Parameters

  • name: string

    The name of the syntax

  • doc: any

    The documentation object for the syntax

  • isMethod: boolean

    Whether the syntax is a method

  • namespace: null | string = null

  Returns string

  The formatted syntax

Static formatTypesArray

• formatTypesArray(types): string[]

• Formats the returned types

  Parameters

  • types: string[]

    The types to format

  Returns string[]

  The formatted types

Static formatUrl

• formatUrl(input): undefined | string

• Formats the URL

  Parameters

  • input: string

    The input to format

  Returns undefined | string

  The formatted URL

Static getThisTypes

• getThisTypes(keyedDocs): string

• Checks if the expression is a variable

  Parameters

  • keyedDocs: any

    The documentation object to check

  Returns string

  The type of the expression if it is a variable, null otherwise

Static identifyType

• identifyType(expression, completionCheck?): undefined | string | Record<string, any>

• Checks the type of the expression

  Parameters

  • expression: string

    The expression to check

  • completionCheck: boolean = false

    Whether to check for completion

  Returns undefined | string | Record<string, any>

  The type of the expression if it can be identified, null otherwise

Static modifySyntax

• modifySyntax(syntax, hasArgs, namespace?): string

• Formats the syntax

  Parameters

  • syntax: string

    The syntax to format

  • hasArgs: boolean

    Whether the syntax has arguments

  • namespace: null | string = null

  Returns string

  The formatted syntax

Static replaceFunctionSignatures

• replaceFunctionSignatures(str): string

• Parameters

  • str: string

  Returns string

Static replaceSyntax

• replaceSyntax(str): string

• Handles individual replacements in a string

  Parameters

  • str: string

    The string to replace in

  Returns string

  The string with the replacements made

Static replaceType

• replaceType(type): string

• Replaces the type in the string

  Parameters

  • type: string

    The type to replace

  Returns string

  The string with the type replaced

Static returnTypeArrayCheck

• returnTypeArrayCheck(keyedDocs, otherKeys?): string

• Checks if the expression is a variable

  Parameters

  • keyedDocs: any

    The documentation object to check

  • otherKeys: null | string[] = null

  Returns string

  The type of the expression if it is a variable, null otherwise