API de JavaScript

As APIs de JavaScript da Vite são completamente tipadas, e é recomendado utilizar a TypeScript ou ativar a verificação de tipo de JavaScript no Visual Studio Code para influenciar o sensor inteligente e a validação.

`createServer`

Assinatura de Tipo:

async function createServer(inlineConfig?: InlineConfig): Promise<ViteDevServer>

Exemplo de Utilização:

import { fileURLToPath } from 'url'
import { createServer } from 'vite'

const __dirname = fileURLToPath(new URL('.', import.meta.url))

;(async () => {
  const server = await createServer({
    // quaisquer opções de configuração de utilizador válido,
    // mais `mode` e `configFile`
    configFile: false,
    root: __dirname,
    server: {
      port: 1337
    }
  })
  await server.listen()

  server.printUrls()
})()

NOTA

Quando estiveres utilizando createServer e build no mesmo processo de Node.js, ambas funções dependem de process.env.NODE_ENV para funcionarem apropriadamente, o que também depende da opção de configuração mode. Para prevenir comportamento contraditório, defina process.env.NODE_ENV ou o mode das duas APIs para development. Caso contrário, podes gerar um processo filho para executar as APIs separadamente.

`InlineConfig`

A interface InlineConfig estende o UserConfig com propriedades adicionais:

configFile: especifica o ficheiro de configuração à utilizar. Se não for definido, a Vite tentará automaticamente resolver aquele a partir da raiz do projeto. Defina para false para desativar a resolução automática.
envFile: defina para false para desativar os ficheiros .env.

`ResolvedConfig`

A interface ResolvedConfig tem todas as mesmas propriedade de uma UserConfig, exceto que a maioria das propriedades são resolvidas e não definidas. Ela também contém serviços como:

config.assetsInclude: Uma função para verificar se um id é considerado um recurso.
config.logger: O objeto do registador interno da Vite.

`ViteDevServer`

interface ViteDevServer {
  /**
   * O objeto de configuração da Vite resolvido.
   */
  config: ResolvedConfig
  /**
   * A connect app instance Uma instância da aplicação de conexão
   * - Pode ser utilizada para atribuir intermediários personalizados ao
   *   servidor de desenvolvimento.
   * - Também pode ser utilizado como função manipuladora de um servidor 
   *   de http personalizado ou como um intermediário em quaisquer abstrações 
   *   de estilo de conexão da Node.js.
   *
   * https://github.com/senchalabs/connect#use-middleware
   */
  middlewares: Connect.Server
  /**
   * Instância do servidor de http da Node.js Nativa
   * Será "null" no modo do intermediário.
   */
  httpServer: http.Server | null
  /**
   * Instância do observador do Chokidar.
   * https://github.com/paulmillr/chokidar#api
   */
  watcher: FSWatcher
  /**
   * Servidor de WebSocket com o método `send(payload)`.
   */
  ws: WebSocketServer
  /**
   * Contentor da extensão de Rollup que pode executar gatilhos da 
   * extensão em um dado ficheiro.
   */
  pluginContainer: PluginContainer
  /**
   * Gráfico do módulo que rastreia as relacionamentos de importação, 
   * URL para o mapeamento de ficheiro e o estado da HMR.
   */
  moduleGraph: ModuleGraph
  /**
   * As URLs resolvidas que a Vite imprime na Linha de Comando.
   * "null" no modo de intermediário ou antes de `server.listen` ser chamada.
   */
  resolvedUrls: ResolvedServerUrls | null
  /**
   * Resolve, carrega e transforma programaticamente uma URL e 
   * obtém o resultado sem ir através de uma conduta de requisição de http.
   */
  transformRequest(
    url: string,
    options?: TransformOptions
  ): Promise<TransformResult | null>
  /**
   * Aplica as transformações de HTML embutida de Vite e 
   * quaisquer transformações de HTML de extensão.
   */
  transformIndexHtml(url: string, html: string): Promise<string>
  /**
   * Carrega uma dada URL como um módulo instanciado para SSR.
   */
  ssrLoadModule(
    url: string,
    options?: { fixStacktrace?: boolean }
  ): Promise<Record<string, any>>
  /**
   * Corrige o erro de "stacktrace" da ssr.
   */
  ssrFixStacktrace(e: Error): void
  /**
   * Inicia o servidor.
   */
  listen(port?: number, isRestart?: boolean): Promise<ViteDevServer>
  /**
   * Reinicia o servidor.
   *
   * @param forceOptimize - força o otimizador à reempacotar, 
   * o mesmo que bandeira --force da linha de comando.
   */
  restart(forceOptimize?: boolean): Promise<void>
  /**
   * Termina o servidor.
   */
  close(): Promise<void>
}

`build`

Assinatura de Tipo:

async function build(
  inlineConfig?: InlineConfig
): Promise<RollupOutput | RollupOutput[]>

Exemplo de Utilização:

import path from 'path'
import { fileURLToPath } from 'url'
import { build } from 'vite'

const __dirname = fileURLToPath(new URL('.', import.meta.url))

;(async () => {
  await build({
    root: path.resolve(__dirname, './project'),
    base: '/foo/',
    build: {
      rollupOptions: {
        // ...
      }
    }
  })
})()

`preview`

Assinatura de Tipo:

async function preview(inlineConfig?: InlineConfig): Promise<PreviewServer>

Exemplo de Utilização:

import { preview } from 'vite'
;(async () => {
  const previewServer = await preview({
    // quaisquer opções de configuração de utilizador válida,
    // mias `mode` e `configFile`
    preview: {
      port: 8080,
      open: true
    }
  })

  previewServer.printUrls()
})()

`resolveConfig`

Assinatura de Tipo:

async function resolveConfig(
  inlineConfig: InlineConfig,
  command: 'build' | 'serve',
  defaultMode = 'development'
): Promise<ResolvedConfig>

O valor de command é serve em desenvolvimento (na linha de comando vite, vite dev e vite serve são pseudónimos).

`mergeConfig`

Assinatura de Tipo:

function mergeConfig(
  defaults: Record<string, any>,
  overrides: Record<string, any>,
  isRoot = true
): Record<string, any>

Combina profundamente duas configurações de Vite. isRoot representa o nível dentro da configuração de Vite que está sendo combinada. Por exemplo, defina para false se estiveres combinando duas opções de build.

`searchForWorkspaceRoot`

Assinatura de Tipo:

function searchForWorkspaceRoot(
  current: string,
  root = searchForPackageRoot(current)
): string

Relacionado ao: server.fs.allow

Procura pela raiz do potencial espaço de trabalho se cumprir as seguintes condições, caso contrário recuaria para o root:

contém o campo workspaces no package.json
contém um dos seguintes ficheiros
- lerna.json
- pnpm-workspace.yaml

`loadEnv`

Assinatura de Tipo:

function loadEnv(
  mode: string,
  envDir: string,
  prefixes: string | string[] = 'VITE_'
): Record<string, string>

Relacionado ao: Ficheiros .env

Carrega os ficheiros .env dentro de envDir por padrão, só as variáveis de ambiente prefixadas com a VITE_ são carregadas, a menos que prefixes seja modificada.

`normalizePath`

Assinatura de Tipo:

function normalizePath(id: string): string

Relacionado ao: Normalização do Caminho

Normaliza um caminho para operar internamente entre as extensões de Vite.

`transformWithEsbuild`

Assinatura de Tipo:

async function transformWithEsbuild(
  code: string,
  filename: string,
  options?: EsbuildTransformOptions,
  inMap?: object
): Promise<ESBuildTransformResult>

Transforma a JavaScript ou TypeScript com a esbuild. Útil para extensões que preferem harmonização com transformação de esbuild interna da Vite.

`loadConfigFromFile`

Assinatura de Tipo:

async function loadConfigFromFile(
  configEnv: ConfigEnv,
  configFile?: string,
  configRoot: string = process.cwd(),
  logLevel?: LogLevel
): Promise<{
  path: string
  config: UserConfig
  dependencies: string[]
} | null>

Carrega um ficheiro de configuração de Vite manualmente com a esbuild.

API de JavaScript #

createServer #

InlineConfig #

ResolvedConfig #

ViteDevServer #

build #

preview #

resolveConfig #

mergeConfig #

searchForWorkspaceRoot #

loadEnv #

normalizePath #

transformWithEsbuild #

loadConfigFromFile #

API de JavaScript

`createServer`

`InlineConfig`

`ResolvedConfig`

`ViteDevServer`

`build`

`preview`

`resolveConfig`

`mergeConfig`

`searchForWorkspaceRoot`

`loadEnv`

`normalizePath`

`transformWithEsbuild`

`loadConfigFromFile`