README.md

nodemod

A collection of node modules for The Really Project

---

Helper functions made specifically for The Really Project. All modules are shipped in ES Modules and users are required to create their own CJS builds if needed, or use esm for bundle-less module loader.

Table of contents

• Pre-requisites
• Install
• Usage
• Available modules
• Deno equivalent
• License

Pre-requisites

• Node.js >= 14.17.3
• NPM >= 6.14.13 (NPM comes with Node.js so there is no need to install separately.)
• ES Modules

Install

# Install via NPM
$ npm i nodemod

# [OPTIONAL] Only install this as `devDependencies` if you do not use
# any bundler or compiler for your project. Note that all modules are 
# exported using ES modules. See Usage section for more details.
$ npm i -D esm

Usage

All modules are exported using JavaScript's ES modules. Users are recommended to use esm to run their scripts.

// index.js
import { html } from 'nodemod/dist/lit-ntml/index.js';

await html`<h1>Hello, World!</h1>`;

$ node -r esm index.js # Run script with `esm` to transpile ES Modules on the fly.

Available modules

• calendar - Minimal module to compute a calendar
• deep-clone - Simple and fast deep cloning
• delay-until - A typical delay function but Promise based
• fetch-as - Simple fetch helper with type resolver
• lit-ntml - Expressive HTML Templates
• normalize-diacritics - Remove accents/ diacritics in string
• polling-observer - A new way of running polling function with observer pattern
• scryptify - A stronger encryption and decryption in Node.js
• signatur - Sign and unsign HTTP request with ease
• utc-date - Generate UTC date with various offsets
• utc-time - Generate UTC time with various offsets

Deno equivalent

Showing some ❤️ and support for deno.

• deno_mod

License

MIT License © Rong Sen Ng