Interface Plugin<A>

Make all properties in T optional

interface Plugin<A> {
    api?: A;
    augmentChunkHash: undefined | ObjectHook<((this, chunk) => string | void), {}>;
    banner: undefined | ObjectHook<AddonHook, {}>;
    buildEnd?: ObjectHook<((this, ...parameters) => void | Promise<void>), {
        sequential?: boolean;
    }>;
    buildStart?: ObjectHook<((this, ...parameters) => void | Promise<void>), {
        sequential?: boolean;
    }>;
    cacheKey?: string;
    closeBundle?: ObjectHook<((this, ...parameters) => void | Promise<void>), {
        sequential?: boolean;
    }>;
    closeWatcher?: ObjectHook<((this, ...parameters) => void | Promise<void>), {
        sequential?: boolean;
    }>;
    footer: undefined | ObjectHook<AddonHook, {}>;
    generateBundle: undefined | ObjectHook<((this, ...parameters) => void | Promise<void>), {}>;
    intro: undefined | ObjectHook<AddonHook, {}>;
    load?: ObjectHook<((this, ...parameters) => LoadResult | Promise<LoadResult>), {}>;
    moduleParsed?: ObjectHook<((this, ...parameters) => void | Promise<void>), {
        sequential?: boolean;
    }>;
    name: string;
    onLog?: ObjectHook<((this, level, log) => boolean | NullValue), {}>;
    options?: ObjectHook<((this, ...parameters) => InputOptions | NullValue | Promise<InputOptions | NullValue>), {}>;
    outputOptions: undefined | ObjectHook<((this, options) => NullValue | OutputOptions), {}>;
    outro: undefined | ObjectHook<AddonHook, {}>;
    renderChunk: undefined | ObjectHook<((this, ...parameters) => string | NullValue | { code: string; map?: SourceMapInput; } | Promise<string | NullValue | { code: string; map?: SourceMapInput; }>), {}>;
    renderDynamicImport: undefined | ObjectHook<((this, options) => NullValue | { left: string; right: string; }), {}>;
    renderError: undefined | ObjectHook<((this, ...parameters) => void | Promise<void>), {
        sequential?: boolean;
    }>;
    renderStart: undefined | ObjectHook<((this, ...parameters) => void | Promise<void>), {
        sequential?: boolean;
    }>;
    resolveDynamicImport?: ObjectHook<((this, ...parameters) => ResolveIdResult | Promise<ResolveIdResult>), {}>;
    resolveFileUrl: undefined | ObjectHook<ResolveFileUrlHook, {}>;
    resolveId?: ObjectHook<((this, ...parameters) => ResolveIdResult | Promise<ResolveIdResult>), {}>;
    resolveImportMeta: undefined | ObjectHook<ResolveImportMetaHook, {}>;
    shouldTransformCachedModule?: ObjectHook<((this, ...parameters) => boolean | NullValue | Promise<boolean | NullValue>), {}>;
    transform?: ObjectHook<((this, ...parameters) => TransformResult | Promise<TransformResult>), {}>;
    version?: string;
    watchChange?: ObjectHook<((this, ...parameters) => void | Promise<void>), {
        sequential?: boolean;
    }>;
    writeBundle: undefined | ObjectHook<((this, ...parameters) => void | Promise<void>), {
        sequential?: boolean;
    }>;
}

Type Parameters

  • A = any

Hierarchy (view full)

Properties

api? augmentChunkHash banner buildEnd? buildStart? cacheKey? closeBundle? closeWatcher? footer generateBundle intro load? moduleParsed? name onLog? options? outputOptions outro renderChunk renderDynamicImport renderError renderStart resolveDynamicImport? resolveFileUrl resolveId? resolveImportMeta shouldTransformCachedModule? transform? version? watchChange? writeBundle

Properties

Optional api

api?: A

augmentChunkHash

augmentChunkHash: undefined | ObjectHook<((this, chunk) => string | void), {}>

banner

banner: undefined | ObjectHook<AddonHook, {}>

Optional buildEnd

buildEnd?: ObjectHook<((this, ...parameters) => void | Promise<void>), {
    sequential?: boolean;
}>

Type declaration

Type declaration

  • Optional sequential?: boolean

Optional buildStart

buildStart?: ObjectHook<((this, ...parameters) => void | Promise<void>), {
    sequential?: boolean;
}>

Type declaration

Type declaration

  • Optional sequential?: boolean

Optional cacheKey

cacheKey?: string

Optional closeBundle

closeBundle?: ObjectHook<((this, ...parameters) => void | Promise<void>), {
    sequential?: boolean;
}>

Type declaration

Type declaration

  • Optional sequential?: boolean

Optional closeWatcher

closeWatcher?: ObjectHook<((this, ...parameters) => void | Promise<void>), {
    sequential?: boolean;
}>

Type declaration

Type declaration

  • Optional sequential?: boolean

footer

footer: undefined | ObjectHook<AddonHook, {}>

generateBundle

generateBundle: undefined | ObjectHook<((this, ...parameters) => void | Promise<void>), {}>

intro

intro: undefined | ObjectHook<AddonHook, {}>

Optional load

load?: ObjectHook<((this, ...parameters) => LoadResult | Promise<LoadResult>), {}>

Type declaration

    • (this, ...parameters): LoadResult | Promise<LoadResult>

    • Parameters

      Returns LoadResult | Promise<LoadResult>

Type declaration

    Optional moduleParsed

    moduleParsed?: ObjectHook<((this, ...parameters) => void | Promise<void>), {
        sequential?: boolean;
    }>

    Type declaration

    Type declaration

    • Optional sequential?: boolean

    name

    name: string

    Optional onLog

    onLog?: ObjectHook<((this, level, log) => boolean | NullValue), {}>

    Type declaration

    Type declaration

      Optional options

      options?: ObjectHook<((this, ...parameters) => InputOptions | NullValue | Promise<InputOptions | NullValue>), {}>

      Type declaration

        • (this, ...parameters): InputOptions | NullValue | Promise<InputOptions | NullValue>

        • Parameters

          Returns InputOptions | NullValue | Promise<InputOptions | NullValue>

      Type declaration

        outputOptions

        outputOptions: undefined | ObjectHook<((this, options) => NullValue | OutputOptions), {}>

        outro

        outro: undefined | ObjectHook<AddonHook, {}>

        renderChunk

        renderChunk: undefined | ObjectHook<((this, ...parameters) => string | NullValue | { code: string; map?: SourceMapInput; } | Promise<string | NullValue | { code: string; map?: SourceMapInput; }>), {}>

        renderDynamicImport

        renderDynamicImport: undefined | ObjectHook<((this, options) => NullValue | { left: string; right: string; }), {}>

        renderError

        renderError: undefined | ObjectHook<((this, ...parameters) => void | Promise<void>), {
            sequential?: boolean;
        }>

        renderStart

        renderStart: undefined | ObjectHook<((this, ...parameters) => void | Promise<void>), {
            sequential?: boolean;
        }>

        Optional resolveDynamicImport

        resolveDynamicImport?: ObjectHook<((this, ...parameters) => ResolveIdResult | Promise<ResolveIdResult>), {}>

        Type declaration

          • (this, ...parameters): ResolveIdResult | Promise<ResolveIdResult>

          • Parameters

            • this: PluginContext
            • Rest ...parameters: [specifier: string | AstNode, importer: string, options: {
                  attributes: Record<string, string>;
              }]

            Returns ResolveIdResult | Promise<ResolveIdResult>

        Type declaration

          resolveFileUrl

          resolveFileUrl: undefined | ObjectHook<ResolveFileUrlHook, {}>

          Optional resolveId

          resolveId?: ObjectHook<((this, ...parameters) => ResolveIdResult | Promise<ResolveIdResult>), {}>

          Type declaration

            • (this, ...parameters): ResolveIdResult | Promise<ResolveIdResult>

            • Parameters

              • this: PluginContext
              • Rest ...parameters: [source: string, importer: string, options: {
                    attributes: Record<string, string>;
                    custom?: CustomPluginOptions;
                    isEntry: boolean;
                }]

              Returns ResolveIdResult | Promise<ResolveIdResult>

          Type declaration

            resolveImportMeta

            resolveImportMeta: undefined | ObjectHook<ResolveImportMetaHook, {}>

            Optional shouldTransformCachedModule

            shouldTransformCachedModule?: ObjectHook<((this, ...parameters) => boolean | NullValue | Promise<boolean | NullValue>), {}>

            Type declaration

              • (this, ...parameters): boolean | NullValue | Promise<boolean | NullValue>

              • Parameters

                • this: PluginContext
                • Rest ...parameters: [options: {
                      ast: ProgramNode;
                      code: string;
                      id: string;
                      meta: CustomPluginOptions;
                      moduleSideEffects: boolean | "no-treeshake";
                      resolvedSources: ResolvedIdMap;
                      syntheticNamedExports: string | boolean;
                  }]

                Returns boolean | NullValue | Promise<boolean | NullValue>

            Type declaration

              Optional transform

              transform?: ObjectHook<((this, ...parameters) => TransformResult | Promise<TransformResult>), {}>

              Type declaration

                • (this, ...parameters): TransformResult | Promise<TransformResult>

                • Parameters

                  Returns TransformResult | Promise<TransformResult>

              Type declaration

                Optional version

                version?: string

                Optional watchChange

                watchChange?: ObjectHook<((this, ...parameters) => void | Promise<void>), {
                    sequential?: boolean;
                }>

                Type declaration

                Type declaration

                • Optional sequential?: boolean

                writeBundle

                writeBundle: undefined | ObjectHook<((this, ...parameters) => void | Promise<void>), {
                    sequential?: boolean;
                }>

                Settings

                Member Visibility

                Theme

                On This Page

                apiaugmentChunkHashbannerbuildEndbuildStartcacheKeycloseBundlecloseWatcherfootergenerateBundleintroloadmoduleParsednameonLogoptionsoutputOptionsoutrorenderChunkrenderDynamicImportrenderErrorrenderStartresolveDynamicImportresolveFileUrlresolveIdresolveImportMetashouldTransformCachedModuletransformversionwatchChangewriteBundle