Interface RuleSetRule

A rule description with conditions and effects for modules.

Hierarchy

  • RuleSetRule

Properties

assert? compiler? dependency? descriptionData? enforce? exclude? generator? include? issuer? issuerLayer? layer? loader? mimetype? oneOf? options? parser? realResource? resolve? resource? resourceFragment? resourceQuery? rules? scheme? sideEffects? test? type? use?

Properties

Optional assert

assert?: {
    [index: string]: RuleSetConditionOrConditions;
}

Match on import assertions of the dependency.

Type declaration

Optional compiler

compiler?: string | RegExp | RuleSetLogicalConditions | ((value) => boolean) | RuleSetCondition[]

Match the child compiler name.

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional dependency

dependency?: string | RegExp | RuleSetLogicalConditions | RuleSetCondition[] | ((value) => boolean)

Match dependency type.

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional descriptionData

descriptionData?: {
    [index: string]: RuleSetConditionOrConditions;
}

Match values of properties in the description file (usually package.json).

Type declaration

Optional enforce

enforce?: "pre" | "post"

Enforce this rule as pre or post step.

Optional exclude

exclude?: string | RegExp | RuleSetLogicalConditionsAbsolute | ((value) => boolean) | RuleSetConditionAbsolute[]

Shortcut for resource.exclude.

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional generator

generator?: {
    [index: string]: any;
}

The options for the module generator.

Type declaration

  • [index: string]: any

Optional include

include?: string | RegExp | RuleSetLogicalConditionsAbsolute | RuleSetConditionAbsolute[] | ((value) => boolean)

Shortcut for resource.include.

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional issuer

issuer?: string | RegExp | RuleSetLogicalConditionsAbsolute | RuleSetConditionAbsolute[] | ((value) => boolean)

Match the issuer of the module (The module pointing to this module).

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional issuerLayer

issuerLayer?: string | RegExp | RuleSetLogicalConditions | RuleSetCondition[] | ((value) => boolean)

Match layer of the issuer of this module (The module pointing to this module).

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional layer

layer?: string

Specifies the layer in which the module should be placed in.

Optional loader

loader?: string

Shortcut for use.loader.

Optional mimetype

mimetype?: string | RegExp | RuleSetLogicalConditions | RuleSetCondition[] | ((value) => boolean)

Match module mimetype when load from Data URI.

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional oneOf

oneOf?: RuleSetRule[]

Only execute the first matching rule in this array.

Optional options

options?: string | {
    [index: string]: any;
}

Shortcut for use.options.

Type declaration

  • [index: string]: any

Optional parser

parser?: {
    [index: string]: any;
}

Options for parsing.

Type declaration

  • [index: string]: any

Optional realResource

realResource?: string | RegExp | RuleSetLogicalConditionsAbsolute | RuleSetConditionAbsolute[] | ((value) => boolean)

Match the real resource path of the module.

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional resolve

resolve?: ResolveOptionsWebpackOptions

Options for the resolver.

Optional resource

resource?: string | RegExp | RuleSetLogicalConditionsAbsolute | RuleSetConditionAbsolute[] | ((value) => boolean)

Match the resource path of the module.

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional resourceFragment

resourceFragment?: string | RegExp | RuleSetLogicalConditions | RuleSetCondition[] | ((value) => boolean)

Match the resource fragment of the module.

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional resourceQuery

resourceQuery?: string | RegExp | RuleSetLogicalConditions | RuleSetCondition[] | ((value) => boolean)

Match the resource query of the module.

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional rules

rules?: RuleSetRule[]

Match and execute these rules when this rule is matched.

Optional scheme

scheme?: string | RegExp | RuleSetLogicalConditions | RuleSetCondition[] | ((value) => boolean)

Match module scheme.

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional sideEffects

sideEffects?: boolean

Flags a module as with or without side effects.

Optional test

test?: string | RegExp | RuleSetLogicalConditionsAbsolute | RuleSetConditionAbsolute[] | ((value) => boolean)

Shortcut for resource.test.

Type declaration

    • (value): boolean

    • Parameters

      • value: string

      Returns boolean

Optional type

type?: string

Module type to use for the module.

Optional use

use?: string | RuleSetUseItem[] | ((data) => RuleSetUseItem[]) | {
    ident?: string;
    loader?: string;
    options?: string | {
        [index: string]: any;
    };
} | ((data) => string | __TypeWebpackOptions | RuleSetUseItem[] | {
    ident?: string;
    loader?: string;
    options?: string | {
        [index: string]: any;
    };
})

Modifiers applied to the module when rule is matched.

Type declaration

    • (data): RuleSetUseItem[]

    • Parameters

      • data: {
            compiler: string;
            issuer: string;
            realResource: string;
            resource: string;
            resourceQuery: string;
        }
        • compiler: string
        • issuer: string
        • realResource: string
        • resource: string
        • resourceQuery: string

      Returns RuleSetUseItem[]

Type declaration

  • Optional ident?: string

    Unique loader options identifier.

  • Optional loader?: string

    Loader name.

  • Optional options?: string | {
        [index: string]: any;
    }

    Loader options.

Type declaration

    • (data): string | __TypeWebpackOptions | RuleSetUseItem[] | {
          ident?: string;
          loader?: string;
          options?: string | {
              [index: string]: any;
          };
      }

    • Parameters

      • data: object

      Returns string | __TypeWebpackOptions | RuleSetUseItem[] | {
          ident?: string;
          loader?: string;
          options?: string | {
              [index: string]: any;
          };
      }

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc