PathResolver

Index

Constructors

• constructor

Methods

• getLookupPaths
• lookupFilePath
• lookupFilePathWithExts
• lookupNodeModule
• resolve
• resolvePath
• defaultResolver

Constructors

constructor

• new PathResolver(resolver?: ModuleResolver): PathResolver

Methods

getLookupPaths

• getLookupPaths(): string[]

• Return a list of all lookup paths.

lookupFilePath

• lookupFilePath(filePath: PortablePath, cwd?: PortablePath): this

• Add a file system path to look for, resolved against the defined current working directory (or process.cwd() otherwise).

lookupFilePathWithExts

• lookupFilePathWithExts(filePath: PortablePath, exts: string[], cwd?: PortablePath): this

• Add a file system path with a list of possible extensions to look for, resolved against the defined current working directory (or process.cwd() otherwise).

lookupNodeModule

• lookupNodeModule(moduleId: PortablePath): this

• Add a Node.js module, either by name or relative path, to look for.

resolve

• resolve(startDir?: PortablePath): Promise<ResolvedLookup>

• Given a list of lookups, attempt to find the first real/existing path and return a resolved absolute path. If a file system path, will check using fs.exists. If a node module path, will check using the provided resolver.

resolvePath

• resolvePath(): Promise<Pathable>

• Like resolve() but only returns the resolved file path.

staticdefaultResolver

• defaultResolver(path: string, startDir?: string): Promise<string>