@trigger.dev/testing NPM

Trigger.dev Testing Package

The testing package provides useful helpers to write your own tests in jest and vitest with complete type support.

Usage

Install the package:

# npm
npm install -D @trigger.dev/testing

# yarn
yarn add -D @trigger.dev/testing

# pnpm
pnpm add -D @trigger.dev/testing

Import the package in a test as follows:

import { toHaveSucceeded, createJobTester } from "@trigger.dev/testing";
import { expect, vi } from "vitest";

expect.extend({ toHaveSucceeded });
const testJob = createJobTester(vi);

You can then use it like this:

const jobToTest = client.defineJob({
  id: "test-job",
  name: "Test Job",
  version: "0.1.0",
  trigger: eventTrigger({
    name: "test.trigger",
  }),
  integrations: {
    dummy,
  },
  run: async (payload, io, ctx) => {
    return await io.dummy.doSomething("test-task", {
      foo: payload.foo,
    });
  },
});

const testRun = await testJob(jobToTest, {
  payload: {
    foo: "bar",
  },
  tasks: {
    "test-task": {
      bar: "baz",
    },
  },
});

// job run was successful
expect(testRun).toHaveSucceeded();

// task was called exactly once
expect(testRun.tasks["test-task"]).toHaveBeenCalledOnce();

// task was called with correct params
expect(testRun.tasks["test-task"]).toHaveBeenCalledWith({ foo: "bar" });

// mocked task output was correctly returned
expect(testRun.tasks["test-task"]).toHaveReturnedWith({ bar: "baz" });

// job run has expected output
expect(testRun.output).toEqual({ bar: "baz" });

More information

See the official Trigger.dev Unit Testing Reference for a working setup with Vitest.

License

MIT

@trigger.dev/core @trigger.dev/sdk vitest zod

@everything-registry/sub-chunk-933

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.0.0-v3-prerelease-20240813130521

1 year ago

0.0.0-v3-prerelease-20240620125011

2 years ago

0.0.0-v2-prerelease-20240524135558

2 years ago

0.0.0-v3-prerelease-20240730135037

2 years ago

3.0.0-beta.50

2 years ago

3.0.0-beta.51

2 years ago

3.0.0-beta.52

2 years ago

0.0.0-v3-prerelease-20240612090234

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-v3-prerelease-20240619132954

2 years ago

0.0.0-v3-prerelease-20240619130535

2 years ago

0.0.0-prerelease-20240724110801

2 years ago

0.0.0-v3-prerelease-20240624161326

2 years ago

0.0.0-prerelease-20240603154820

2 years ago

0.0.0-v3-prerelease-20240612084127

2 years ago

0.0.0-v3-prerelease-20240618084116

2 years ago

0.0.0-v3-prerelease-20240717092755

2 years ago

0.0.0-v3-prerelease-20240703181409

2 years ago

0.0.0-v3-prerelease-20240708183321

2 years ago

0.0.0-prerelease-20240528152213

2 years ago

0.0.0-v3-prerelease-20240703161020

2 years ago

0.0.0-v3-prerelease-20240701153550

2 years ago

0.0.0-v3-prerelease-20240629184757

2 years ago

0.0.0-openai-v2-prerelease-20240606204146

2 years ago

0.0.0-v3-prerelease-20240801102736

2 years ago

0.0.0-v3-prerelease-20240708165959

2 years ago

0.0.0-v3-prerelease-20240708162325

2 years ago

0.0.0-prerelease-20240718194312

2 years ago

0.0.0-v3-prerelease-20240628191401

2 years ago

0.0.0-v3-prerelease-20240523152756

2 years ago

0.0.0-v3-prerelease-20240624162135

2 years ago

0.0.0-v3-prerelease-20240619135614

2 years ago

0.0.0-v3-prerelease-20240619111621

2 years ago

0.0.0-v3-prerelease-20240628145956

2 years ago

0.0.0-prerelease-20240529155427

2 years ago

0.0.0-v3-prerelease-20240705100038

2 years ago

0.0.0-v3-prerelease-20240619132212

2 years ago

2.3.19

2 years ago

0.0.0-v3-prerelease-20240606120239

2 years ago

0.0.0-prerelease-20240723165848

2 years ago

0.0.0-v3-prerelease-20240620110206

2 years ago

0.0.0-v3-prerelease-20240517082410

2 years ago

3.0.0-beta.33

2 years ago

0.0.0-v3-prerelease-20240517090458

2 years ago

3.0.0-beta.32

2 years ago

0.0.0-v3-prerelease-20240515122634

2 years ago

3.0.0-beta.30

2 years ago

3.0.0-beta.31

2 years ago

0.0.0-v3-prerelease-20240513193936

2 years ago

0.0.0-v3-prerelease-20240513155118

2 years ago

3.0.0-beta.29

2 years ago

0.0.0-v3-deploy-fix-20240506093509

2 years ago

0.0.0-v3-deploy-fix-20240506100153

2 years ago

0.0.0-v3-prerelease-20240506111619

2 years ago

3.0.0-beta.28

2 years ago

3.0.0-beta.27

2 years ago

3.0.0-beta.26

2 years ago

0.0.0-v3-prerelease-20240502144136

2 years ago

3.0.0-beta.25

2 years ago

0.0.0-v3-prerelease-20240501145152

2 years ago

3.0.0-beta.24

2 years ago

0.0.0-v3-prerelease-20240501131706

2 years ago

0.0.0-v3-prelease-20240429132319

2 years ago

3.0.0-beta.23

2 years ago

0.0.0-v3-prerelease-20240427071154

2 years ago

0.0.0-v3-typescript-fix-20240426160144

2 years ago

3.0.0-beta.21

2 years ago

3.0.0-beta.22

2 years ago

0.0.0-v3-prerelease-20240425102616

2 years ago

0.0.0-v3-prerelease-20240424094958

2 years ago

0.0.0-v3-decorators-20240424152300

2 years ago

0.0.0-v3-prerelease-20240424101411

2 years ago

3.0.0-beta.20

2 years ago

3.0.0-beta.19

2 years ago

3.0.0-beta.18

2 years ago

0.0.0-v3-update-command-20240423125505

2 years ago

0.0.0-v3-trigger-dirs-20240423123825

2 years ago

0.0.0-v3-trigger-dirs-20240423091017

2 years ago

3.0.0-beta.17

2 years ago

0.0.0-v3-update-command-20240423145551

2 years ago

0.0.0-v3-trigger-dirs-20240422221109

2 years ago

0.0.0-v3-trigger-dirs-20240422184026

2 years ago

0.0.0-v3-trigger-dirs-20240422172150

2 years ago

3.0.0-beta.16

2 years ago

3.0.0-beta.15

2 years ago

0.0.0-v3-prelease-20240419151535

2 years ago

0.0.0-prerelease-20240418145424

2 years ago

3.0.0-beta.14

2 years ago

0.0.0-v3-schedules-beta-20240417141912

2 years ago

3.0.0-beta.13

2 years ago

0.0.0-v3-schedules-beta-20240417103105

2 years ago

3.0.0-beta.11

2 years ago

3.0.0-beta.12

2 years ago

0.0.0-v3-pnpm-fix-20240411185916

2 years ago

0.0.0-v3-pnpm-fix-20240409123945

2 years ago

0.0.0-prerelease-20240410151927

2 years ago

0.0.0-prerelease-20240409175110

2 years ago

3.0.0-beta.7

2 years ago

0.0.0-prerelease-20240410145946

2 years ago

0.0.0-v3-pnpm-fix-20240409124823

2 years ago

0.0.0-prerelease-20240409174129

2 years ago

0.0.0-prerelease-20240409171136

2 years ago

0.0.0-prerelease-20240410143731

2 years ago

0.0.0-prerelease-20240410132612

2 years ago

0.0.0-v3-pnpm-fix-20240409125541

2 years ago

0.0.0-v3-pnpm-fix-20240409092025

2 years ago

0.0.0-v3-pnpm-fix-20240409132306

2 years ago

0.0.0-prerelease-20240409153610

2 years ago

0.0.0-prerelease-20240408121557

2 years ago

3.0.0-beta.6

2 years ago

0.0.0-v3-pnpm-fix-20240404122439

2 years ago

0.0.0-v3-pnpm-fix-20240404124258

2 years ago

0.0.0-v3-pnpm-fix-20240404112326

2 years ago

0.0.0-v3-pnpm-fix-20240404110601

2 years ago

3.0.0-beta.5

2 years ago

3.0.0-beta.4

2 years ago

0.0.0-v3-pnpm-fix-20240403154252

2 years ago

3.0.0-beta.3

2 years ago

0.0.0-prerelease-20240401121508

2 years ago

3.0.0-beta.1

2 years ago

3.0.0-beta.2

2 years ago

3.0.0-beta.0

2 years ago

0.0.0-beta-20240327140635

2 years ago

0.0.0-beta-20240327133444

2 years ago

0.0.0-v3-canary-20240325172431

2 years ago

0.0.0-v3-canary-20240325170325

2 years ago

0.0.0-v3-canary-20240324201508

2 years ago

0.0.0-v3-canary-20240322104917

2 years ago

0.0.0-v3-canary-20240322092243

2 years ago

0.0.0-v3-canary-20240322145829

2 years ago

0.0.0-v3-canary-20240322110240

2 years ago

0.0.0-nestfix-20240322145612

2 years ago

0.0.0-v3-canary-20240322141522

2 years ago

0.0.0-v3-canary-20240322110953

2 years ago

0.0.0-v3-canary-20240322152839

2 years ago

0.0.0-v3-canary-20240322112439

2 years ago

0.0.0-v3-canary-20240322152211

2 years ago

0.0.0-v3-canary-20240322220011

2 years ago

0.0.0-v3-canary-20240321134710

2 years ago

0.0.0-v3-canary-20240321115026

2 years ago

0.0.0-v3-canary-20240321164857

2 years ago

0.0.0-v3-canary-20240321165557

2 years ago

0.0.0-v3-canary-20240321121448

2 years ago

0.0.0-v3-canary-20240321105132

2 years ago

0.0.0-v3-canary-20240321171119

2 years ago

0.0.0-v3-canary-20240321162743

2 years ago

0.0.0-v3-canary-20240321210113

2 years ago

0.0.0-prerelease-20240219135254

2 years ago

2.3.18

2 years ago

2.3.17

2 years ago

2.3.16

2 years ago

0.0.0-yalt-timeout-20240117100229

2 years ago

2.3.13

2 years ago

2.3.15

2 years ago

2.3.12

2 years ago

0.0.0-prerelease-20240112134133

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-yalt-20231214135505

2 years ago

0.0.0-yalt-20231214152805

2 years ago

2.3.5

2 years ago

2.3.4

2 years ago

0.0.0-prerelease-20231208101523

2 years ago

2.3.3

2 years ago

0.0.0-airtable-fix-20231207124630

2 years ago

2.3.0

2 years ago

2.3.2

2 years ago

2.3.1

2 years ago

0.0.0-prerelease-20231206103411

2 years ago

0.0.0-buffer-fix-20231206151546

2 years ago

0.0.0-svelte-test-20231206141434

2 years ago

0.0.0-cross-runtime-20231205160729

2 years ago

0.0.0-cross-runtime-20231201144547

2 years ago

0.0.0-cross-runtime-20231201102436

2 years ago

0.0.0-cross-runtime-20231204210742

2 years ago

0.0.0-cross-runtime-20231204122122

2 years ago

0.0.0-cross-runtime-20231204162532

2 years ago

0.0.0-cross-runtime-20231201170549

2 years ago

0.0.0-cross-runtime-20231201151636

2 years ago

0.0.0-cross-runtime-20231204115010

2 years ago

0.0.0-cross-runtime-20231204112900

2 years ago

0.0.0-cross-runtime-20231201165945

2 years ago

0.0.0-canary-20231128163224

2 years ago

0.0.0-cross-runtime-20231204215427

2 years ago

0.0.0-cross-runtime-20231201165423

2 years ago

2.2.11

2 years ago

2.2.10

2 years ago

0.0.0-cross-runtime-20231204145118

2 years ago

0.0.0-cross-runtime-20231204083620

2 years ago

0.0.0-canary-20231129101350

2 years ago

0.0.0-cross-runtime-20231204213814

2 years ago

0.0.0-cross-runtime-20231204123212

2 years ago

0.0.0-cross-runtime-20231201154528

2 years ago

0.0.0-cross-runtime-20231204212617

2 years ago

0.0.0-cross-runtime-20231204214359

2 years ago

0.0.0-cross-runtime-20231204142429

2 years ago

0.0.0-cross-runtime-20231201145301

2 years ago

0.0.0-cross-runtime-20231201153629

2 years ago

0.0.0-cross-runtime-20231201105801

2 years ago

0.0.0-cross-runtime-20231201164903

2 years ago

2.2.9

2 years ago

2.2.8

2 years ago

0.0.0-cross-platform-20231201111000

2 years ago

0.0.0-canary-20231124115954

2 years ago

2.2.7

2 years ago

0.0.0-canary-20231116142015

2 years ago

2.2.6

2 years ago

0.0.0-canary-20231109172257

2 years ago

2.2.5

2 years ago

0.0.0-canary-20231107105437

2 years ago

0.0.0-canary-20231106183136

2 years ago

0.0.0-canary-20231106175914

2 years ago

0.0.0-canary-20231103115634

2 years ago

0.0.0-invoke-trigger-20231103104037

2 years ago

2.2.4

2 years ago

0.0.0-buffer-import-20231031135043

2 years ago

0.0.0-buffer-import-20231031121649

2 years ago

2.2.3

2 years ago

0.0.0-next-14-20231026182830

2 years ago

2.2.2

2 years ago

2.2.1

2 years ago

0.0.0-prerelease-20231024083739

2 years ago

0.0.0-auto-yield-20231020151736

2 years ago

0.0.0-prerelease-20231013155033

2 years ago

0.0.0-prerelease-20231013150518

2 years ago

0.0.0-prerelease-20231013144137

2 years ago

2.2.0

2 years ago

0.0.0-prerelease-20231013111910

2 years ago

0.0.0-prerelease-20231013085537

2 years ago

0.0.0-auto-yield-20231012110056

2 years ago

0.0.0-auto-yield-20231012092140

2 years ago

0.0.0-prerelease-20231011154756

2 years ago

0.0.0-auto-yield-20231011151933

2 years ago

0.0.0-node-18-20231010094401

2 years ago

0.0.0-prerelease-20231006153956

2 years ago

0.0.0-prerelease-20231006150402

2 years ago

0.0.0-prerelease-20231006135434

2 years ago

0.0.0-prerelease-20231006134030

2 years ago

0.0.0-prerelease-20231006124713

2 years ago

2.1.9

2 years ago

0.0.0-prerelease-20231005170730

2 years ago

0.0.0-prerelease-20231005164702

2 years ago

2.1.8

2 years ago

0.0.0-dev-20231004120419

2 years ago

2.1.7

2 years ago

0.0.0-cliframeworks-20230929110149

2 years ago

2.1.6

2 years ago

0.0.0-cliframeworks-20230927162936

2 years ago

0.0.0-cliframeworks-20230927161502

2 years ago

0.0.0-cliframeworks-20230927155804

2 years ago

2.1.5

2 years ago

0.0.0-cliframeworks-20230924203030

2 years ago

0.0.0-cliframeworks-20230924195344

2 years ago

2.1.4

2 years ago

0.0.0-zod-decouple-20230922213650

2 years ago

0.0.0-prerelease-20230922203841

2 years ago

0.0.0-prerelease-20230922185725

2 years ago

0.0.0-statuses-20230921210707

2 years ago

0.0.0-byo-auth-20230921153903

2 years ago

0.0.0-byo-auth-20230921145930

2 years ago

0.0.0-statuses-20230920011059

2 years ago

0.0.0-cliframeworks-20230919074756

2 years ago

0.0.0-cliframeworks-20230918160751

2 years ago

0.0.0-cliframeworks-20230918152824

2 years ago

0.0.0-isomorphic-sdk-20230918151405

2 years ago

0.0.0-isomorphic-sdk-20230918150523

2 years ago

0.0.0-isomorphic-sdk-20230918145643

2 years ago

0.0.0-cliframeworks-20230918141000

2 years ago

0.0.0-isomorphic-sdk-20230918132755

2 years ago

0.0.0-cliframework-20230917115647

2 years ago

0.0.0-isomorphic-sdk-20230915152907

2 years ago

0.0.0-clidev-20230914132855

2 years ago

0.0.0-clidev-20230914124436

2 years ago

2.1.3

2 years ago

0.0.0-clidev-20230914123020

2 years ago

2.1.2

2 years ago

2.1.1

2 years ago