README
typescript-npm-package-template
Template to kickstart creating a Node.js module using TypeScript and VSCode
Inspired by node-module-boilerplate
Getting started
Click the "Use this template" button.
Alternatively, create a new directory and then run:
curl -fsSL https://github.com/ryansonshine/typescript-npm-package-template/archive/main.tar.gz | tar -xz --strip-components=1
Remove everything from here and above
my-package-name
My awesome module
Install
npm install my-package-name
Usage
import { myPackage } from 'my-package-name';
myPackage('hello');
//=> 'hello from my package'
API
myPackage(input, options?)
input
Type: string
Lorem ipsum.
options
Type: object
postfix
Type: string
Default: rainbows
Lorem ipsum.