Skip to content

Update docs re: input and cb args. #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
1 commit merged into from
Jan 24, 2015
Merged

Update docs re: input and cb args. #65

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions readme.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ $ node example/sync.js
var resolve = require('resolve')
```

## resolve(pkg, opts={}, cb)
## resolve(id, opts={}, cb)

Asynchronously resolve the module path string `pkg` into `cb(err, res)`.
Asynchronously resolve the module path string `id` into `cb(err, res [, pkg])`, where `pkg` (if defined) is the data from `package.json`.

options are:

* opts.basedir - directory to begin resolving from

* opts.package - package from which module is being loaded
* opts.package - `package.json` data applicable to the module being loaded

* opts.extensions - array of file extensions to search in order

Expand Down Expand Up @@ -86,10 +86,10 @@ default `opts` values:
}
```

## resolve.sync(pkg, opts)
## resolve.sync(id, opts)

Synchronously resolve the module path string `pkg`, returning the result and
throwing an error when `pkg` can't be resolved.
Synchronously resolve the module path string `id`, returning the result and
throwing an error when `id` can't be resolved.

options are:

Expand Down