`thizz`

Installation

PNPM (recommended)

pnpm i thizz

Yarn (also good)

yarn add thizz

NPM (if you must...)

npm i --save thizz

Usage

thizz packages its modules as both ESM and CJS (CommonJS/Node), and is fully treeshakeable (ESM only).

ES Modules

Namespaced import: all methods

import * as thizz from 'thizz';

This will construct a namespace of thizz, with methods like thizz.isString()

Named imports: cherry-picked methods

import { isWeakMap, isRegExp } from 'thizz';

If possible, I recommend tree-shaking individual methods instead. See below.

Tree-shaking: default or named imports

import isNaN from 'thizz/isNaN';
// or
import { isNaN } from 'thizz/isNaN';

Read: more info on Tree Shaking at MDN

CommonJS

CommonJS (or CJS), the variant of JavaScript popularized by Node.js, is supported but not recommended. It is only included for compatibility purposes at this point.

const { isArray, isPromise } = require('thizz');
const isNil = require('thizz/isNil');

Note: Treeshaking and code-splitting are not supported features of CJS.

Contributing

One of the most overlooked aspects of the Open Source community is the impact of contributions. Projects like thizz depend on contributions from other members like yourself to stay alive and thrive. Furthermore, your contributions are the cornerstone of why the open source is such an amazing place to learn, inspire, and create.

Any contributions you make are greatly appreciated. Seriously. A lot.

Contribution Guidelines

If you're new here, get comfortable with the [Contribution Guidelines].
Please familiarize yourself with the community's Code of Conduct beforehand.
Create an individual PR for each feature added (or change made) to the API.
Please proofread and double-check your spelling/grammar for mistakes.

Creating a Pull Request

Note: This section uses gh, the GitHub CLI. You should too.

Fork the project

  gh repo fork nberlette/thizz

Create your feature branch

  git checkout -b feature/isAwesome

here is where you hack, hack, hack...

Add and commit your changes

  git add src/isAwesome.js
  git commit -m 'Added feature isAwesome.js...'

Important: please verify + sign all commits with PGP — see docs.github.com.

Push to your fork's Feature Branch

  git push -u origin feature/isAwesome

Open a Pull Request

# Using the GitHub CLI
gh pr create --title "[feature]: thizz.isAwesome - returns true if you're cool"