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

kurkar

v0.1.2

Published

Ava macros to test RxJS, with TypeScript support

Downloads

5

Readme

Build status on Cirrus Build status on GitHub Actions

Kurkar: Ava macros to test RxJS

Kurkar helps you test RxJS operators and pipelines with marbles using Ava. Ava macros let you write concise tests.

Install

npm install --save-dev kurkar

Basic usage

import test from 'ava';
import marbles from 'kurkar';

test('observable', marbles, (_t, _sched, helpers) => {
  const letters = 'the quick brown fox jumps over the lazy dog|';
  const source$ = helpers.hot(letters);
  helpers.expectObservable(source$).toBe(letters);
});

Kurkar provides an Ava test macro to easily set up RxJS tests in Ava. Include the macro function marbles before the test function to hook up an RxJS TestScheduler to the Ava execution context "t". The test function will be run inside a test scheduler, with these parameters:

  • t: Ava execution context for this test.
  • sched: RxJS TestScheduler running this test. Use when you need to pass a scheduler argument into some operators.
  • helpers: Helper functions created by TestScheduler.run for easily creating and comparing Observables.

TestScheduler runs synchronously, so the test function is not async.

The marbles macro uses t.deepEqual to compare actual and expected results. Pass a different comparison function to withEquals to generate other versions of the macro. marbles is just

const marbles = withEquals((t, a, e) => t.deepEqual(a, e));

TypeScript support

Kurkar fully supports TypeScript types and exports useful types. You do not need to install additional @types to enjoy TypeScript.

Here's a typed version of the above test:

import test from 'ava';
import marbles, { withEquals, ExecutionContext, TestScheduler, RunHelpers } from 'kurkar';

test('observable', marbles, (_t: ExecutionContext, _sched: TestScheduler, helpers: RunHelpers) => {
  const letters = 'the quick brown fox jumps over the lazy dog|';
  const source$ = helpers.hot(letters);
  helpers.expectObservable(source$).toBe(letters);
});

Due to current limitations with Ava types, TypeScript language servers currently cannot always deduce the types of the test function parameters.

FAQ

Why another Ava RxJS marbles library?

Because it provides an Ava test macro, Kurkar removes the most boilerplate from your tests. It is native TypeScript and can provide exact type-checking.

Why the name?

"Kurkar" ("כורכר") is a soft middle-eastern sandstone -- a very different rock from marble.

What are all these other names?

  • Ava: A JavaScript and TypeScript test runner.
  • RxJS: A library for composing asynchronous and event-based programs by using observable sequences.
  • Marbles: Diagram-based testing of RxJS operators and pipelines.

Build Status