Skip to content

Repository files navigation

eliware.org

@eliware/module-template npm versionlicensebuild status

A module-template for Node.js (Insert Brief Description)


Table of Contents

Features

  • Minimal ESM package structure for new Node.js libraries
  • Jest, coverage, lint, TypeScript, and package validation scripts
  • Public entrypoint, declarations, README, license, and safe example layout

Requirements

  • Node.js 26 or newer

Installation

npm install @eliware/module-template

Usage

ESM Example

// Example for ESM (module JS) usage

API

method1 signature

description

method2 signature

description

... etc ...

TypeScript

Type definitions are included:

Errors / Troubleshooting

This repository is a starting template, not a complete application. Replace placeholder API text and examples before publishing a specialized module. Keep runtime exports, declarations, tests, and README synchronized.

Development

npm test
npm run test:gaps
npm run lint
npm run typecheck
npm run pack

Customize package metadata, API behavior, tests, and documentation before using this as a production library.

Security

Keep examples credential-free and do not add secrets, .env files, private URLs, or credentials to the template. Review dependencies and package contents before distributing a derived module.

Support

For help, questions, or to chat with the author and community, visit:

Discordeliware.org

eliware.org on Discord

License

MIT © 2025 Eli Sterling, eliware.org

Links