fantasticfiasco / expect

A Node.js library written in TypeScript providing argument validation.

@fantasticfiasco/expect

A Node.js library written in TypeScript providing argument validation.

Table of contents

• Super simple to use
• Installation
• API
• Credit

Super simple to use

import * as expect from '@fantasticfiasco/expect';

function update(person) {
    expect.toExist(person.name);
    expect.toBeTrue(person.age >= 0, 'existential theories are not up for discussion');

    // Squint your eyes and imagine your code here...
}

Installation

npm install @fantasticfiasco/expect
# or
yarn add @fantasticfiasco/expect

API

toBeTrue(condition[, errorMessage])

• condition: boolean The condition expected to be true
• errorMessage: string The optional error message displayed if expectation fails

Expect a condition to be true.

toBeFalse(condition[, errorMessage])

• condition: boolean The condition expected to be false
• errorMessage: string The optional error message displayed if expectation fails

Expect a condition to be false.

toExist<T>(value[, errorMessage])

• value: T The value expected to exist
• errorMessage: string The optional error message displayed if expectation fails

Expect a value to exist.

toNotExist<T>(value[, errorMessage])

• value: T The value expected not to exist
• errorMessage: string The optional error message displayed if expectation fails

Expect a value not to exist.

toBeAlphanumeric(value[, errorMessage])

• value: string The value expected to be alphanumeric
• errorMessage: string The optional error message displayed if expectation fails

Expect a value to be alphanumeric.

toBeCharCodes(value, minCharCode, maxCharCode[, errorMessage])

• value: string The value expected to have characters from a range of character codes
• minCharCode: number The expected minimum character code
• maxCharCode: number The expected maximum character code
• errorMessage: string The optional error message displayed if expectation fails

Expect a value to only contain characters from a range of character codes.

Credit

Thank you JetBrains for your important initiative to support the open source community with free licenses to your products.

expect's Issues

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• chore(deps): update dependency eslint to v9

Pending Status Checks

These updates await pending status checks. To force their creation now, click the checkbox below.

• chore(deps): update dependency inquirer to v9.2.20
• chore(deps): update eslint packages to v7.7.1 (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update yarn to v4

Detected dependencies

github-actions

.github/workflows/ci-cd.yml

• actions/checkout v4
• actions/setup-node v4

.github/workflows/update-copyright-years-in-license-file.yml

• actions/checkout v4
• FantasticFiasco/action-update-license-year v3

npm

.yarn/sdks/eslint/package.json

.yarn/sdks/typescript/package.json

package.json

• @octokit/rest 20.1.0
• @types/jest 29.5.12
• @types/node 20.12.7
• @typescript-eslint/eslint-plugin 7.7.0
• @typescript-eslint/parser 7.7.0
• copyfiles 2.4.1
• eslint 8.57.0
• inquirer 9.2.19
• jest 29.7.0
• rimraf 5.0.5
• ts-jest 29.1.2
• typescript 5.4.5
• node >=16.0.0
• hosted-git-info >=2.8.9
• node-fetch >=3.2.10
• path-parse >=1.0.7
• tmpl >=1.0.5
• yarn 3.8.1

---

• Check this box to trigger a request for Renovate to run again on this repository