https://github.com/richienb/typescript-boilerplate
Like node-module-boilerplate except for Typescript. Boilerplate to kickstart creating a Node.js module. Adapted from Richienb/node-module-boilerplate
https://github.com/richienb/typescript-boilerplate
Last synced: 9 months ago
JSON representation
Like node-module-boilerplate except for Typescript. Boilerplate to kickstart creating a Node.js module. Adapted from Richienb/node-module-boilerplate
- Host: GitHub
- URL: https://github.com/richienb/typescript-boilerplate
- Owner: Richienb
- License: mit
- Created: 2019-11-13T03:26:39.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-09-15T12:13:13.000Z (over 4 years ago)
- Last Synced: 2025-03-29T20:51:07.765Z (10 months ago)
- Language: TypeScript
- Homepage:
- Size: 463 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# the-module
My awesome module.
[](https://npmjs.com/package/the-module)
## Install
```sh
npm install the-module
```
## Usage
```js
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.