andfaulkner / node-typescript-module-boilerplate

Boilerplate for a standalone node module intended for publication on npm

module boilerplate

• baseline for new standalone npm module projects

---

Usage

// example of code used in the README file
console.log('some __module_boilerplate_usage__ example');

---

Third-level heading

A regular paragraph, no bullet. Code below:

// Another code example

API

someFunctionInModuleBoilerplate

(varName: typeEg_string): returnTypeEg_number

• varName: description

Examples:

someFunctionInModuleBoilerplate('hello');
// => hello output

anotherModuleBoilerplateFunction

(anotherVarName: string) => next

• anotherVarName: description of argument
• next: (err: Error, filename: string): string
  • example of how a callback would be described