Skip to content

Boilerplate to kickstart creating a Node.js module. Adapted from sindresorhus/node-module-boilerplate

License

Notifications You must be signed in to change notification settings

Richienb/node-module-boilerplate

 
 

Repository files navigation

the-module

My awesome module.

Install

npm install the-module

Usage

import theModule from 'the-module';

theModule('unicorns');
//=> 'unicorns & rainbows'

API

theModule(input, options?)

input

Type: string

Lorem ipsum.

options

Type: object

postfix

Type: string
Default: rainbows

Lorem ipsum.

About

Boilerplate to kickstart creating a Node.js module. Adapted from sindresorhus/node-module-boilerplate

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Languages

  • JavaScript 80.6%
  • TypeScript 19.4%