• Public
  • Public/Protected
  • All


  • Options



debounceDuration: number

Debounces code reanalyzing after user has changed the editor contents by the specified amount. Set to zero to disable. Value provided in milliseconds.

Defaults to 4000, i.e. 4 seconds.

dontAdaptEditorOptions: boolean

Updates compiler options to defaults suitable for auto-loaded declarations, specifically by setting moduleResolution to NodeJs and allowSyntheticDefaultImports to true. Other options are not changed. Set this property to true to disable this behaviour.

Defaults to false.

dontRefreshModelValueAfterResolvement: boolean

After typings were resolved and injected into monaco, auto-typings updates the value of the current model to trigger a refresh in monaco's typing logic, so that it uses the injected typings.

fileRecursionDepth: number

Maximum recursion depth for recursing files. Determines how many nested file declarations are loaded. The same as packageRecursionDepth, but for individual files. Set to zero to disable.

Defaults to 10.

fileRootPath: string

The root directory where your edited files are. Must end with a slash. The default is suitable unless you change the default URI of files loaded in the editor.

Defaults to "inmemory://model/"

monaco: __module

instance of monaco editor

onlySpecifiedPackages: boolean

Only use packages specified in the versions property.

Defaults to false.

packageRecursionDepth: number

Maximum recursion depth for recursing packages. Determines how many nested package declarations are loaded. For example, if packageRecursionDepth has the value 2, the code in the monaco editor references packages A1, A2 and A3, package A1 references package B1 and B1 references C1, then packages A1, A2, A3 and B1 are loaded. Set to zero to disable.

Defaults to 3.

preloadPackages: boolean

Load typings from prespecified versions when initializing. Versions need to be specified in the versions option.

Defaults to false.

shareCache: boolean

Share source cache between multiple editor instances by storing the cache in a static property.

Defaults to false.

sourceCache: SourceCache

Supply a cache where declaration files and package.json files are cached to. Supply an instance of LocalStorageCache to cache files to localStorage.

sourceResolver: SourceResolver

Supply a custom resolver logic for declaration and package.json files. Defaults to UnpkgSourceResolver. Not recommended to change.

versions?: {}

Prespecified package versions. If a package is loaded whose name is specified in this object, it will load with the exact version specified in the object.


"@types/react": "17.0.0",
"csstype": "3.0.5"

Setting the option onlySpecifiedPackages to true makes this property act as a whitelist for packages.

Setting the option preloadPackages makes the packages specified in this property load directly after initializing the auto-loader.

Type declaration

  • [packageName: string]: string


  • onError(error: string): void
  • Called if errors occur.


    • error: string

      a textual representation of the error.

    Returns void

  • Called after progress updates like loaded declarations or events.


    • update: ProgressUpdate

      detailed event object containing update infos.

    • textual: string

      a textual representation of the update for debugging.

    Returns void

  • onUpdateVersions(versions: {}): void
  • If a new package was loaded, its name and version is added to the version object, and this method is called with the updated object.


    • versions: {}

      updated versions object.

      • [packageName: string]: string

    Returns void

Generated using TypeDoc