> Fetch a package's description from NPM.
Uses [cross-fetch-json](https://npmjs.com/package/cross-fetch-json) to support usage in both brower and node.
## Installation
```bash
yarn add npm-description
```
```bash
npm install npm-description
```
## API
### Usage
```ts
import { getDescription, getDescriptions } from "npm-description";
getDescription("chalk").then((result) => {
console.log(result); // "Terminal string styling done right"
});
getDescriptions(["chalk", "commander"]).then((result) => {
console.log(result.chalk); // "Terminal string styling done right"
console.log(result.commander); // "the complete solution for node.js command-line programs"
});
```
### Types
```ts
import { getDescription, getDescriptions, Descriptions } from "npm-description";
function getDescription(name: string): Promise;
function getDescriptions(names: string[]): Promise;
export type Descriptions = {
[name: string]: string | undefined;
};
```
Dependencies
- [cross-fetch-json](https://npmjs.com/package/cross-fetch-json): Universal fetch API that only returns JSON
##
Dev Dependencies
- [@bconnorwhite/bob](https://npmjs.com/package/@bconnorwhite/bob): Bob is a toolkit for TypeScript projects
- [jest](https://npmjs.com/package/jest): Delightful JavaScript Testing.
##
License 
[MIT](https://mit-license.org/)
## Related Packages:
- [all-package-names](https://npmjs.com/package/all-package-names): Get all NPM package names.
- [npms-io-client](https://npmjs.com/package/npms-io-client): A universal typed npms.io client
- [is-name-taken](https://npmjs.com/package/is-name-taken): Check if an NPM package name is taken
