API › @builder.io/qwik/optimizer

Record<string, string>

(可选)

'component'

createOptimizer

createOptimizer: (optimizerOptions?: OptimizerOptions) => Promise<Optimizer>;

参数

类型

描述

optimizerOptions

OptimizerOptions

(可选)

Promise<Optimizer>

Diagnostic

export interface Diagnostic

属性

修饰符

类型

描述

DiagnosticCategory

export type DiagnosticCategory = "error" | "warning" | "sourceError";

dirname

dirname(path: string): string;

参数

类型

描述

path

string

EntryStrategy

export type EntryStrategy =
  | InlineEntryStrategy
  | HoistEntryStrategy
  | SingleEntryStrategy
  | HookEntryStrategy
  | ComponentEntryStrategy
  | SmartEntryStrategy;

引用: InlineEntryStrategy, SingleEntryStrategy, HookEntryStrategy, ComponentEntryStrategy, SmartEntryStrategy

extname

extname(path: string): string;

参数

类型

描述

path

string

format

format(pathObject: {
        root: string;
        dir: string;
        base: string;
        ext: string;
        name: string;
    }): string;

参数

类型

描述

pathObject

{ root: string; dir: string; base: string; ext: string; name: string; }

string

GlobalInjections

export interface GlobalInjections

属性

修饰符

类型

描述

attributes?

{ [key: string]: string; }

(可选)

location

'head' | 'body'

tag

string

HookAnalysis

export interface HookAnalysis

属性

修饰符

类型

描述

string

boolean

'event' | 'function'

string

string

string | null

string

string

[number, number]

string

string

string | null

HookEntryStrategy

export interface HookEntryStrategy

属性

修饰符

类型

描述

Record<string, string>

(可选)

'hook'

InlineEntryStrategy

export interface InlineEntryStrategy

属性

修饰符

类型

描述

'inline'

InsightManifest

export interface InsightManifest

属性

修饰符

类型

描述

manual

Record<string, string>

prefetch

{ route: string; symbols: string[]; }[]

'smart'

isAbsolute

isAbsolute(path: string): boolean;

参数

类型

描述

path

string

boolean

join

join(...paths: string[]): string;

参数

类型

描述

paths

string[]

string

MinifyMode

export type MinifyMode = "simplify" | "none";

transformModulesSync(opts)

normalize

normalize(path: string): string;

参数

类型

描述

path

string

Optimizer

export interface Optimizer

属性

修饰符

类型

描述

sys

OptimizerSystem

优化器系统使用。这可以通过自定义文件系统进行更新。

方法

描述

transformFs(opts)

转换文件系统中的目录。

transformFsSync(opts)

转换文件系统中的目录。

transformModules(opts)

转换输入代码字符串，不访问文件系统。

转换输入代码字符串，不访问文件系统。

OptimizerOptions

export interface OptimizerOptions

属性

修饰符

类型

描述

binding?

any

(可选)

inlineStylesUpToBytes?

number

(可选) 如果全局样式小于此值，则内联它们

sourcemap?

boolean

(可选) 启用源映射

sys?

OptimizerSystem

(可选)

OptimizerSystem

export interface OptimizerSystem

属性

修饰符

类型

描述

cwd

() => string

dynamicImport

(path: string) => Promise<any>

env

SystemEnvironment

getInputFiles?

(rootDir: string) => Promise<TransformModuleInput[]>

(可选)

string

path

Path

strictDynamicImport

(path: string) => Promise<any>

parse

parse(path: string): {
        root: string;
        dir: string;
        base: string;
        ext: string;
        name: string;
    };

参数

类型

描述

path

string

{ root: string; dir: string; base: string; ext: string; name: string; }

Path

export interface Path

属性

修饰符

类型

描述

delimiter

readonly

string

posix

readonly

Path

sep

readonly

string

win32

readonly

null

方法

描述

QwikBuildMode

export type QwikBuildMode = "production" | "development";

QwikBuildTarget

export type QwikBuildTarget = "client" | "ssr" | "lib" | "test";

QwikBundle

export interface QwikBundle

属性

修饰符

类型

描述

dynamicImports?

string[]

(可选)

imports?

string[]

(可选)

origins?

string[]

(可选)

size

number

symbols?

string[]

(可选)

QwikManifest

构建的元数据。其中一个用途是存储 QRL 符号的位置。

export interface QwikManifest

属性

修饰符

类型

描述

bundles

{ [fileName: string]: QwikBundle; }

所有代码包，用于了解导入图

injections?

GlobalInjections[]

(可选) 要注入文档头部的 CSS 等

manifestHash

string

清单的内容哈希，如果此哈希发生变化，则代码已更改

mapping

{ [symbolName: string]: string; }

QRL 的位置

options?

{ target?: string; buildMode?: string; entryStrategy?: { [key: string]: any; }; }

(可选)

platform?

{ [name: string]: string; }

(可选)

symbols

{ [symbolName: string]: QwikSymbol; }

QRL 符号

version

string

qwikRollup

export declare function qwikRollup(
  qwikRollupOpts?: QwikRollupPluginOptions,
): any;

参数

类型

描述

qwikRollupOpts

QwikRollupPluginOptions

(可选)

any

QwikRollupPluginOptions

export interface QwikRollupPluginOptions

属性

修饰符

类型

描述

buildMode?

QwikBuildMode

(可选) 构建 production 或 development。

默认 development

csr?

boolean

(可选)

debug?

boolean

(可选) 打印详细的 Qwik 插件调试日志。

默认 false

entryStrategy?

EntryStrategy

(可选) 在构建生产环境时使用的 Qwik 入口策略。在开发过程中，类型始终为 hook。

默认 { type: "smart" })

lint?

boolean

(可选) 对 SSR 构建或开发服务器的源文件运行 eslint。这可能会减慢大型项目的启动速度。默认为 true

manifestInput?

QwikManifest

(可选) SSR 构建需要在客户端构建期间生成的清单。manifestInput 选项可用于手动提供清单。

默认 undefined

manifestOutput?

(manifest: QwikManifest) => Promise<void> | void

(可选) 客户端构建将创建一个清单，并且此钩子将使用生成的构建数据调用。

默认 undefined

optimizerOptions?

OptimizerOptions

(可选)

rootDir?

string

(可选) 应用程序的根目录，通常与 package.json 和 rollup.config.js 相同的目录。

默认 process.cwd()

srcDir?

string

(可选) 查找所有 Qwik 组件的源目录。由于 Qwik 没有单个输入，因此 srcDir 用于递归查找 Qwik 文件。

默认 src

srcInputs?

TransformModuleInput[] | null

(可选) srcDir 的替代方案，其中 srcInputs 能够手动提供文件。此选项对于没有文件系统的环境（例如 Web 工作线程）很有用。

默认: null

target?

QwikBuildTarget

(可选) 目标 client 或 ssr。

默认 client

transformedModuleOutput?

((transformedModules: TransformModule[]) => Promise<void> | void) | null

(可选) 在构建后调用的钩子，提供捆绑前使用的所有已转换模块。

QwikSymbol

export interface QwikSymbol

属性

修饰符

类型

描述

string

boolean

'function' | 'event'

string

string

string

[number, number]

string

string | null

qwikVite

export declare function qwikVite(qwikViteOpts?: QwikVitePluginOptions): any;

参数

类型

描述

qwikViteOpts

QwikVitePluginOptions

(可选)

any

QwikViteDevResponse

export interface QwikViteDevResponse

属性

修饰符

类型

描述

_qwikEnvData?

Record<string, any>

(可选)

_qwikRenderResolve?

() => void

(可选)

QwikVitePlugin

export interface QwikVitePlugin

属性

修饰符

类型

描述

'vite-plugin-qwik'

QwikVitePluginApi

export interface QwikVitePluginApi

属性

修饰符

类型

描述

getAssetsDir

() => string | undefined

getClientOutDir

() => string | null

getClientPublicOutDir

() => string | null

getInsightsManifest

(clientOutDir?: string | null) => Promise<InsightManifest | null>

getManifest

() => QwikManifest | null

getOptimizer

() => Optimizer | null

getOptions

() => NormalizedQwikPluginOptions

getRootDir

() => string | null

QwikVitePluginOptions

export type QwikVitePluginOptions =
  | QwikVitePluginCSROptions
  | QwikVitePluginSSROptions;

relative

relative(from: string, to: string): string;

参数

类型

描述

from

string

resolve

resolve(...paths: string[]): string;

参数

类型

描述

paths

string[]

string

ResolvedManifest

export interface ResolvedManifest

属性

修饰符

类型

描述

SingleEntryStrategy

export interface SingleEntryStrategy

属性

修饰符

类型

描述

Record<string, string>

(可选)

'single'

SmartEntryStrategy

export interface SmartEntryStrategy

属性

修饰符

类型

描述

Record<string, string>

(可选)

'smart'

SourceLocation

export interface SourceLocation

属性

修饰符

类型

描述

number

number

number

number

SourceMapsOption

export type SourceMapsOption = "external" | "inline" | undefined | null;

symbolMapper

此 API 作为开发者版 alpha 预览提供，可能会根据我们收到的反馈进行更改。请勿在生产环境中使用此 API。

对于给定的符号（例如 onKeydown$ 的 QRL），服务器需要知道符号所在的捆绑包。

通常，这是由 Qwik 的 q-manifest 提供的。但 q-manifest 仅在完成客户端构建后才存在。

这在开发模式下会成为问题。因此，在开发模式下，使用下面的 symbolMapper 函数将符号映射到预期的 URL。对于 Vite，给定路径对于给定符号是固定的。

symbolMapper: ReturnType<typeof createSymbolMapper>;

SymbolMapper

此 API 作为开发者版 alpha 预览提供，可能会根据我们收到的反馈进行更改。请勿在生产环境中使用此 API。

对于给定的符号（例如 onKeydown$ 的 QRL），服务器需要知道符号所在的捆绑包。

通常，这是由 Qwik 的 q-manifest 提供的。但 q-manifest 仅在完成客户端构建后才存在。

这在开发模式下会成为问题。因此，在开发模式下，使用下面的 symbolMapper 函数将符号映射到预期的 URL。对于 Vite，给定路径对于给定符号是固定的。

symbolMapper: ReturnType<typeof createSymbolMapper>;

SymbolMapperFn

export type SymbolMapperFn = (
  symbolName: string,
  mapper: SymbolMapper | undefined,
  parent?: string,
) => readonly [symbol: string, chunk: string] | undefined;

参考： SymbolMapper

SystemEnvironment

export type SystemEnvironment =
  | "node"
  | "deno"
  | "bun"
  | "webworker"
  | "browsermain"
  | "unknown";

transformFs

转换文件系统中的目录。

transformFs(opts: TransformFsOptions): Promise<TransformOutput>;

参数

类型

描述

opts

TransformFsOptions

Promise<TransformOutput>

TransformFsOptions

export interface TransformFsOptions extends TransformOptions

扩展： TransformOptions

属性

修饰符

类型

描述

vendorRoots

string[]

transformFsSync

转换文件系统中的目录。

transformFsSync(opts: TransformFsOptions): TransformOutput;

参数

类型

描述

opts

TransformFsOptions

TransformOutput

TransformModule

export interface TransformModule

属性

修饰符

类型

描述

string

HookAnalysis | null

boolean

string | null

string | null

string

TransformModuleInput

export interface TransformModuleInput

属性

修饰符

类型

描述

code

string

path

string

transformModules

转换输入代码字符串，不访问文件系统。

transformModules(opts: TransformModulesOptions): Promise<TransformOutput>;

参数

类型

描述

opts

TransformModulesOptions

Promise<TransformOutput>

TransformModulesOptions

export interface TransformModulesOptions extends TransformOptions

扩展： TransformOptions

属性

修饰符

类型

描述

input

TransformModuleInput[]

transformModulesSync

转换输入代码字符串，不访问文件系统。

transformModulesSync(opts: TransformModulesOptions): TransformOutput;

参数

类型

描述

opts

TransformModulesOptions

TransformOutput

TransformOptions

export interface TransformOptions

属性

修饰符

类型

描述

entryStrategy?

EntryStrategy

(可选)

explicitExtensions?

boolean

(可选)

isServer?

boolean

(可选)

minify?

MinifyMode

(可选)

mode?

EmitMode

(可选)

preserveFilenames?

boolean

(可选)

regCtxName?

string[]

(可选)

rootDir?

string

(可选)

scope?

string

(可选)

sourceMaps?

boolean

(可选)

srcDir

string

stripCtxName?

string[]

(可选)

stripEventHandlers?

boolean

(可选)

stripExports?

string[]

(可选)

transpileJsx?

boolean

(可选)

transpileTs?

boolean

(可选)

TransformOutput

export interface TransformOutput

属性

修饰符

类型

描述

boolean

boolean

TranspileOption

export type TranspileOption = boolean | undefined | null;

versions

versions: {
  qwik: string;
}