Interface LoaderRunnerLoaderContext<OptionsType>

The properties are added by https://github.com/webpack/loader-runner

Type Parameters

  • OptionsType

Hierarchy

  • LoaderRunnerLoaderContext

Properties

callback context currentRequest data loaderIndex loaders previousRequest query remainingRequest request resource resourceFragment resourcePath resourceQuery target

Methods

addContextDependency addDependency addMissingDependency async cacheable clearDependencies dependency getContextDependencies getDependencies getMissingDependencies

Properties

callback

callback: ((err?, content?, sourceMap?, additionalData?) => void)

Type declaration

    • (err?, content?, sourceMap?, additionalData?): void

    • Parameters

      Returns void

context

context: string

The directory of the module. Can be used as context for resolving other stuff. eg '/workspaces/ts-loader/examples/vanilla/src'

Readonly currentRequest

currentRequest: string

Readonly data

data: any

loaderIndex

loaderIndex: number

The index in the loaders array of the current loader. In the example: in loader1: 0, in loader2: 1

loaders

loaders: {
    data?: object;
    fragment: string;
    ident: string;
    normal?: Function;
    normalExecuted: boolean;
    options?: string | object;
    path: string;
    pitch?: Function;
    pitchExecuted: boolean;
    query: string;
    raw?: boolean;
    request: string;
    type?: "module" | "commonjs";
}[]

An array of all the loaders. It is writeable in the pitch phase. loaders = [{request: string, path: string, query: string, module: function}] In the example: [ { request: "/abc/loader1.js?xyz", path: "/abc/loader1.js", query: "?xyz", module: [Function] }, { request: "/abc/node_modules/loader2/index.js", path: "/abc/node_modules/loader2/index.js", query: "", module: [Function] } ]

Type declaration

  • Optional data?: object
  • fragment: string
  • ident: string
  • Optional normal?: Function
  • normalExecuted: boolean
  • Optional options?: string | object
  • path: string
  • Optional pitch?: Function
  • pitchExecuted: boolean
  • query: string
  • Optional raw?: boolean
  • request: string
  • Optional type?: "module" | "commonjs"

Readonly previousRequest

previousRequest: string

Readonly query

query: string | OptionsType

Readonly remainingRequest

remainingRequest: string

Readonly request

request: string

resource

resource: string

The resource inclusive query and fragment. Example: "/abc/resource.js?query#frag"

resourceFragment

resourceFragment: string

The resource fragment. Example: "#frag"

resourcePath

resourcePath: string

The resource path. In the example: "/abc/resource.js"

resourceQuery

resourceQuery: string

The resource query string. Example: "?query"

target

target: string

Target of compilation. Example: "web"

Methods

addContextDependency

  • Add a directory as dependency of the loader result.

    Parameters

    • context: string

    Returns void

addDependency

  • Adds a file as dependency of the loader result in order to make them watchable. For example, html-loader uses this technique as it finds src and src-set attributes. Then, it sets the url's for those attributes as dependencies of the html file that is parsed.

    Parameters

    • file: string

    Returns void

addMissingDependency

  • Parameters

    • context: string

    Returns void

async

  • Make this loader async.

    Returns ((err?, content?, sourceMap?, additionalData?) => void)

      • (err?, content?, sourceMap?, additionalData?): void

      • Make this loader async.

        Parameters

        Returns void

cacheable

  • Make this loader result cacheable. By default it's cacheable. A cacheable loader must have a deterministic result, when inputs and dependencies haven't changed. This means the loader shouldn't have other dependencies than specified with this.addDependency. Most loaders are deterministic and cacheable.

    Parameters

    • Optional flag: boolean

    Returns void

clearDependencies

  • Remove all dependencies of the loader result. Even initial dependencies and these of other loaders.

    Returns void

dependency

  • alias of addDependency Adds a file as dependency of the loader result in order to make them watchable. For example, html-loader uses this technique as it finds src and src-set attributes. Then, it sets the url's for those attributes as dependencies of the html file that is parsed.

    Parameters

    • file: string

    Returns void

getContextDependencies

  • Returns string[]

getDependencies

  • Returns string[]

getMissingDependencies

  • Returns string[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc