@universal-packages/background-jobs-jest NPM

Background Jobs Jest

Jest matchers for Background Jobs testing.

Install

npm install @universal-packages/background-jobs-jest

npm install @universal-packages/background-jobs

Setup

Add the following to your jest.config.js or where you configure Jest:

module.exports = {
  setupFilesAfterEnv: ['@universal-packages/background-jobs-jest']
}

Matchers

toHaveBeenEnqueued

import { MyJob } from './MyJob'

it('should enqueue MyJob', async () => {
  await MyJob.performLater()

  expect(MyJob).toHaveBeenEnqueued()
})

toHaveBeenEnqueuedWith

import { MyJob } from './MyJob'

it('should enqueue MyJob with payload', async () => {
  await MyJob.performLater({ id: 1 })

  expect(MyJob).toHaveBeenEnqueuedWith({ id: 1 })
})

Typescript

In order for typescript to see the global types you need to reference the types somewhere in your project, normally ./src/globals.d.ts.

/// <reference types="@universal-packages/background-jobs-jest" />

This library is developed in TypeScript and shipped fully typed.

Contributing

The development of this library happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving this library.