KC's Workspace
    Preparing search index...

    Make all properties in T optional

    interface Plugin<A = any> {
        api?: A;
        augmentChunkHash?: ObjectHook<
            (this: PluginContext, chunk: RenderedChunk) => string | void,
            {},
        >;
        banner?: ObjectHook<AddonHook, {}>;
        buildEnd?: ObjectHook<
            (
                this: PluginContext,
                ...parameters: [err?: Error],
            ) => void | Promise<void>,
            { sequential?: boolean },
        >;
        buildStart?: ObjectHook<
            (
                this: PluginContext,
                ...parameters: [options: NormalizedInputOptions],
            ) => void | Promise<void>,
            { sequential?: boolean },
        >;
        closeBundle?: ObjectHook<
            (this: PluginContext, ...parameters: []) => void | Promise<void>,
            { sequential?: boolean },
        >;
        closeWatcher?: ObjectHook<
            (this: PluginContext, ...parameters: []) => void | Promise<void>,
            { sequential?: boolean },
        >;
        footer?: ObjectHook<AddonHook, {}>;
        generateBundle?: ObjectHook<
            (
                this: PluginContext,
                ...parameters: [
                    outputOptions: NormalizedOutputOptions,
                    bundle: OutputBundle,
                    isWrite: boolean,
                ],
            ) => void
            | Promise<void>,
            {},
        >;
        intro?: ObjectHook<AddonHook, {}>;
        load?: ObjectHook<
            (
                this: PluginContext,
                ...parameters: [id: string],
            ) => MaybePromise<LoadResult> | Promise<MaybePromise<LoadResult>>,
            {
                filter?: TUnionWithTopLevelFilterExpressionArray<Pick<HookFilter, "id">> | undefined;
            },
        >;
        moduleParsed?: ObjectHook<
            (
                this: PluginContext,
                ...parameters: [moduleInfo: ModuleInfo],
            ) => void | Promise<void>,
            { sequential?: boolean },
        >;
        name: string;
        onLog?: ObjectHook<
            (
                this: MinimalPluginContext,
                level: LogLevel,
                log: RollupLog,
            ) => boolean | NullValue<void>,
            {},
        >;
        options?: ObjectHook<
            (
                this: MinimalPluginContext,
                ...parameters: [options: InputOptions],
            ) => InputOptions | NullValue<void> | Promise<InputOptions | NullValue<void>>,
            {},
        >;
        outputOptions?: ObjectHook<
            (
                this: MinimalPluginContext,
                options: OutputOptions,
            ) => OutputOptions | NullValue<void>,
            {},
        >;
        outro?: ObjectHook<AddonHook, {}>;
        renderChunk?: ObjectHook<
            (
                this: PluginContext,
                ...parameters: [
                    code: string,
                    chunk: RenderedChunk,
                    outputOptions: NormalizedOutputOptions,
                    meta: RenderedChunkMeta,
                ],
            ) => string | NullValue<void> | { code: string; map?: SourceMapInput; } | Promise<string | NullValue<void> | { code: string; map?: SourceMapInput; }>,
            {
                filter?: TUnionWithTopLevelFilterExpressionArray<Pick<HookFilter, "code">> | undefined;
            },
        >;
        renderError?: ObjectHook<
            (
                this: PluginContext,
                ...parameters: [error: Error],
            ) => void | Promise<void>,
            { sequential?: boolean },
        >;
        renderStart?: ObjectHook<
            (
                this: PluginContext,
                ...parameters: [
                    outputOptions: NormalizedOutputOptions,
                    inputOptions: NormalizedInputOptions,
                ],
            ) => void
            | Promise<void>,
            { sequential?: boolean },
        >;
        resolveDynamicImport?: ObjectHook<
            (
                this: PluginContext,
                ...parameters: [source: string, importer: string],
            ) => ResolveIdResult | Promise<ResolveIdResult>,
            {},
        >;
        resolveId?: ObjectHook<
            (
                this: PluginContext,
                ...parameters: [
                    source: string,
                    importer: string,
                    extraOptions: ResolveIdExtraOptions,
                ],
            ) => ResolveIdResult | Promise<ResolveIdResult>,
            {
                filter?: TUnionWithTopLevelFilterExpressionArray<{ id?: GeneralHookFilter<RegExp>; }> | undefined;
            },
        >;
        transform?: ObjectHook<
            (
                this: TransformPluginContext,
                ...parameters: [
                    code: string,
                    id: string,
                    meta: BindingTransformHookExtraArgs & {
                        ast?: Program;
                        magicString?: BindingMagicString;
                        moduleType: ModuleType;
                    },
                ],
            ) => TransformResult | Promise<TransformResult>,
            {
                filter?: TUnionWithTopLevelFilterExpressionArray<HookFilter> | undefined;
            },
        >;
        watchChange?: ObjectHook<
            (
                this: PluginContext,
                ...parameters: [id: string, event: { event: ChangeEvent }],
            ) => void | Promise<void>,
            { sequential?: boolean },
        >;
        writeBundle?: ObjectHook<
            (
                this: PluginContext,
                ...parameters: [
                    outputOptions: NormalizedOutputOptions,
                    bundle: OutputBundle,
                ],
            ) => void
            | Promise<void>,
            { sequential?: boolean },
        >;
    }

    Type Parameters

    • A = any

    Hierarchy (View Summary)

    Index

    Properties

    api?: A
    augmentChunkHash?: ObjectHook<
        (this: PluginContext, chunk: RenderedChunk) => string | void,
        {},
    >
    banner?: ObjectHook<AddonHook, {}>
    buildEnd?: ObjectHook<
        (
            this: PluginContext,
            ...parameters: [err?: Error],
        ) => void | Promise<void>,
        { sequential?: boolean },
    >
    buildStart?: ObjectHook<
        (
            this: PluginContext,
            ...parameters: [options: NormalizedInputOptions],
        ) => void | Promise<void>,
        { sequential?: boolean },
    >
    closeBundle?: ObjectHook<
        (this: PluginContext, ...parameters: []) => void | Promise<void>,
        { sequential?: boolean },
    >
    closeWatcher?: ObjectHook<
        (this: PluginContext, ...parameters: []) => void | Promise<void>,
        { sequential?: boolean },
    >
    footer?: ObjectHook<AddonHook, {}>
    generateBundle?: ObjectHook<
        (
            this: PluginContext,
            ...parameters: [
                outputOptions: NormalizedOutputOptions,
                bundle: OutputBundle,
                isWrite: boolean,
            ],
        ) => void
        | Promise<void>,
        {},
    >
    intro?: ObjectHook<AddonHook, {}>
    load?: ObjectHook<
        (
            this: PluginContext,
            ...parameters: [id: string],
        ) => MaybePromise<LoadResult> | Promise<MaybePromise<LoadResult>>,
        {
            filter?: TUnionWithTopLevelFilterExpressionArray<Pick<HookFilter, "id">> | undefined;
        },
    >
    moduleParsed?: ObjectHook<
        (
            this: PluginContext,
            ...parameters: [moduleInfo: ModuleInfo],
        ) => void | Promise<void>,
        { sequential?: boolean },
    >
    name: string
    onLog?: ObjectHook<
        (
            this: MinimalPluginContext,
            level: LogLevel,
            log: RollupLog,
        ) => boolean | NullValue<void>,
        {},
    >
    options?: ObjectHook<
        (
            this: MinimalPluginContext,
            ...parameters: [options: InputOptions],
        ) => InputOptions | NullValue<void> | Promise<InputOptions | NullValue<void>>,
        {},
    >
    outputOptions?: ObjectHook<
        (
            this: MinimalPluginContext,
            options: OutputOptions,
        ) => OutputOptions | NullValue<void>,
        {},
    >
    outro?: ObjectHook<AddonHook, {}>
    renderChunk?: ObjectHook<
        (
            this: PluginContext,
            ...parameters: [
                code: string,
                chunk: RenderedChunk,
                outputOptions: NormalizedOutputOptions,
                meta: RenderedChunkMeta,
            ],
        ) => string | NullValue<void> | { code: string; map?: SourceMapInput; } | Promise<string | NullValue<void> | { code: string; map?: SourceMapInput; }>,
        {
            filter?: TUnionWithTopLevelFilterExpressionArray<Pick<HookFilter, "code">> | undefined;
        },
    >
    renderError?: ObjectHook<
        (
            this: PluginContext,
            ...parameters: [error: Error],
        ) => void | Promise<void>,
        { sequential?: boolean },
    >
    renderStart?: ObjectHook<
        (
            this: PluginContext,
            ...parameters: [
                outputOptions: NormalizedOutputOptions,
                inputOptions: NormalizedInputOptions,
            ],
        ) => void
        | Promise<void>,
        { sequential?: boolean },
    >
    resolveDynamicImport?: ObjectHook<
        (
            this: PluginContext,
            ...parameters: [source: string, importer: string],
        ) => ResolveIdResult | Promise<ResolveIdResult>,
        {},
    >

    This hook is only for rollup plugin compatibility. Please use resolveId instead.

    resolveId?: ObjectHook<
        (
            this: PluginContext,
            ...parameters: [
                source: string,
                importer: string,
                extraOptions: ResolveIdExtraOptions,
            ],
        ) => ResolveIdResult | Promise<ResolveIdResult>,
        {
            filter?: TUnionWithTopLevelFilterExpressionArray<{ id?: GeneralHookFilter<RegExp>; }> | undefined;
        },
    >
    transform?: ObjectHook<
        (
            this: TransformPluginContext,
            ...parameters: [
                code: string,
                id: string,
                meta: BindingTransformHookExtraArgs & {
                    ast?: Program;
                    magicString?: BindingMagicString;
                    moduleType: ModuleType;
                },
            ],
        ) => TransformResult | Promise<TransformResult>,
        {
            filter?: TUnionWithTopLevelFilterExpressionArray<HookFilter> | undefined;
        },
    >
    watchChange?: ObjectHook<
        (
            this: PluginContext,
            ...parameters: [id: string, event: { event: ChangeEvent }],
        ) => void | Promise<void>,
        { sequential?: boolean },
    >
    writeBundle?: ObjectHook<
        (
            this: PluginContext,
            ...parameters: [
                outputOptions: NormalizedOutputOptions,
                bundle: OutputBundle,
            ],
        ) => void
        | Promise<void>,
        { sequential?: boolean },
    >