Есть ли в пакетах NPM «справочные страницы» или `—помощь`

#javascript #node.js #npm #ecmascript-6

Вопрос:

Подобно тому, как у многих команд Linux есть man страницы, есть ли у пакетов NPM что-то подобное?

В качестве примера, прямо сейчас я хочу почитать об Promise.resolve() этом . Должен ли я идти в https://www.npmjs.com/package/promise чтобы прочитать об этом, или я могу как-то прочитать справку в автономном режиме?

Комментарии:

1. вам нужна помощь для команд npm или пакетов npm ?

2. Пакеты обычно поставляются с Readme.md файлом, просто перейдите в их каталог пакетов и откройте его. Он находится в уценке, поэтому вам может понадобиться анализатор md, чтобы правильно его просмотреть, но в противном случае вы сможете его прочитать. Не уверен, есть ли опция команды для npm и т. Д., Чтобы автоматически найти и прочитать ее

3. Пакеты NPM @HDM91

4. Как правило, там нет man страниц. Однако часто, если пакет из реестра npm является инструментом командной строки, т. Е. Предоставляет инструменты командной строки, он может содержать страницу справки . Например, чтобы получить доступ к справочной странице eslint , которую вы должны запустить eslint --help (если она установлена глобально). Если eslint он установлен локально в каталоге проекта, то вам cd нужно перейти в каталог проекта и запустить ./node_modules/.bin/eslint --help .

5. npm docs packagename попытается найти URL-адрес документации пакета и запустить браузер для перехода к нему, но он не находится в автономном режиме