# @types/npm-license-crawler

> TypeScript definitions for npm-license-crawler

Latest version **0.2.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/npm-license-crawler
pnpm add @types/npm-license-crawler
yarn add @types/npm-license-crawler
bun add @types/npm-license-crawler
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.2.3 |
| Published | 2023-11-07 |
| First published | 2019-01-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51439 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/npm-license-crawler
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/npm-license-crawler
- npm.io page: https://npm.io/package/@types/npm-license-crawler

## Recent versions

- 0.2.3 (latest) — 2023-11-07
- 0.2.1 (ts3.6) — 2021-07-08
- 0.2.0 (ts3.3) — 2020-11-30
- 0.1.0 (ts2.2) — 2019-01-31
- 0.2.2 — 2023-10-18

## README

# Installation
> `npm install --save @types/npm-license-crawler`

# Summary
This package contains type definitions for npm-license-crawler (https://github.com/mwittig/npm-license-crawler).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/npm-license-crawler.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/npm-license-crawler/index.d.ts)
````ts
export interface License {
    licenses: string;
    licenseUrl: string;
    parents: string;
    repository: string;
}

export interface Licenses {
    [repository: string]: License;
}

export interface CrawlerOptions {
    /** export the data as comma-separated values to the given file. The path will be created if it does not exist. */
    csv?: string | undefined;
    /** show only third-party licenses, i.e., only list the dependencies defined in package.json. */
    dependencies?: boolean | undefined;
    /** show only development dependencies */
    development?: boolean | undefined;
    /** path to a directory to be excluded (and its subdirectories) from the search. */
    exclude?: string | string[] | undefined;
    /** export data as JSON to the given file. The path will be created if it does not exist. */
    json?: string | undefined;
    /** omit version numbers in result (e.g. "npm-license-crawler@0.1.5" becomes "npm-license-crawler") */
    omitVersion?: boolean | undefined;
    /** show only direct dependencies licenses, i.e., don't list dependencies of dependencies. */
    onlyDirectDependencies?: boolean | undefined;
    /** show only production dependencies */
    production?: boolean | undefined;
    /** output the relative file path for license files. */
    relativeLicensePath?: boolean | undefined;
    /** path to the directory the license search should start from. If omitted the current working directory is assumed. */
    start: string | string[];
    /** show only licenses that can't be determined or have been guessed. */
    unknown?: boolean | undefined;
    /** don't show colors in the console output */
    noColor?: boolean | undefined;
}

export type Callback = (error: Error | null, licenses: Licenses) => void;

export function dumpLicenses(args: CrawlerOptions, callback: Callback): void;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [Florian Keller](https://github.com/ffflorian).

---
_Source: https://npm.io/package/@types/npm-license-crawler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._