Interface FormatOnKeyRequestArgs

Arguments for format on key messages.

interface FormatOnKeyRequestArgs {
    file: string;
    key: string;
    line: number;
    offset: number;
    options?: ChangePropertyTypes<
        tsc.FormatCodeSettings,
        { indentStyle: tsc.IndentStyle
        | tsc.server.protocol.IndentStyle },
    >;
    projectFileName?: string;
}

Properties

file: string

The file for the request (absolute pathname required).

key: string

Key pressed (';', '\n', or '}').

line: number

The line number for the request (1-based).

offset: number

The character offset (on the line) for the request (1-based).

projectFileName?: string