Interface FnElementInfo

Options to print code of an element

interface FnElementInfo {
    doNotAutoGobble?: boolean;
    dropLinesEnd?: number;
    dropLinesStart?: number;
    hideDefinedAt?: boolean;
    info: TypeElementInSource[];
    program: Program;
}

Properties

doNotAutoGobble? dropLinesEnd? dropLinesStart? hideDefinedAt? info program

Properties

OptionaldoNotAutoGobble

doNotAutoGobble?: boolean

Whether to not automatically gobble leading spaces

OptionaldropLinesEnd

dropLinesEnd?: number

Number of lines to drop from the end of the code block

OptionaldropLinesStart

dropLinesStart?: number

Number of lines to drop from the start of the code block

OptionalhideDefinedAt

hideDefinedAt?: boolean

Whether to hide the "Defined at ..." line

info

info: TypeElementInSource[]

The type information collected from the source code

program

program: Program

The TypeScript program used to extract the info

Settings

Member Visibility

On This Page

Properties