JSPM

resolve-file

0.2.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 114861
  • Score
    100M100P100Q149603F
  • License MIT

Resolve an absolute file path from local directories, local node_modules or global node_modules.

Package Exports

  • resolve-file

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (resolve-file) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

resolve-file NPM version NPM downloads Build Status

Resolve an absolute file path from local directories, local node_modules or global node_modules.

Install

Install with npm:

$ npm install resolve-file --save

Usage

var resolveFile = require('resolve-file');

API

resolve

Resolve the path to a file located in one of the following places:

  • local to the current project ('./index.js')
  • absolute ('/usr/something.rc')
  • node module "main" file ('cwd')
  • specific file inside a node module ('cwd/LICENSE')
  • file located in user's home directory ('~/.npmrc')

Params

  • name {String}: Filename to resolve
  • options {Object}: Additional options to specify cwd
  • returns {String}: Resolved filepath if found

Example

var fp = resolve('./index.js')
//=> /path/to/resolve-file/index.js

.file

Resolve the path to a file located in one of the following places:

  • local to the current project ('./index.js')
  • absolute ('/usr/something.rc')
  • node module "main" file ('cwd')
  • specific file inside a node module ('cwd/LICENSE')
  • file located in user's home directory ('~/.npmrc')

Params

  • name {String}: Filename to resolve
  • options {Object}: Additional options to specify cwd
  • returns {Object}: File object with resolved path if found.

Example

var file = resolve.file('./index.js')
//=> {
//=>   cwd: '/path/to/resolve-file',
//=>   path: '/path/to/resolve-file/index.js'
//=> }

You might also be interested in these projects:

  • cwd: Easily get the CWD (current working directory) of a project based on package.json, optionally starting… more | homepage
  • expand-tilde: Bash-like tilde expansion for node.js. Expands a leading tilde in a file path to the… more | homepage
  • look-up: Faster drop-in replacement for find-up and findup-sync. | homepage
  • resolve: resolve like require.resolve() on behalf of files asynchronously and synchronously | homepage

Contributing

This document was generated by verb, please don't edit directly. Any changes to the readme must be made in .verb.md. See Building Docs.

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install -g verb verb-readme-generator && verb

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Brian Woodward

License

Copyright © 2016, Brian Woodward. Released under the MIT license.

This file was generated by verb, v0.9.0, on June 06, 2016.