twoslash

constructor(
    title: string,
    description: string,
    recommendation: string,
    code?: string
);

code: string;

description: string;

recommendation: string;

title: string;

element?: CompilerOptionDeclaration;

name: string;

type: 'list' | 'boolean' | 'number' | 'string' | 'object' | Map<string, any>;

cache?: boolean | Map<string, VirtualTypeScriptEnvironment>;

customTransformers?: CustomTransformers;

fsCache?: boolean;

fsMap?: Map<string, string>;

tsLibDirectory?: string;

tsModule?: TS;

vfsRoot?: string;

errors: number[];

keepNotations: boolean;

noErrors: boolean | number[];

noErrorsCutted: boolean;

noErrorValidation: boolean;

noStaticSemanticInfo: boolean;

showEmit: boolean;

showEmittedFile?: string;

end: number;

name: string;

start: number;

type: 'compilerOptions' | 'handbookOptions' | 'tag' | 'unknown';

value: any;

compilerOptions?: CompilerOptions;

customTags?: string[];

extraFiles?: ExtraFiles;

filterNode?: (node: NodeWithoutPosition) => boolean;

handbookOptions?: Partial<HandbookOptions>;

shouldGetHoverInfo?: (
    identifier: string,
    start: number,
    filename: string
) => boolean;

getCacheMap: () => Map<string, VirtualTypeScriptEnvironment> | undefined;

(
    code: string,
    extension?: string,
    options?: TwoslashExecuteOptions
): TwoslashReturn;

defaultCompilerOptions?: CompilerOptions;

defaultOptions?: Partial<HandbookOptions>;

meta: TwoslashReturnMeta;

get queries(): NodeQuery[];

get completions(): NodeCompletion[];

get errors(): NodeError[];

get highlights(): NodeHighlight[];

get hovers(): NodeHover[];

get tags(): NodeTag[];

code: string;

errors: {
    renderedMessage: string;
    id: string;
    category: 0 | 1 | 2 | 3;
    code: number;
    start: number | undefined;
    length: number | undefined;
    line: number | undefined;
    character: number | undefined;
}[];

extension: string;

highlights: {
    kind: 'highlight';
    /** The index of the text in the file */
    start: number;
    /** What line is the highlighted identifier on? */
    line: number;
    /** At what index in the line does the caret represent  */
    offset: number;
    /** The text of the token which is highlighted */
    text?: string;
    /** The length of the token */
    length: number;
}[];

playgroundURL: string;

queries: {
    kind: 'query' | 'completions';
    /** What line is the highlighted identifier on? */
    line: number;
    /** At what index in the line does the caret represent  */
    offset: number;
    /** The text of the node which is highlighted */
    text?: string;
    /** Any attached JSDocs */
    docs?: string | undefined;
    /** The node start which the query indicates  */
    start: number;
    /** The length of the node */
    length: number;
    /** Results for completions at a particular point */
    completions?: typescript.CompletionEntry[];
    completionsPrefix?: string;
}[];

staticQuickInfos: {
    /** The string content of the node this represents (mainly for debugging) */
    targetString: string;
    /** The base LSP response (the type) */
    text: string;
    /** Attached JSDoc info */
    docs: string | undefined;
    /** The index of the text in the file */
    start: number;
    /** how long the identifier */
    length: number;
    /** line number where this is found */
    line: number;
    /** The character on the line */
    character: number;
}[];

tags: {
    /** What was the name of the tag */
    name: string;
    /** Where was it located in the original source file */
    line: number;
    /** What was the text after the `// @tag: ` string  (optional because you could do // @tag on it's own line without the ':') */
    annotation?: string;
}[];

compilerOptions: CompilerOptions;

extension: string;

flagNotations: ParsedFlagNotation[];

handbookOptions: HandbookOptions;

positionCompletions: number[];

positionHighlights: [start: number, end: number, text?: string][];

positionQueries: number[];

removals: Range[];

virtualFiles: VirtualFile[];

append?: string;

content: string;

extension: string;

filename: string;

filepath: string;

offset: number;

prepend?: string;

supportLsp?: boolean;