Class DevEnvironment

constructor

• new DevEnvironment(
      name: string,
      config: ResolvedConfig,
      context: DevEnvironmentContext,
  ): DevEnvironment

  Parameters

  • name: string
  • config: ResolvedConfig
  • context: DevEnvironmentContext

  Returns DevEnvironment

OptionalbundledDev

config

OptionaldepsOptimizer

hot

environment.hot.send({ type: 'full-reload' })
Copy

logger

mode

moduleGraph

name

pluginContainer

• get pluginContainer(): EnvironmentPluginContainer<DevEnvironment>

  Returns EnvironmentPluginContainer<DevEnvironment>

plugins

• get plugins(): readonly Plugin<any>[]

  Returns readonly Plugin<any>[]

close

• close(): Promise<void>

  Returns Promise<void>

fetchModule

• fetchModule(
      id: string,
      importer?: string,
      options?: FetchFunctionOptions,
  ): Promise<FetchResult>

  Called by the module runner to retrieve information about the specified module. Internally calls transformRequest and wraps the result in the format that the module runner understands. This method is not meant to be called manually.

  Parameters

  • id: string
  • Optionalimporter: string
  • Optionaloptions: FetchFunctionOptions

  Returns Promise<FetchResult>

getTopLevelConfig

• getTopLevelConfig(): ResolvedConfig

  Returns ResolvedConfig

init

• init(
      options?: { previousInstance?: DevEnvironment; watcher?: FSWatcher },
  ): Promise<void>

  Parameters

  • Optionaloptions: { previousInstance?: DevEnvironment; watcher?: FSWatcher }

    • OptionalpreviousInstance?: DevEnvironment

      the previous instance used for the environment with the same name

      when using, the consumer should check if it's an instance generated from the same class or factory function

    • Optionalwatcher?: FSWatcher

  Returns Promise<void>

listen

• listen(server: ViteDevServer): Promise<void>

  When the dev server is restarted, the methods are called in the following order:

  • new instance init
  • previous instance close
  • new instance listen

  Parameters

  • server: ViteDevServer

  Returns Promise<void>

reloadModule

• reloadModule(module: EnvironmentModuleNode): Promise<void>

  Parameters

  • module: EnvironmentModuleNode

  Returns Promise<void>

transformRequest

• transformRequest(url: string): Promise<TransformResult | null>

  Parameters

  • url: string

  Returns Promise<TransformResult | null>

waitForRequestsIdle

• waitForRequestsIdle(ignoredId?: string): Promise<void>
  Experimental

  Calling await environment.waitForRequestsIdle(id) will wait until all static imports are processed after the first transformRequest call. If called from a load or transform plugin hook, the id needs to be passed as a parameter to avoid deadlocks. Calling this function after the first static imports section of the module graph has been processed will resolve immediately.

  Parameters

  • OptionalignoredId: string

  Returns Promise<void>

warmupRequest

• warmupRequest(url: string): Promise<void>

  Parameters

  • url: string

  Returns Promise<void>