JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1419
  • Score
    100M100P100Q108214F
  • License MIT

Snapshot testing plugin for Japa

Package Exports

  • @japa/snapshot
  • @japa/snapshot/types

Readme

@japa/snapshot

Snapshot testing plugin for Japa

gh-workflow-image npm-image license-image

Snapshot testing plugin for Japa. This plugin allows you to write snapshot tests for your application.

Complete API documentation

Installation

Install the package from the npm registry as follows:

npm i @japa/snapshot

pnpm i @japa/snapshot

yarn add @japa/snapshot

Usage

You can use this package with the @japa/runner as follows.

import { snapshot } from '@japa/snapshot'
import { configure } from '@japa/runner'

configure({
  plugins: [snapshot()],
})

Once done, you will be able to use the 2 new matchers added, either on expect or assert

test('test title', ({ expect, assert }) => {
  // with @japa/assert
  assert.snapshot('1').match()

  // with @japa/expect
  expect('1').toMatchSnapshot()
})