Node Module Template

A GitHub template repo for node modules

About This Template

This template is designed for creating Node.js library modules - packages that provide reusable functionality to other projects.

When to use this template:

• Building npm libraries and utilities
• Creating shared code modules
• Developing packages without CLI or server components

Related templates:

• node-cli-template - For command-line tools and CLI applications
• node-app-template - For web servers, REST APIs, and long-running services

For detailed coding guidelines and GitHub Copilot instructions, see .github/copilot-instructions.md

Usage

import { something } from '@voxpelli/node-module-template';

// Use that something

API

something()

Takes a value (input), does something configured by the config (configParam) and returns the processed value asyncly(output)

Syntax

something(input, [options]) => Promise<true>

Arguments

• input – string – the input of the method
• options – SomethingOptions – optional options

SomethingOptions

• maxAge – number – the maximum age of latest release to include
• minDownloadsLastMonth = 400 – number – the minimum amount of downloads needed to be returned
• skipPkg – boolean – when set skips resolving package.json

Returns

A Promise that resolves to true

Used by

• example – used by this one to do X and Y

Similar modules

• example – is similar in this way

See also

• Announcement blog post
• Announcement tweet