Class: LicenseParser

Defined in:

src\components\license.coffee

Overview

Creates license information

Variables Summary

name =

"LicenseParser"

Instance Method Summary

# (void) run(pkg)
Create license information @returns [Promise
] License information {name: string, file: string}
Constructor Details
# (void) constructor(options)

Creates a new LicenseParser that checks whether a license file exists and gives its url

Parameters:

(options) ( Object ) — An optional set of options

Options Hash: (options):

encoding ( String ) — Encoding for reading the file ['utf-8']

licenseFile ( String ) — Location of the license file ['LICENSE']
Instance Method Details
# (void) run(pkg)

Create license information @returns [Promise