You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

jest-matcher-utils

Package Overview
Dependencies
Maintainers
4
Versions
231
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jest-matcher-utils

A set of utility functions for expect and related packages


Version published
Weekly downloads
28M
decreased by-19.53%
Maintainers
4
Install size
1.69 MB
Created
Weekly downloads
 

Package description

What is jest-matcher-utils?

The jest-matcher-utils package provides utility functions for creating custom Jest matchers. It is designed to help developers write their own matchers that integrate seamlessly with Jest's built-in expectation system, offering a way to extend Jest's assertion capabilities with custom logic. The utilities provided by this package include formatting values for error messages, comparing values, and generating matcher error messages.

What are jest-matcher-utils's main functionalities?

pretty-format

Formats any JavaScript value for pretty printing, which is useful for generating readable error messages in custom matchers.

const { prettyFormat } = require('jest-matcher-utils');
console.log(prettyFormat({ foo: 'bar' }));

matcherHint

Generates a hint string for a matcher, which can be used at the beginning of error messages to indicate which matcher failed.

const { matcherHint } = require('jest-matcher-utils');
console.log(matcherHint('.toBe'));

printExpected and printReceived

These functions format the expected and received values to be included in error messages, applying color highlighting to improve readability.

const { printExpected, printReceived } = require('jest-matcher-utils');
console.log(`Expected: ${printExpected(true)}
Received: ${printReceived(false)}`);

Other packages similar to jest-matcher-utils

Readme

Source

jest-matcher-utils

This package's exports are most notably used by expect's this.utils.

Installation

To add this package as a dependency of a project, run either of the following commands:

  • npm install jest-matcher-utils
  • yarn add jest-matcher-utils

Exports (src/index.ts)

Functions

stringify highlightTrailingWhitespace printReceived printExpected printWithType ensureNoExpected ensureActualIsNumber ensureExpectedIsNumber ensureNumbers ensureExpectedIsNonNegativeInteger printDiffOrStringify diff pluralize getLabelPrinter matcherErrorMessage matcherHint

Types

MatcherHintOptions DiffOptions

Constants

EXPECTED_COLOR RECEIVED_COLOR INVERTED_COLOR BOLD_WEIGHT DIM_COLOR SUGGEST_TO_CONTAIN_EQUAL SERIALIZABLE_PROPERTIES

FAQs

Package last updated on 12 May 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc