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

ビルドのメタデータ。その用途の1つは、QRLシンボルがどこにあるかを保存することです。

export interface QwikManifest

プロパティ

修飾子

型

説明

bundles

{ [fileName: string]: QwikBundle; }

すべてのコードバンドル。インポートグラフを知るために使用されます

injections?

GlobalInjections[]

(オプション) ドキュメントのheadに挿入する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 でファイルをマニュアルで指定できます。このオプションは、ウェブワーカーなど、ファイルシステムがない環境で役立ちます。

デフォルト: 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は開発者向けのアルファプレビューとして提供されており、フィードバックに基づいて変更される可能性があります。本番環境ではこのAPIを使用しないでください。

特定のシンボル (onKeydown$ のような QRL) について、サーバーはシンボルがどのバンドルに含まれているかを知る必要があります。

通常、これは Qwik の q-manifest によって提供されます。ただし、q-manifest はクライアントのフルビルド後にのみ存在します。

これは開発モードでは問題になります。そのため、開発モードでは、以下の symbolMapper 関数を使用してシンボルが予想される URL にマッピングされます。Vite の場合、指定されたパスは特定のシンボルに対して固定されます。

symbolMapper: ReturnType<typeof createSymbolMapper>;

SymbolMapper

このAPIは開発者向けのアルファプレビューとして提供されており、フィードバックに基づいて変更される可能性があります。本番環境ではこのAPIを使用しないでください。

特定のシンボル (onKeydown$ のような QRL) について、サーバーはシンボルがどのバンドルに含まれているかを知る必要があります。

通常、これは Qwik の q-manifest によって提供されます。ただし、q-manifest はクライアントのフルビルド後にのみ存在します。

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;
}