Class ImportMap

Hierarchy

ImportMap

Implements

IImportMap

Index

Constructors

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
- Defined in map.ts:42

Properties

imports

imports: Record<string, string> = ...

mapUrl

mapUrl: URL

The absolute URL of the import map, for determining relative resolutions When using file:/// URLs this allows relative modules to be co-located

rootUrl

rootUrl: URL

The URL to use for root-level resolutions in the import map If null, root resolutions are not resolved and instead left as-is

By default, rootUrl is null unless the mapUrl is an http or https URL, in which case it is taken to be the root of the mapUrl.

scopes

scopes: Record<string, Record<string, string>> = ...

Methods

clone

clone(): ImportMap
Clones the import map

Returns
Cloned import map

Returns ImportMap
- Defined in map.ts:77

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 for chaining

Returns ImportMap
- Defined in map.ts:178

extend

extend(map: IImportMap, overrideScopes?: boolean): ImportMap
Extends the import map mappings

Returns
ImportMap for chaining
Parameters
- map: IImportMap
  
  Import map to extend with
- overrideScopes: boolean = false
  
  Set to true to have scopes be replacing instead of extending
Returns ImportMap
- Defined in map.ts:89

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 for chaining

Returns ImportMap
- Defined in map.ts:291

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.

Returns
ImportMap for chaining
Parameters
- mapUrl: string | URL = ...
  
  The new map URL to use
- Optional rootUrl: string | URL
  
  The new root URL to use
Returns ImportMap
- Defined in map.ts:380

replace

replace(url: string, newUrl: string): ImportMap
Bulk replace URLs in the import map Provide a URL ending in "/" to perform path replacements

Returns
ImportMap for chaining
Parameters
- url: string
  
  {String} The URL to replace
- newUrl: string
  
  {String} The URL to replace it with
Returns ImportMap
- Defined in map.ts:142

resolve

resolve(specifier: string, parentUrl?: string | URL): string
Perform a module resolution against the import map

Returns
Resolved URL string
Parameters
- specifier: string
  
  Specifier to resolve
- parentUrl: string | URL = ...
  
  Parent URL to resolve against
Returns string
- Defined in map.ts:463

set

set(name: string, target: string, parent?: string): ImportMap
Set a specific entry in the import map

Returns
ImportMap for chaining
Parameters
- name: string
  
  Specifier to set
- target: string
  
  Target of the map
- Optional parent: string
  
  Optional parent scope
Returns ImportMap
- Defined in map.ts:124

sort

sort(): ImportMap
Performs an alphanumerical sort on the import map imports and scopes

Returns
ImportMap for chaining

Returns ImportMap
- Defined in map.ts:108

toJSON

toJSON(): IImportMap
Get the import map JSON data

Returns
Import map data

Returns IImportMap
- Defined in map.ts:532

Generated using TypeDoc

jspm

Class ImportMap

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

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

Returns ImportMap

Properties

imports

mapUrl

rootUrl

scopes

Methods

clone

Returns

Returns ImportMap

combineSubpaths

Returns

Returns ImportMap

extend

Returns

Parameters

map: IImportMap

overrideScopes: boolean = false

Returns ImportMap

flatten

Returns

Returns ImportMap

rebase

Returns

Parameters

mapUrl: string | URL = ...

Optional rootUrl: string | URL

Returns ImportMap

replace

Returns

Parameters

url: string

newUrl: string

Returns ImportMap

resolve

Returns

Parameters

specifier: string

parentUrl: string | URL = ...

Returns string

set

Returns

Parameters

name: string

target: string

Optional parent: string

Returns ImportMap

sort

Returns

Returns ImportMap

toJSON

Returns

Returns IImportMap

Settings

Member Visibility

Theme

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

`Optional` rootUrl: string | URL

`Optional` parent: string