Interface LanguageServiceDefaults

interface LanguageServiceDefaults {
    inlayHintsOptions: InlayHintsOptions;
    modeConfiguration: languages.typescript.ModeConfiguration;
    onDidChange: IEvent<void>;
    onDidExtraLibsChange: IEvent<void>;
    workerOptions: WorkerOptions;
    addExtraLib(content, filePath?): IDisposable;
    getCompilerOptions(): CompilerOptions;
    getDiagnosticsOptions(): languages.typescript.DiagnosticsOptions;
    getEagerModelSync(): boolean;
    getExtraLibs(): IExtraLibs;
    setCompilerOptions(options): void;
    setDiagnosticsOptions(options): void;
    setEagerModelSync(value): void;
    setExtraLibs(libs): void;
    setInlayHintsOptions(options): void;
    setMaximumWorkerIdleTime(value): void;
    setModeConfiguration(modeConfiguration): void;
    setWorkerOptions(options): void;
}

Properties

inlayHintsOptions modeConfiguration onDidChange onDidExtraLibsChange workerOptions

Methods

addExtraLib getCompilerOptions getDiagnosticsOptions getEagerModelSync getExtraLibs setCompilerOptions setDiagnosticsOptions setEagerModelSync setExtraLibs setInlayHintsOptions setMaximumWorkerIdleTime setModeConfiguration setWorkerOptions

Properties

Readonly inlayHintsOptions

inlayHintsOptions: InlayHintsOptions

Readonly modeConfiguration

modeConfiguration: languages.typescript.ModeConfiguration

Readonly onDidChange

onDidChange: IEvent<void>

Event fired when compiler options or diagnostics options are changed.

Readonly onDidExtraLibsChange

onDidExtraLibsChange: IEvent<void>

Event fired when extra libraries registered with the language service change.

Readonly workerOptions

workerOptions: WorkerOptions

Methods

addExtraLib

  • addExtraLib(content, filePath?): IDisposable

  • Add an additional source file to the language service. Use this for typescript (definition) files that won't be loaded as editor documents, like jquery.d.ts.

    Parameters

    • content: string

      The file content

    • Optional filePath: string

      An optional file path

    Returns IDisposable

    A disposable which will remove the file from the language service upon disposal.

getCompilerOptions

  • getCompilerOptions(): CompilerOptions

  • Get current TypeScript compiler options for the language service.

    Returns CompilerOptions

getDiagnosticsOptions

getEagerModelSync

  • getEagerModelSync(): boolean

  • Get the current setting for whether all existing models should be eagerly sync'd to the worker on start or restart.

    Returns boolean

getExtraLibs

  • getExtraLibs(): IExtraLibs

  • Get the current extra libs registered with the language service.

    Returns IExtraLibs

setCompilerOptions

  • setCompilerOptions(options): void

  • Set TypeScript compiler options.

    Parameters

    Returns void

setDiagnosticsOptions

  • setDiagnosticsOptions(options): void

  • Configure whether syntactic and/or semantic validation should be performed

    Parameters

    Returns void

setEagerModelSync

  • setEagerModelSync(value): void

  • Configure if all existing models should be eagerly sync'd to the worker on start or restart.

    Parameters

    • value: boolean

    Returns void

setExtraLibs

  • setExtraLibs(libs): void

  • Remove all existing extra libs and set the additional source files to the language service. Use this for typescript definition files that won't be loaded as editor documents, like jquery.d.ts.

    Parameters

    • libs: {
          content: string;
          filePath?: string;
      }[]

      An array of entries to register.

    Returns void

setInlayHintsOptions

  • setInlayHintsOptions(options): void

  • Configure inlay hints options.

    Parameters

    Returns void

setMaximumWorkerIdleTime

  • setMaximumWorkerIdleTime(value): void

  • No-op.

    Parameters

    • value: number

    Returns void

setModeConfiguration

setWorkerOptions

  • setWorkerOptions(options): void

  • Configure webworker options

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

inlayHintsOptionsmodeConfigurationonDidChangeonDidExtraLibsChangeworkerOptionsaddExtraLibgetCompilerOptionsgetDiagnosticsOptionsgetEagerModelSyncgetExtraLibssetCompilerOptionssetDiagnosticsOptionssetEagerModelSyncsetExtraLibssetInlayHintsOptionssetMaximumWorkerIdleTimesetModeConfigurationsetWorkerOptions