Class Generator

Generator.

Hierarchy

Generator

Index

Constructors

constructor

new Generator(opts?: GeneratorOptions): Generator

Constructs a new Generator instance.

For example:

const generator = new Generator({
  mapUrl: import.meta.url,
  inputMap: {
    "imports": {
      "react": "https://cdn.skypack.dev/react"
    }
  },
  defaultProvider: 'jspm',
  defaultRegistry: 'npm',
  providers: {
    '@orgscope': 'nodemodules'
  },
  customProviders: {},
  env: ['production', 'browser'],
  cache: false,
});

Parameters

opts: GeneratorOptions = {}

Configuration for the new generator instance.

Returns Generator

Properties

baseUrl

baseUrl: URL

installCnt

installCnt: number = 0

The number of concurrent installs the generator is busy processing.

integrity

integrity: boolean

log

log: Log

logStream

logStream: LogStream

map

map: ImportMap

mapUrl

mapUrl: URL

rootUrl

rootUrl: URL

traceMap

traceMap: default

Accessors

importMap

get importMap(): ImportMap
Returns ImportMap
- Defined in generator.ts:1169

Methods

`Private` _install

_install(install?: string | Install | (string | Install)[], mode?: InstallMode): Promise<void | {
dynamicDeps: string[];
staticDeps: string[];
}>
Parameters
- Optional install: string | Install | (string | Install)[]
- Optional mode: InstallMode
Returns Promise<void | {
dynamicDeps: string[];
staticDeps: string[];
}>
- Defined in generator.ts:866

addMappings

addMappings(jsonOrHtml: string | IImportMap, mapUrl?: string | URL, rootUrl?: string | URL, preloads?: string[]): Promise<string[]>
Add new custom mappings and lock resolutions to the input map of the generator, which are then applied in subsequent installs.

Returns
The list of modules pinned by this import map or HTML.
Parameters
- jsonOrHtml: string | IImportMap
  
  The mappings are parsed as a JSON data object or string, falling back to reading an inline import map from an HTML file.
- mapUrl: string | URL = ...
  
  An optional URL for the map to handle relative resolutions, defaults to generator mapUrl.
- rootUrl: string | URL = ...
  
  An optional root URL for the map to handle root resolutions, defaults to generator rootUrl.
- Optional preloads: string[]
Returns Promise<string[]>
- Defined in generator.ts:531

extractMap

extractMap(pins: string | string[], mapUrl?: string | URL, rootUrl?: string | URL, integrity?: boolean): Promise<{
    dynamicDeps: string[];
    map: IImportMap;
    staticDeps: string[];
}>
Parameters
- pins: string | string[]
- Optional mapUrl: string | URL
- Optional rootUrl: string | URL
- Optional integrity: boolean
Returns Promise<{
    dynamicDeps: string[];
    map: IImportMap;
    staticDeps: string[];
}>
- Defined in generator.ts:1123

getAnalysis

getAnalysis(url: string | URL): ModuleAnalysis
Parameters
- url: string | URL
Returns ModuleAnalysis
- Defined in generator.ts:1173

getLock

getLock(): LockResolutions
Retrieve the lockfile data from the installer

Returns LockResolutions
- Defined in generator.ts:563

getMap

getMap(mapUrl?: string | URL, rootUrl?: string | URL): IImportMap
Parameters
- Optional mapUrl: string | URL
- Optional rootUrl: string | URL
Returns IImportMap
- Defined in generator.ts:1188

htmlInject

htmlInject(html: string, opts?: {
    comment?: string | boolean;
    esModuleShims?: string | boolean;
    htmlUrl?: string | URL;
    integrity?: boolean;
    pins?: boolean | string[];
    preload?: boolean | "all" | "static";
    rootUrl?: string | URL;
    trace?: boolean | string[];
    whitespace?: boolean;
}): Promise<string>
Inject the import map into the provided HTML source

Returns
HTML source with import map injection
Parameters
- html: string
  
  HTML source to inject into
- opts: {
      comment?: string | boolean;
      esModuleShims?: string | boolean;
      htmlUrl?: string | URL;
      integrity?: boolean;
      pins?: boolean | string[];
      preload?: boolean | "all" | "static";
      rootUrl?: string | URL;
      trace?: boolean | string[];
      whitespace?: boolean;
  } = {}
  
  Injection options
  - Optional comment?: string | boolean
  - Optional esModuleShims?: string | boolean
  - Optional htmlUrl?: string | URL
  - Optional integrity?: boolean
  - Optional pins?: boolean | string[]
  - Optional preload?: boolean | "all" | "static"
  - Optional rootUrl?: string | URL
  - Optional trace?: boolean | string[]
  - Optional whitespace?: boolean
Returns Promise<string>
- Defined in generator.ts:654

install

install(install?: string | Install | (string | Install)[]): Promise<void | {
dynamicDeps: string[];
staticDeps: string[];
}>

Install a package target into the import map, including all its dependency resolutions via tracing.

Example

// Install a new package into the import map
await generator.install('react-dom');

// Install a package version and subpath into the import map (installs lit/decorators.js)
await generator.install('lit@2/decorators.js');

// Install a package version to a custom alias
await generator.install({ alias: 'react16', target: 'react@16' });

// Install a specific subpath of a package
await generator.install({ target: 'lit@2', subpath: './html.js' });

// Install an export from a locally located package folder into the map
// The package.json is used to determine the exports and dependencies.
await generator.install({ alias: 'mypkg', target: './packages/local-pkg', subpath: './feature' });

Parameters

Optional install: string | Install | (string | Install)[]

Package or list of packages to install into the import map.

Returns Promise<void | {
dynamicDeps: string[];
staticDeps: string[];
}>

link

link(specifier: string | string[], parentUrl?: string): Promise<{
dynamicDeps: string[];
staticDeps: string[];
}>
Link a module, installing all dependencies necessary into the map to support its execution including static and dynamic module imports.
Parameters
- specifier: string | string[]
  
  Module or list of modules to link
- Optional parentUrl: string
  
  Optional parent URL
Returns Promise<{
dynamicDeps: string[];
staticDeps: string[];
}>
- Defined in generator.ts:574

linkHtml

linkHtml(html: string | string[], htmlUrl?: string | URL): Promise<string[]>
Links every imported module in the given HTML file, installing all dependencies necessary to support its execution.
Parameters
- html: string | string[]
  
  HTML to link
- Optional htmlUrl: string | URL
  
  URL of the given HTML
Returns Promise<string[]>
- Defined in generator.ts:619

reinstall

reinstall(): Promise<{
dynamicDeps: string[];
staticDeps: string[];
}>
Locking install, retraces all top-level pins but does not change the versions of anything (similar to "npm ci").

Returns Promise<{
dynamicDeps: string[];
staticDeps: string[];
}>
- Defined in generator.ts:1003

resolve

resolve(specifier: string, parentUrl?: string | URL): string
Resolve a specifier using the import map.

Returns
Resolved URL string
Parameters
- specifier: string
  
  Module to resolve
- parentUrl: string | URL = ...
  
  ParentURL of module to resolve
Returns string
- Defined in generator.ts:1157

uninstall

uninstall(names: string | string[]): Promise<{
dynamicDeps: string[];
staticDeps: string[];
}>
Parameters
- names: string | string[]
Returns Promise<{
dynamicDeps: string[];
staticDeps: string[];
}>
- Defined in generator.ts:1090

update

update(pkgNames?: string | string[]): Promise<{
dynamicDeps: string[];
staticDeps: string[];
}>
Updates the versions of the given packages to the latest versions compatible with their parent's package.json ranges. If no packages are given then all the top-level packages in the "imports" field of the initial import map are updated.
Parameters
- Optional pkgNames: string | string[]
  
  Package name or list of package names to update.
Returns Promise<{
dynamicDeps: string[];
staticDeps: string[];
}>
- Defined in generator.ts:1022

Generated using TypeDoc

jspm

Class Generator

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

opts: GeneratorOptions = {}

Returns Generator

Properties

baseUrl

installCnt

integrity

log

logStream

map

mapUrl

rootUrl

traceMap

Accessors

importMap

Returns ImportMap

Methods

Private _install

Parameters

Optional install: string | Install | (string | Install)[]

Optional mode: InstallMode

Returns Promise<void | { dynamicDeps: string[]; staticDeps: string[]; }>

addMappings

Returns

Parameters

jsonOrHtml: string | IImportMap

mapUrl: string | URL = ...

rootUrl: string | URL = ...

Optional preloads: string[]

Returns Promise<string[]>

extractMap

Parameters

pins: string | string[]

Optional mapUrl: string | URL

Optional rootUrl: string | URL

Optional integrity: boolean

Returns Promise<{ dynamicDeps: string[]; map: IImportMap; staticDeps: string[]; }>

getAnalysis

Parameters

url: string | URL

Returns ModuleAnalysis

getLock

Returns LockResolutions

getMap

Parameters

Optional mapUrl: string | URL

Optional rootUrl: string | URL

Returns IImportMap

htmlInject

Returns

Parameters

html: string

opts: { comment?: string | boolean; esModuleShims?: string | boolean; htmlUrl?: string | URL; integrity?: boolean; pins?: boolean | string[]; preload?: boolean | "all" | "static"; rootUrl?: string | URL; trace?: boolean | string[]; whitespace?: boolean; } = {}

Optional comment?: string | boolean

Optional esModuleShims?: string | boolean

Optional htmlUrl?: string | URL

Optional integrity?: boolean

Optional pins?: boolean | string[]

Optional preload?: boolean | "all" | "static"

Optional rootUrl?: string | URL

Optional trace?: boolean | string[]

Optional whitespace?: boolean

Returns Promise<string>

install

Example

Parameters

Optional install: string | Install | (string | Install)[]

Returns Promise<void | { dynamicDeps: string[]; staticDeps: string[]; }>

link

Parameters

`Private` _install

`Optional` install: string | Install | (string | Install)[]

`Optional` mode: InstallMode

Returns Promise<void | {
dynamicDeps: string[];
staticDeps: string[];
}>

`Optional` preloads: string[]

`Optional` mapUrl: string | URL

`Optional` rootUrl: string | URL

`Optional` integrity: boolean

Returns Promise<{
dynamicDeps: string[];
map: IImportMap;
staticDeps: string[];
}>

`Optional` mapUrl: string | URL

`Optional` rootUrl: string | URL

opts: {
comment?: string | boolean;
esModuleShims?: string | boolean;
htmlUrl?: string | URL;
integrity?: boolean;
pins?: boolean | string[];
preload?: boolean | "all" | "static";
rootUrl?: string | URL;
trace?: boolean | string[];
whitespace?: boolean;
} = {}

`Optional` comment?: string | boolean

`Optional` esModuleShims?: string | boolean

`Optional` htmlUrl?: string | URL

`Optional` integrity?: boolean

`Optional` pins?: boolean | string[]

`Optional` preload?: boolean | "all" | "static"

`Optional` rootUrl?: string | URL

`Optional` trace?: boolean | string[]

`Optional` whitespace?: boolean

`Optional` install: string | Install | (string | Install)[]

Returns Promise<void | {
dynamicDeps: string[];
staticDeps: string[];
}>

`Optional` parentUrl: string

Returns Promise<{
dynamicDeps: string[];
staticDeps: string[];
}>

`Optional` htmlUrl: string | URL

Returns Promise<{
dynamicDeps: string[];
staticDeps: string[];
}>

Returns Promise<{
dynamicDeps: string[];
staticDeps: string[];
}>

`Optional` pkgNames: string | string[]

Returns Promise<{
dynamicDeps: string[];
staticDeps: string[];
}>