Class NodePackageFS

Node.js-specific implementation of package file system.

Hierarchy

PackageFS
- NodePackageFS

Index

Constructors

`Protected` constructor

new NodePackageFS(): NodePackageFS
Constructs file system with the given root.

The file system has to be initialized after construction.

Use static create method instead to create file system instances.

Returns NodePackageFS
Overrides PackageFS.constructor
- Defined in fs/node-package-fs.ts:38

Accessors

fsRoot

get fsRoot(): string
File system root URL.

Returns string
- Defined in fs/node-package-fs.ts:94

root

get root(): string
URI of the root package.

Returns string
Overrides PackageFS.root
- Defined in fs/node-package-fs.ts:87

Methods

derefEntry

derefEntry(host, spec): Promise<undefined | string>
Dereferences package entry.
Parameters
- host: PackageResolution
  
  Host package which entry to resolve.
- spec: Package | Entry | Private
  
  Package or its entry import specifier.
Returns Promise<undefined | string>
Promise resolved to either module URI, or undefined if nothing to dereference.
Overrides PackageFS.derefEntry
- Defined in fs/node-package-fs.ts:281

findPackageDir

findPackageDir(uri): Promise<undefined | PackageDir>
Searches for package directory containing the given file or URI.
Parameters
- uri: string
  
  URI of the target file or directory.
Returns Promise<undefined | PackageDir>
Promise resolved to either enclosing package directory, or undefined if not found.
Inherited from PackageFS.findPackageDir
- Defined in fs/package-fs.ts:122

init

init(root?): Promise<NodePackageFS>
Initializes FS.

This method has to be called prior to start using the FS.
Parameters
- Optional root: string
  
  URL or path of the root directory. Defaults to current working directory.
Returns Promise<NodePackageFS>
Promise resolved to this instance.
- Defined in fs/node-package-fs.ts:51

loadPackage

loadPackage(uri): Promise<undefined | PackageInfo>
Tries to load package info from the given directory.

By default, detects package info by the loaded package.json contents.
Parameters
- uri: string
  
  Source directory.
Returns Promise<undefined | PackageInfo>
Promise resolved to either loaded package info contents, or undefined if directory does not contain valid package.json file.
Overrides PackageFS.loadPackage
- Defined in fs/node-package-fs.ts:244

parentDir

parentDir(uri): undefined | string
Finds parent directory.
Parameters
- uri: string
  
  File or directory URI.
Returns undefined | string
Either URI of the parent directory, or undefined if there is no one.
Overrides PackageFS.parentDir
- Defined in fs/node-package-fs.ts:263

recognizeImport

recognizeImport(spec): Import
Recognizes Node.js import specifier and parses it accordingly.

In addition to imports recognized by recognizeImport, this method recognizes Node.js built-ins and Windows/Unix paths.
Parameters
- spec: string
  
  Import specifier to recognize. May be recognized already.
Returns Import
Recognized import specifier.
Overrides PackageFS.recognizeImport
- Defined in fs/node-package-fs.ts:108

recognizePackageURI

recognizePackageURI(importSpec): undefined | string
Extracts package URI from compatible URI import specifier.
Parameters
- importSpec: URI
  
  Absolute URI import specifier.
Returns undefined | string
Either package URI, or undefined if the URI can not be used to access packages.
Overrides PackageFS.recognizePackageURI
- Defined in fs/node-package-fs.ts:240

resolveName

resolveName(relativeTo, name): Promise<undefined | string>
Resolves a package by name against another one.

Note that returned URI is not necessary the one of package directory. Call findPackageDir in order to find one.
Parameters
- relativeTo: PackageResolution
  
  Package to resolve another one against.
- name: string
  
  Package name to resolve.
Returns Promise<undefined | string>
Promise resolved to either module URI, or undefined if the name can not be resolved.
Overrides PackageFS.resolveName
- Defined in fs/node-package-fs.ts:274

resolvePath

resolvePath(relativeTo, path): string
Resolves path relatively to package.

By default, uses URI resolution.
Parameters
- relativeTo: ImportResolution<Import>
  
  The base to resolve the path against.
- path: string
  
  Path or URI to resolve.
Returns string
URI of the resolved path.
Inherited from PackageFS.resolvePath
- Defined in fs/package-fs.ts:77

`Static` create

create(root?): Promise<NodePackageFS>
Creates new file system instance.
Parameters
- Optional root: string
  
  URL or path of the root directory. Defaults to current working directory.
Returns Promise<NodePackageFS>
- Defined in fs/node-package-fs.ts:17

Class NodePackageFS

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

Protected constructor

Returns NodePackageFS

Accessors

fsRoot

Returns string

root

Returns string

Methods

derefEntry

Parameters

host: PackageResolution

spec: Package | Entry | Private

Returns Promise<undefined | string>

findPackageDir

Parameters

uri: string

Returns Promise<undefined | PackageDir>

init

Parameters

Optional root: string

Returns Promise<NodePackageFS>

loadPackage

Parameters

uri: string

Returns Promise<undefined | PackageInfo>

parentDir

Parameters

uri: string

Returns undefined | string

recognizeImport

Parameters

spec: string

Returns Import

recognizePackageURI

Parameters

importSpec: URI

Returns undefined | string

resolveName

Parameters

relativeTo: PackageResolution

name: string

Returns Promise<undefined | string>

resolvePath

Parameters

relativeTo: ImportResolution<Import>

path: string

Returns string

Static create

Parameters

Optional root: string

Returns Promise<NodePackageFS>

Settings

Member Visibility

Theme

On This Page

`Protected` constructor

`Optional` root: string

`Static` create

`Optional` root: string