Class ImportMap

constructor

• new ImportMap(
      opts:
          | string
          | URL
          | { map?: IImportMap; mapUrl?: string
          | URL; rootUrl?: string | URL },
  ): ImportMap

  Create a new import map instance

  Parameters

  • opts:
        | string
        | URL
        | { map?: IImportMap; mapUrl?: string
        | URL; rootUrl?: string | URL }

    import map options, can be an optional bag of { map?, mapUrl?, rootUrl? } or just a direct mapUrl

  Returns ImportMap

clone

• clone(): ImportMap

  Clones the import map

  Returns ImportMap

  Cloned import map

extend

• extend(map: IImportMap, overrideScopes?: boolean): ImportMap

  Extends the import map mappings

  Parameters

  • map: IImportMap

    Import map to extend with
  • overrideScopes: boolean = false

    Set to true to have scopes be replacing instead of extending

  Returns ImportMap

  ImportMap for chaining

sort

• sort(): ImportMap

  Performs an alphanumerical sort on the import map imports and scopes

  Returns ImportMap

  ImportMap for chaining

set

• set(name: string, target: string, parent?: string): ImportMap

  Set a specific entry in the import map

  Parameters

  • name: string

    Specifier to set
  • target: string

    Target of the map
  • Optionalparent: string

    Optional parent scope

  Returns ImportMap

  ImportMap for chaining

setIntegrity

• setIntegrity(target: string, integrity: string): void

  Parameters

  • target: string

    URL target
  • integrity: string

    Integrity

  Returns void

getIntegrity

• getIntegrity(target: string, integrity: string): string

  Parameters

  • target: string

    URL target
  • integrity: string

    Integrity

  Returns string

replace

• replace(url: string, newUrl: string): ImportMap

  Bulk replace URLs in the import map Provide a URL ending in "/" to perform path replacements

  Parameters

  • url: string

    {String} The URL to replace
  • newUrl: string

    {String} The URL to replace it with

  Returns ImportMap

  ImportMap for chaining

combineSubpaths

• combineSubpaths(): ImportMap

  Groups subpath mappings into path mappings when multiple exact subpaths exist under the same path.

  For two mappings like { "base/a.js": "/a.js", "base/b.js": "/b.js" }, these will be replaced with a single path mapping { "base/": "/" }. Groupings are done throughout all import scopes individually.

  Returns ImportMap

  ImportMap for chaining

flatten

• flatten(): ImportMap

  Groups the import map scopes to shared URLs to reduce duplicate mappings.

  For two given scopes, "https://site.com/x/" and "https://site.com/y/", a single scope will be constructed for "https://site.com/" including their shared mappings, only retaining the scopes if they have differences.

  In the case where the scope is on the same origin as the mapUrl, the grouped scope is determined based on determining the common baseline over all local scopes

  Returns ImportMap

  ImportMap for chaining

rebase

• rebase(mapUrl?: string | URL, rootUrl?: string | URL): ImportMap

  Rebase the entire import map to a new mapUrl and rootUrl

  If the rootUrl is not provided, it will remain null if it was already set to null.

  Otherwise, just like the constructor options, the rootUrl will default to the mapUrl base if it is an http: or https: scheme URL, and null otherwise keeping absolute URLs entirely in-tact.

  Parameters

  • mapUrl: string | URL = ...

    The new map URL to use
  • OptionalrootUrl: string | URL

    The new root URL to use

  Returns ImportMap

  ImportMap for chaining

resolve

• resolve(specifier: string, parentUrl?: string | URL): string

  Perform a module resolution against the import map

  Parameters

  • specifier: string

    Specifier to resolve
  • parentUrl: string | URL = ...

    Parent URL to resolve against

  Returns string

  Resolved URL string

toJSON

• toJSON(): IImportMap

  Get the import map JSON data

  Returns IImportMap

  Import map data

imports

scopes

integrity

mapUrl

rootUrl