Skip to content

Commit

Permalink
docs: Update result object documentation for type=alias
Browse files Browse the repository at this point in the history
  • Loading branch information
oBusk authored and wraithgar committed Feb 10, 2022
1 parent 8cb4527 commit 55907a9
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ keys:
* `file` - A local `.tar.gz`, `.tar` or `.tgz` file.
* `directory` - A local directory.
* `remote` - An http url (presumably to a tgz)
* `alias` - A specifier with an alias, like `myalias@npm:foo@1.2.3`
* `registry` - If true this specifier refers to a resource hosted on a
registry. This is true for `tag`, `version` and `range` types.
* `name` - If known, the `name` field expected in the resulting pkg.
Expand All @@ -81,3 +82,5 @@ keys:
JSON.
* `raw` - The original un-modified string that was provided. If called as
`npa.resolve(name, spec)` then this will be `name + '@' + spec`.
* `subSpec` - If `type === 'alias'`, this is a Result Object for parsing the
targer specifier for the alias.

0 comments on commit 55907a9

Please # to comment.