@types/doctrine

property description

description: string;

• The overall description of the thing being documented.

property tags

tags: Tag[];

property lineNumbers

lineNumbers?: boolean | undefined;

• Set to true to add lineNumber to each node, specifying the line on which the node is found in the source. Default: false.

property preserveWhitespace

preserveWhitespace?: boolean | undefined;

• Set to true to preserve leading and trailing whitespace when extracting comment text.

property recoverable

recoverable?: boolean | undefined;

• set to true to keep parsing even when syntax errors occur. Default: false.

property sloppy

sloppy?: boolean | undefined;

• Set to true to allow optional parameters to be specified in brackets (@param {string} [foo]). Default: false.

property strict

strict?: boolean | undefined;

• Set to true to throw an error when syntax errors occur. If false then errors will be added to tag.errors instead.

property tags

tags?: string[] | undefined;

• An array of tags to return. When specified, Doctrine returns only tags in this array. For example, if tags is ["param"], then only @param tags will be returned. Default: null.

property unwrap

unwrap?: boolean | undefined;

• Set to true to delete the leading /**, any * that begins a line, and the trailing * / from the source text. Default: false.

property description

description: string | null;

• The description of the thing this tag is documenting.

property errors

errors?: string[] | undefined;

• Any errors that were encountered in parsing the tag.

property kind

kind?: string | undefined;

property name

name?: string | undefined;

• The name of the thing this tag is documenting, if any.

property title

title: string;

• The title of the jsdoc tag. e.g. @foo will have a title of 'foo'.

property type

type?: Type | null | undefined;

• The type of the thing this tag is documenting.

variable Syntax

const Syntax: {
    NullableLiteral: 'NullableLiteral';
    AllLiteral: 'AllLiteral';
    NullLiteral: 'NullLiteral';
    UndefinedLiteral: 'UndefinedLiteral';
    VoidLiteral: 'VoidLiteral';
    UnionType: 'UnionType';
    ArrayType: 'ArrayType';
    RecordType: 'RecordType';
    FieldType: 'FieldType';
    FunctionType: 'FunctionType';
    ParameterType: 'ParameterType';
    RestType: 'RestType';
    NonNullableType: 'NonNullableType';
    OptionalType: 'OptionalType';
    NullableType: 'NullableType';
    NameExpression: 'NameExpression';
    TypeApplication: 'TypeApplication';
};

function parseParamType

parseParamType: (src: string, options?: { midstream: boolean }) => Type;

function parseType

parseType: (src: string, options?: { midstream: boolean }) => Type;

function stringify

stringify: (type: Type) => string;