assertion-error

v2.0.1

Error constructor for test and validation frameworks that implements standardized AssertionError specification. For more information about how to use this package see README

Latest version published 1 year ago

License: MIT

NPM

GitHub

Package Health Score

71 / 100

security
No known security issues
popularity
Influential project
maintenance
Sustainable
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.0.1	\|	10/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	01/2018	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.0	\|	04/2013		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Influential project

Weekly Downloads (15,477,865)

GitHub Stars: 25
Forks: 16
Contributors: 20

Direct Usage Popularity

The npm package assertion-error receives a total of 15,477,865 downloads a week. As such, we scored assertion-error popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package assertion-error, we found that it has been starred 25 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the assertion-error repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like assertion-error is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

No Recent Commits

Open Issues: 2
Open PR: 1
Last Release: 1 year ago
Last Commit: 3 years ago

Further analysis of the maintenance status of assertion-error based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

An important project maintenance signal to consider for assertion-error is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=12

Age: 12 years
Dependencies: 0 Direct
Versions: 8
Install Size: 5.83 kB
Dist-tags: 1
# of Files: 5
Maintainers: 1
TS Typings: Yes

assertion-error has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use assertion-error?

To help you get started, we've collected the most common ways that assertion-error is being used within popular public projects.

kimjoar / expect-to / src / index.js View on Github

let { expected, msg } = res
    const showDiff = expected !== undefined

    if (showDiff) {
      // if the error starts with "expected" and we can show a diff,
      // then prefix the error message with `\w+: expected` (lower-case e)
      // and mocha will drop everything after the :
      // https://github.com/mochajs/mocha/blob/c0f9be244bff479e948f59d1bdb825a45c2cb40c/lib/reporters/base.js#L208-L209

      if (msg.match(/^expected /i)) {
        msg = `expect-to assertion failure: expected ${msg.slice(9)}`
      }
    }

    throw new AssertionError(msg, { showDiff, actual, expected })
  }
}

View more ways to use assertion-error

AssertionError and AssertionResult classes.

What is AssertionError?

Assertion Error is a module that contains two classes: AssertionError, which is an instance of an Error, and AssertionResult which is not an instance of Error.

These can be useful for returning from a function - if the function "succeeds" return an AssertionResult and if the function fails return (or throw) an AssertionError.

Both AssertionError and AssertionResult implement the Result interface:

interface Result {
  name: "AssertionError" | "AssertionResult";
  ok: boolean;
  toJSON(...args: unknown[]): Record;
}

So if a function returns AssertionResult | AssertionError it is easy to check which one is returned by checking either .name or .ok, or check instanceof Error.

Installation

Node.js

assertion-error is available on npm.

$ npm install --save assertion-error

Deno

assertion_error is available on Deno.land

import {
  AssertionError,
  AssertionResult,
} from "https://deno.land/x/assertion_error@2.0.0/mod.ts";

FAQs

What is assertion-error?

Error constructor for test and validation frameworks that implements standardized AssertionError specification. Visit Snyk Advisor to see a full health score report for assertion-error, including popularity, security, maintenance & community analysis.

Is assertion-error popular?

The npm package assertion-error receives a total of 15,477,865 weekly downloads. As such, assertion-error popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is assertion-error well maintained?

We found indications that assertion-error maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is assertion-error safe to use?

The npm package assertion-error was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 17 November-2024, at 02:43 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP