Interface ResolveOptionsWebpackOptions

Options object for resolving requests.

Hierarchy

  • ResolveOptionsWebpackOptions

Properties

alias? aliasFields? byDependency? cache? cachePredicate? cacheWithContext? conditionNames? descriptionFiles? enforceExtension? exportsFields? extensionAlias? extensions? fallback? fileSystem? fullySpecified? importsFields? mainFields? mainFiles? modules? plugins? preferAbsolute? preferRelative? resolver? restrictions? roots? symlinks? unsafeCache? useSyncFileSystemCalls?

Properties

Optional alias

alias?: {
    alias: string | false | string[];
    name: string;
    onlyModule?: boolean;
}[] | {
    [index: string]: string | false | string[];
}

Redirect module requests.

Type declaration

  • [index: string]: string | false | string[]

Optional aliasFields

aliasFields?: (string | string[])[]

Fields in the description file (usually package.json) which are used to redirect requests inside the module.

Optional byDependency

byDependency?: {
    [index: string]: ResolveOptionsWebpackOptions;
}

Extra resolve options per dependency category. Typical categories are "commonjs", "amd", "esm".

Type declaration

Optional cache

cache?: boolean

Enable caching of successfully resolved requests (cache entries are revalidated).

Optional cachePredicate

cachePredicate?: ((request) => boolean)

Type declaration

    • (request): boolean

    • Predicate function to decide which requests should be cached.

      Parameters

      Returns boolean

Optional cacheWithContext

cacheWithContext?: boolean

Include the context information in the cache identifier when caching.

Optional conditionNames

conditionNames?: string[]

Condition names for exports field entry point.

Optional descriptionFiles

descriptionFiles?: string[]

Filenames used to find a description file (like a package.json).

Optional enforceExtension

enforceExtension?: boolean

Enforce the resolver to use one of the extensions from the extensions option (User must specify requests without extension).

Optional exportsFields

exportsFields?: string[]

Field names from the description file (usually package.json) which are used to provide entry points of a package.

Optional extensionAlias

extensionAlias?: {
    [index: string]: string | string[];
}

An object which maps extension to extension aliases.

Type declaration

  • [index: string]: string | string[]

Optional extensions

extensions?: string[]

Extensions added to the request when trying to find the file.

Optional fallback

fallback?: {
    alias: string | false | string[];
    name: string;
    onlyModule?: boolean;
}[] | {
    [index: string]: string | false | string[];
}

Redirect module requests when normal resolving fails.

Type declaration

  • [index: string]: string | false | string[]

Optional fileSystem

fileSystem?: InputFileSystem

Filesystem for the resolver.

Optional fullySpecified

fullySpecified?: boolean

Treats the request specified by the user as fully specified, meaning no extensions are added and the mainFiles in directories are not resolved (This doesn't affect requests from mainFields, aliasFields or aliases).

Optional importsFields

importsFields?: string[]

Field names from the description file (usually package.json) which are used to provide internal request of a package (requests starting with # are considered as internal).

Optional mainFields

mainFields?: (string | string[])[]

Field names from the description file (package.json) which are used to find the default entry point.

Optional mainFiles

mainFiles?: string[]

Filenames used to find the default entry point if there is no description file or main field.

Optional modules

modules?: string[]

Folder names or directory paths where to find modules.

Optional plugins

plugins?: ("..." | ResolvePluginInstance)[]

Plugins for the resolver.

Optional preferAbsolute

preferAbsolute?: boolean

Prefer to resolve server-relative URLs (starting with '/') as absolute paths before falling back to resolve in 'resolve.roots'.

Optional preferRelative

preferRelative?: boolean

Prefer to resolve module requests as relative request and fallback to resolving as module.

Optional resolver

resolver?: Resolver

Custom resolver.

Optional restrictions

restrictions?: (string | RegExp)[]

A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met.

Optional roots

roots?: string[]

A list of directories in which requests that are server-relative URLs (starting with '/') are resolved.

Optional symlinks

symlinks?: boolean

Enable resolving symlinks to the original location.

Optional unsafeCache

unsafeCache?: boolean | {
    [index: string]: any;
}

Enable caching of successfully resolved requests (cache entries are not revalidated).

Type declaration

  • [index: string]: any

Optional useSyncFileSystemCalls

useSyncFileSystemCalls?: boolean

Use synchronous filesystem calls for the resolver.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc