1.0.1 • Published 2 years ago

resolve-file-extension v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

resolve-file-extension

Resolve an absolute file path from a base filename.

Example

For example, this can be used to emulate the legacy Node.js "automatic" module resolution behavior you may be familiar with, where a file extension can be optionally omitted for specific file extensions such as .js and .json.

import { getFilePath } from 'resolve-file-extension';

await getFilePath('./example', ['.js', '.json']);
// "/path/to/example.js"

Installation

Install using npm:

npm install resolve-file-extension

API

getFilePath(baseFile: string, extension?: string[]): Promise<string|undefined>

Given a base file name and optional file extensions constraint, returns a promise which resolves to the first file path matching that base name and extension, or undefined if no file could be found. Extensions should be provided with a leading dot (".").

License

Copyright 2021 Andrew Duthie

Released under the MIT License.