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

@event-scout/client

v0.7.7

Published

EventScout client

Downloads

773

Readme

@event-scout/client

Create and query event trails using EventScout.

This repository is part of EventScout.

Installation

pnpm add -D @event-scout/client

or if using yarn

yarn add --dev @event-scout/client

or if using npm

npm install --save-dev @event-scout/client

Use EventScout in your tests

Create a client

In order to use the EventScout client, you will need:

Instantiate the client:

import { EventScoutClient } from '@event-scout/client';

const eventScoutClient = new EventScoutClient({
  credentials,
  region,
  endpoint: eventScoutEndpoint,
});

Start an events trail

A trail is a list of events with a certain patterns, that you can dynamically create.

At the beginning of the test, start a trail with a custom pattern:

beforeAll(
  async () => {
    await eventScoutClient.start({
      eventPattern: {
        source: ['my-pattern'],
        'detail-type': ['MY_DETAIL_TYPE'],
      },
    });
  },
  30 * 1000, // 30s timeout
);

You can put any valid EventBridge pattern here, including content filtering. Check the AWS docs for more details.

⚠ In order for the resources to be properly activated, the EventScout client will wait for 20 seconds before returning. We advise to set a 30 seconds timeout on the beforeAll method.

Query the trail messages

In your tests, simply call the .query() method to retrieve events in the trail.

const messages = await eventScoutClient.query();

This will return all the events in the trail! You are then free to make assertions on them.

Cleanup

At the end of the test, call the .stop() method in afterAll:

afterAll(async () => {
  await eventScoutClient.stop();
});