@bemoje/node-lib-template

@bemoje/node-lib-template

Node library template package with full ESM support. All features available as npm scripts: Jest testing. Rollup build. Rename package - affecting all relevant files. Readme generator. Markdown and HTML API-documentation. Npm publish and version bumping. Github repository create, delete and commit. Jsdoc block comment description triggers package description updates. Package keyword-extraction from block comments in source code.

Version

Travis CI

Dependencies

Stats

Donate

Installation

npm install @bemoje/node-lib-template
npm install --save @bemoje/node-lib-template
npm install --save-dev @bemoje/node-lib-template

Usage

import nodeLibTemplate from '@bemoje/node-lib-template'

nodeLibTemplate()
//=> undefined

Tests

Uses Jest to test module functionality. Run tests to get coverage details.

npm run test

API

Table of Contents

• nodeLibTemplate

  • Parameters

• theCallback

  • Parameters

• Addable

  • Parameters

  • add

    • Parameters

nodeLibTemplate

Node library template package with full ESM support. All features available as npm scripts: Jest testing. Rollup build. Rename package - affecting all relevant files. Readme generator. Markdown and HTML API-documentation. Npm publish and version bumping. Github repository create, delete and commit. Jsdoc block comment description triggers package description updates. Package keyword-extraction from block comments in source code.

Parameters

• num number number

• name string name

• callback theCallback An addable instance is passed to the callback.

Returns void

theCallback

Callback type definition.

Type: Function

Parameters

• addable Addable The string

Returns void

Addable

Extends Number

A class that extends the native Number-class and

Parameters

• num number The number

• name (optional, default 'myAddable')

add

Adds 'n'

Parameters

• n number The number to add

Returns Addable