@xylabs/assert

XY Labs generalized Javascript library

Table of Contents

• Description
• Install
• Maintainers
• License
• Credits

Description

Common Javascript code that is used throughout XYO projects that use React.

Install

Using npm:

npm i --save @xylabs/assert

Using yarn:

yarn add @xylabs/assert

Usage

The assertEx function is a utility function for simple null/undefined checks for variables. It evaluates an expression for truthiness and throws an error if the expression is false.

Here are some examples of how to use assertEx in different scenarios:

• Basic usage:

  import { assertEx } from '@xylabs/assert';
  
  const value = getValue(); // This is a function that may return null or undefined
  assertEx(value); // Throws an AssertExError with a default message if value is null or undefined

• Using with a custom error message:

  import { assertEx } from '@xylabs/assert';
  
  const value = getValue(); // This function may return null or undefined
  assertEx(value, () => 'Dynamic error message based on some conditions'); // Throws an AssertExError with a dynamic message if value is null or undefined

Maintainers

• Arie Trouw (arietrouw.com)
• Joel Carter
• Matt Jones
• Jordan Trouw

License

See the LICENSE file for license details

Credits

Made with 🔥and ❄️ by XY Labs