helping

Helping.js

This is a collection of generic Javascript functions that help in day to day programming. Many were collected from around the internet in which case attribution is included above the function. Please keep in mind that this collection was predominantly developed to meet my own needs.

Requirements

To use this project in Node.js requires Node 12.17 or later. The /dist/ directory contains ESM and UMD packages of the code for use outside of node, further details below.

Browser support

• UMD Package : [Details coming soon].
• ESM Package : All browsers that support ES Modules.

Installation

NPM : npm install helping
Yarn : yarn add helping

Usage

No default export is provided, each function should be imported individually. A list of functions are available in the documentation.

import { each, empty } from "helping";

CDN

We use jsDelivr for CDN access, check the /dist/ directory for a full list of files provided. If you're targeting newer browsers use the ES Module or for older browsers use the UMD package. Both minified and unminified versions are provided.

ES Module:

<script type="module">
  import {each, empty} from 'https://cdn.jsdelivr.net/npm/helping@latest/dist/helping.min.js';
  console.log(empty(''));
</script>

UMD:
The UMD package provides all functions under a global namespace called helping, if you wish to access individual functions as globals assign them to to window object using this method:

<script src="https://cdn.jsdelivr.net/npm/helping@latest/dist/helping.umd.min.js"></script>
<script>
  window.empty = helping.empty;
  console.log(empty(''));
</script>

Documentation

Documented using JSDoc and available here.

Contributing

Pull requests are welcome. Please fix bugs or make improvements to existing code. I might be reluctant to add new features as this project was mostly developed to meet my own needs but feel free to open an issue to discuss.

License

ISC © Sean Bannister.