@oazmi/superbuild-plugins - v0.1.0
    Preparing search index...

    Interface ReplaceContentFnArgs

    the arguments passed to a ReplaceContentFn function. the most notably important fields are:

    • htmlNode: read HtmlDependencyArgs.htmlNode.
    • htmlOutputPath: read htmlOutputPath.
    • outputPath: the current absolute output path of the emitted dependency file resource.
    • initialPath: the initial absolute output path of the emitted dependency file resource. it is only present if the output path (outputPath) of this dependency entity was altered.
    • relativePath:
    • external: specifies if this dependency resource was resolved to be an external (non-bundled) reference.
    • write: specifies if this dependency resource was declared to be written onto the disk.
    • handlerData: read handlerData.
    interface ReplaceContentFnArgs {
        htmlOutputPath: string;
        relativePath?: string;
        handlerData?: any;
        htmlDocument: HtmlNode;
        htmlNode: HtmlNode;
        htmlPath: string;
        htmlNamespace: string;
        [key: string]: ImportedEntity<HtmlNodeReplacementContentTask>;
        [key: number]: ImportedEntity<HtmlNodeReplacementContentTask>;
        [key: symbol]: ImportedEntity<HtmlNodeReplacementContentTask>;
    }

    Hierarchy (View Summary)

    Indexable

    Index

    Properties

    htmlOutputPath: string

    the finalized absolute output path of the emitted host html file.

    relativePath?: string

    the relative path of this output dependency file (outputPath), with respect to the emitted host html file (htmlOutputPath). this field is only present when external is false.

    handlerData?: any

    any arbitrary data that was passed from your HtmlDependencyCallback function's returned value will get passed here.

    htmlDocument: HtmlNode

    the AST of the html document that was processed in the onTransform hook.

    htmlNode: HtmlNode

    the ultrahtml node associated with this dependency.

    htmlPath: string

    the path that was used by the html file when it was resolve (i.e. OnResolveResult.path).

    htmlNamespace: string

    the namespace that was used by the html file when it was loaded (i.e. OnLoadResult.namespace).