Class: DescriptionParser

Defined in:

src\components\description.coffee

Overview

Creates a description

Variables Summary

name =

"DescriptionParser"

Instance Method Summary

# (void) run(pkg) Create license information by concatenating options.addDescription to pkg.description, separated by two line breaks.

Constructor Details

# (void) constructor(options)

Creates a new DescriptionParser that enhances the description. addDescription can optionally be given as an array of strings that will be concatenated by the module. This is to enhance readability of package.json

Parameters:

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

Options Hash: (options):

addDescription ( String ) — Additional text for the description ['']

Instance Method Details

# (void) run(pkg)

Create license information by concatenating options.addDescription to pkg.description, separated by two line breaks. @returns [Promise] The description

Parameters:

pkg ( Object ) — package.json data