@zerodep/guard.errors NPM

@zerodep/errors

All @zerodep/guard packages throw ZeroDepErrorGuard errors. This error extends the ZeroDepError.

The ZeroDepErrorGuard is further subclassed with:

ZeroDepErrorGuardType - for invalid types
ZeroDepErrorGuardRange - for values that are outside of specific ranges

Guards & Errors

We have an opinion about when appropriately throwing errors.

The spirit/intention of guards is to protect functions from incorrect runtime values that would otherwise cause defects in the software.

All guards will throw a ZeroDepErrorGuard (or instance thereof) error when they encounter an invalid value.

Extending Errors

The ZeroDepErrorGuard object includes the standard Error fields (message, stack and name) as wel as:

category of the error (type, range, reference, syntax, uri, or unknown)
source of the error within the @zerodep ecosystem (a guard, network, storage, etc)
value of the problem (the string|number|array|object that caused the issue, if there is one. We have found this incredibly useful in Promise.all() and similar situations)

Why category, you ask? The word type would be semantically most appropriate, followed closely by class. Typescript already has a type property on its errors. class is a reserved word. Some editors treat type in a special manner. We want to avoid collisions with other libraries.

We add the above fields to each of our errors, while ensuring the message, stack and name values of the Error work as expected to ensure any existing code works as expected. We also ALWAYS add a message, which should simplify error logging.

Install

This package is available from three differently sized and tree shakeable, npm packages:

// entire zerodep utils suite
npm install @zerodep/utils

// all @zerodep/guard utilities
npm install @zerodep/guard

// all @zerodep/guard errors
npm install @zerodep/guard.errors

Of course, you may use yarn, pnpm, or the package manager of your choice. Only npm examples are shown for brevity.

For completeness, links to the @zerodep repositories with this function:

How to Use

Guard Error

import { ZeroDepErrorGuard } from '@@zerodep/utils';
// or
import { ZeroDepErrorGuard } from '@@zerodep/guard';
// or
import { ZeroDepErrorGuard } from '@@zerodep/guard.errors';

// all arguments are optional
const error = new ZeroDepErrorGuardType();
error.value = 42;

// properties may be set after instantiation
console.log(error.message); // "Value is invalid"
console.log(error.category); // "unknown"
console.log(error.source); // "guard"
console.log(error.value); // 42

Guard Type Error

import { ZeroDepErrorGuardType } from '@@zerodep/utils';
// or
import { ZeroDepErrorGuardType } from '@@zerodep/guard';
// or
import { ZeroDepErrorGuardType } from '@@zerodep/guard.errors';

// properties may be set after instantiation
const error = new ZeroDepErrorGuardType();
error.value = '42';

// error properties
console.log(error.message); // "Value is incorrect type"
console.log(error.category); // "type"
console.log(error.source); // "guard"
console.log(error.value); // "42"

Guard Range Error

import { ZeroDepErrorGuardRange } from '@@zerodep/utils';
// or
import { ZeroDepErrorGuardRange } from '@@zerodep/guard';
// or
import { ZeroDepErrorGuardRange } from '@@zerodep/guard.errors';

// properties may be set after instantiation
const error = new ZeroDepErrorGuardType();
error.value = { answer: 42 };

// error properties
console.log(error.message); // "Value is out-of-range"
console.log(error.category); // "range"
console.log(error.source); // "guard"
console.log(error.value); // { answer: 42 }

More information about error configuration can be found in the @zerodep/errors documentation.

Advantages of @zerodep Packages

Zero npm dependencies - completely eliminates all risk of supply-chain attacks, decreases node_modules folder size
FP Inspired - encourages the functional programming style for cleaner and more maintainable code
Fully typed - typescript definitions are provided for every package for a better developer experience
ESM & CJS - has both ecmascript modules and common javascript exports, both are fully tree-shakable
Intelligently Packaged - multiple npm packages of different sizes available allowing a menu or a-la-carte composition of capabilities
100% Tested - all methods are fully unit tested
Semver - predictably versioned for peace-of-mind upgrading
MIT Licensed - permissively licensed for maximum usability

Support

This package has been tested, and built for, the following platforms/browsers in both ESM and CJS formats:

Browsers

Chrome - last 2 major versions
Firefox - last 2 major versions
Safari - last 2 major versions
Edge - last 2 major versions
Android - last 2 major versions
iOS - last 2 major versions

Node

v16.x - Gallium LTS
v14.x - Fermium LTS

It is likely the package will work on other technologies and version, however development and testing effort is only spent on the above.

Semver

All @zerodep packages, including this one, adhere to Semantic Versioning practices:

major versions: correlates with breaking changes to one or more method signatures
minor versions: includes addition of new functionality or backwards-compatible software improvements
patch versions: are reserved for copy changes, documentation enhancements and bug fixes

The above said, a security best practice is to pin your software packages to specific versions and only upgrade to more recent releases after careful inspection of any CHANGELOG, release notes and all software changes.