Installations

npm install @types/npm-license-crawler

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Pull Requests

Open

159

Total

60,617

Closed

9,563

Merged

50,895

Issues

Open

560

Total

8,070

Closed

7,510

Releases

1

0.1.450

Published on 04 Sept 2019

View all 1 releases

Contributors

9,977

View all 9,977 contributors

Languages

3

TypeScript

JavaScript

Shell

TypeScript (99.9%)

JavaScript (0.09%)

Shell (0.01%)

Developer

DefinitelyTyped

Download Statistics

Total Downloads

173,634

Last Day

39

Last Week

226

Last Month

1,096

Last Year

36,301

GitHub Statistics

49,096 Stars

88,626 Commits

30,291 Forks

640 Watching

5 Branches

9,977 Contributors

Maintainers

1

Package Meta Information

Latest Version

0.2.3

Package Id

@types/npm-license-crawler@0.2.3

Unpacked Size

6.18 kB

Size

2.09 kB

File Count

5

Publised On

07 Nov 2023

Total Downloads

Cumulative downloads

Total Downloads

173,634

Last day

50%

39

Compared to previous day

Last week

-15.7%

226

Compared to previous week

Last month

-44.2%

1,096

Compared to previous month

Last year

-35.1%

36,301

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

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

1export interface License {
2    licenses: string;
3    licenseUrl: string;
4    parents: string;
5    repository: string;
6}
7
8export interface Licenses {
9    [repository: string]: License;
10}
11
12export interface CrawlerOptions {
13    /** export the data as comma-separated values to the given file. The path will be created if it does not exist. */
14    csv?: string | undefined;
15    /** show only third-party licenses, i.e., only list the dependencies defined in package.json. */
16    dependencies?: boolean | undefined;
17    /** show only development dependencies */
18    development?: boolean | undefined;
19    /** path to a directory to be excluded (and its subdirectories) from the search. */
20    exclude?: string | string[] | undefined;
21    /** export data as JSON to the given file. The path will be created if it does not exist. */
22    json?: string | undefined;
23    /** omit version numbers in result (e.g. "npm-license-crawler@0.1.5" becomes "npm-license-crawler") */
24    omitVersion?: boolean | undefined;
25    /** show only direct dependencies licenses, i.e., don't list dependencies of dependencies. */
26    onlyDirectDependencies?: boolean | undefined;
27    /** show only production dependencies */
28    production?: boolean | undefined;
29    /** output the relative file path for license files. */
30    relativeLicensePath?: boolean | undefined;
31    /** path to the directory the license search should start from. If omitted the current working directory is assumed. */
32    start: string | string[];
33    /** show only licenses that can't be determined or have been guessed. */
34    unknown?: boolean | undefined;
35    /** don't show colors in the console output */
36    noColor?: boolean | undefined;
37}
38
39export type Callback = (error: Error | null, licenses: Licenses) => void;
40
41export function dumpLicenses(args: CrawlerOptions, callback: Callback): void;
42

Additional Details

Last updated: Tue, 07 Nov 2023 09:09:39 GMT
Dependencies: none

Credits

These definitions were written by Florian Keller.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

9

License

Determines if the project has defined a license.

8

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More