Briklab Docs

ParseOptions ​

ts
export interface ParseOptions {
    JSDoc?: OptionMode;
    Name?: OptionMode;
    Level?: OptionMode;
    Decorators?: OptionMode;
    ExportInfo?: OptionMode;
    Type?: OptionMode;
    TypeAst?: OptionMode;
    ItemType?: OptionMode;
    Location?: OptionMode;
    Arguments?: OptionMode;
    TypeParameters?: OptionMode;
    ReturnType?: OptionMode;
    ReturnTypeAST?: OptionMode;
    Value?: OptionMode;
    ValueText?: OptionMode;
    ValueParsed?: OptionMode;
    SubType?: OptionMode;
    Target?: OptionMode;
    Const?: OptionMode;
    Members?: OptionMode;
    Accessibility?: OptionMode;
    Static?: OptionMode;
    Async?: OptionMode;
    For?: OptionMode;
    IsJSType?: OptionMode;
    Default?: OptionMode;
    DefaultParsed?: OptionMode;
    Optional?: OptionMode;
    Readonly?: OptionMode;
    Abstract?: OptionMode;
    Private?: OptionMode;
    GetterSetter?: OptionMode;
    KeyType?: OptionMode;
}

Representation of the options that can be used to control the parsing process in the TypeScript AST. Each property in the ParseOptions interface corresponds to a specific aspect of the parsing process, such as whether to include JSDoc comments, names, levels, decorators, export information, types, type ASTs, item types, locations, arguments, type parameters, return types, values, subtypes, targets, const qualifiers, members, accessibility modifiers, static modifiers, async modifiers, and more. The value of each property is of type OptionMode, which determines how that particular aspect should be handled during parsing (e.g., whether to include it always, never, or only under certain conditions).

References ​