npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

chai-eventemitter2

v0.2.1

Published

Chai plugin for testing node-style EventEmitters

Downloads

680

Readme

chai-eventemitter2

This is a chai plugin for testing node-style EventEmitters.

Compatibility

  • ECMAScript 2020 (Node.js 14+)

Installation

  1. Install the plugin:

    • Using NPM:

      npm install -D chai-eventemitter2
    • Using Yarn:

      yarn add -D chai-eventemitter2
  2. Add this your test setup:

    const chai = require('chai');
    const eventemitter2 = require('chai-eventemitter2');
    
    chai.use(eventemitter2());

Usage

With Expect API:

const emitter = new EventEmitter();

expect(emitter).to.be.an.eventEmitter;

expect(emitter)
	.to.emit('foo')
	.to.emit('bar', {count: 2})
	.to.emit('baz', {withArgs: ['X', 'Y', 'Z']})
	.to.emit('error', {count: 0})
	.on(() =>
	{
		emitter.emit('foo');
		emitter.emit('bar');
		emitter.emit('bar');
		emitter.emit('baz', 'X', 'Y', 'Z');
	});

API

Assertion.eventEmitter

Validates if the asserted object is an EventEmitter based on it's properties. (i.e. it must be an object with on and emit methods, etc.)

See an example in the usage section.

Assertion.emit(event[, options])

Registers an expected event.

  • event: string The name of the event.

  • options.count: number|{min: number?, max: number?} Determines the number of times the event is expected to be emitted. Can be a fixed amount or a range. [default=1]

  • option.argsMatch: 'deep'|'exact'|'soft' If you pass an array of expected arguments to the withArgs option, you can use this option to determine how the actual event arguments will be compared to the expected values.

    • 'deep' Makes a deep comparison between the elements of the withArgs array and the event arguments.

    • 'exact' Makes reference-equality comparison (===) between each element of the withArgs array and the event arguments.

    • 'soft' Expects the emitted event to contain the arguments set in the withArgs array, but ignores extra arguments. If the array contains objects, search for the object properties in the emitted event arguments but ignores extra properties.

      This is the default comparison method.

    If withArgs option is omitted or is not an array, this option is ignored.

  • options.withArgs: any[]|(...any) => boolean Used to validate the event arguments. If you pass an array, the plugin will expect the event arguments to match the values of the array. If you pass a callback function, it will be called with the arguments of the event so that you can make complex validations.

Assertion.on((EventEmitter) => undefined)

Call this method with a callback function with the code that emits events. The callback will be called and it is expected to emit all the events that were registered with emit, otherwise the test fails.

See an example in the usage section.

Known Issues

  • ⚠️ It doesn't handle circular references in the withArgs. The test might break if your event arguments have circular references.
  • ⚠️ It doesn't work with the "not" flag (.not). You can work around this issue using the count option. (i.e. assert that an event is emitted 0 times)
  • ⚠️ Not tested for asynchrony.

Disclaimer

Inspired by fengb/chai-eventemitter.

License

MIT