From 55907a917979e566250428dc6da9aad8fd4fb65a Mon Sep 17 00:00:00 2001 From: Oscar Busk Date: Wed, 21 Jul 2021 00:00:47 +0200 Subject: [PATCH] docs: Update result object documentation for type=alias --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 847341b..7e28305 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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.