Skip to content

Commit 55907a9

Browse files
oBuskwraithgar
authored andcommitted
docs: Update result object documentation for type=alias
1 parent 8cb4527 commit 55907a9

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ keys:
5858
* `file` - A local `.tar.gz`, `.tar` or `.tgz` file.
5959
* `directory` - A local directory.
6060
* `remote` - An http url (presumably to a tgz)
61+
* `alias` - A specifier with an alias, like `myalias@npm:[email protected]`
6162
* `registry` - If true this specifier refers to a resource hosted on a
6263
registry. This is true for `tag`, `version` and `range` types.
6364
* `name` - If known, the `name` field expected in the resulting pkg.
@@ -81,3 +82,5 @@ keys:
8182
JSON.
8283
* `raw` - The original un-modified string that was provided. If called as
8384
`npa.resolve(name, spec)` then this will be `name + '@' + spec`.
85+
* `subSpec` - If `type === 'alias'`, this is a Result Object for parsing the
86+
targer specifier for the alias.

0 commit comments

Comments
 (0)