@jsenv/template-node-package

The documentation below is part of the GitHub repository template. Check .github/README.md to read documentation about the template itself.

Node package title

This package is a demo for https://github.com/jsenv/jsenv-template-node-package. It is not meant to provide anything useful.

Installation

npm install @jsenv/template-node-package

1. Create example.js

import { getMessage } from "@jsenv/template-node-package"

console.log(getMessage())

2. Execute with node

> node ./example.js
Hello dev!

getMessage

getMessage is a function returning a string.

import { getMessage } from "@jsenv/template-node-package"

const message = getMessage()
message // "Hello dev!"

The returned string is different in production mode

getMessageAsync

getMessageAsync is like getMessage except it's an async function.

import { getMessageAsync } from "@jsenv/template-node-package"

const message = await getMessageAsync()
message // "Hello dev!"

Development

If you are part or want to be part of the developpers of this package, check development.md