KC's Workspace
    Preparing search index...

    Interface PartialResolvedId

    interface PartialResolvedId {
        description?: string | null;
        external?: boolean | "absolute" | "relative";
        id: string;
        invalidate?: boolean | null;
        meta?: CustomPluginOptions | null;
        moduleSideEffects?: ModuleSideEffects;
        packageJsonPath?: string | null;
    }

    Hierarchy (View Summary)

    Index
    description? external? id invalidate? meta? moduleSideEffects? packageJsonPath?
    description?: string | null

    A short, human-readable description of the module.

    This is useful for virtual modules, whose ids (e.g. \0vite/modulepreload-polyfill.js) do not convey their purpose on their own.

    function polyfillPlugin() {
      return {
        name: 'vite:modulepreload-polyfill',
         load: {
           filter: { id: /^\0vite/modulepreload-polyfill\.js$/ },
           handler(id) {
             return {
               code: '',
               description: 'A polyfill for `link` tag with `rel="modulepreload"`',
             };
           }
         },
      };
    }
    external?: boolean | "absolute" | "relative"

    Whether this id should be treated as external.

    Relative external ids, i.e. ids starting with ./ or ../, will not be internally converted to an absolute id and converted back to a relative id in the output, but are instead included in the output unchanged. If you want relative ids to be re-normalized and deduplicated instead, return an absolute file system location as id and choose external: "relative".

    • If true, absolute ids will be converted to relative ids based on the user's choice for the makeAbsoluteExternalsRelative option.
    • If 'relative', absolute ids will always be converted to relative ids.
    • If 'absolute', absolute ids will always be kept as absolute ids.
    id: string
    invalidate?: boolean | null
    meta?: CustomPluginOptions | null

    See Custom module meta-data section for more details.

    moduleSideEffects?: ModuleSideEffects

    Indicates whether the module has side effects to Rolldown.

    • If false is set and no other module imports anything from this module, then this module will not be included in the bundle even if the module would have side effects.
    • If true is set, Rolldown will use its default algorithm to include all statements in the module that has side effects.
    • If "no-treeshake" is set, treeshaking will be disabled for this module, and this module will be included in one of the chunks even if it is empty.

    The precedence of this option is as follows (highest to lowest):

    1. transform hook's returned moduleSideEffects option
    2. load hook's returned moduleSideEffects option
    3. resolveId hook's returned moduleSideEffects option
    4. treeshake.moduleSideEffects option
    5. sideEffects field in the package.json file
    6. true (default)
    packageJsonPath?: string | null

    Settings
    Member Visibility

    On This Page
    Properties