@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

6 months ago

6 months ago

6 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

9 months ago

9 months ago

10 months ago

10 months ago

9 months ago

9 months ago

9 months ago

10 months ago

11 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

0.0.0-v3-prerelease-20240813130521

11 months ago

0.0.0-v3-prerelease-20240620125011

1 year ago

0.0.0-v2-prerelease-20240524135558

1 year ago

0.0.0-v3-prerelease-20240730135037

12 months ago

3.0.0-beta.50

12 months ago

3.0.0-beta.51

12 months ago

3.0.0-beta.52

12 months ago

0.0.0-v3-prerelease-20240612090234

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

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.0.0-v3-prerelease-20240619132954

1 year ago

0.0.0-v3-prerelease-20240619130535

1 year ago

0.0.0-prerelease-20240724110801

12 months ago

0.0.0-v3-prerelease-20240624161326

1 year ago

0.0.0-prerelease-20240603154820

1 year ago

0.0.0-v3-prerelease-20240612084127

1 year ago

0.0.0-v3-prerelease-20240618084116

1 year ago

0.0.0-v3-prerelease-20240717092755

12 months ago

0.0.0-v3-prerelease-20240703181409

1 year ago

0.0.0-v3-prerelease-20240708183321

1 year ago

0.0.0-prerelease-20240528152213

1 year ago

0.0.0-v3-prerelease-20240703161020

1 year ago

0.0.0-v3-prerelease-20240701153550

1 year ago

0.0.0-v3-prerelease-20240629184757

1 year ago

0.0.0-openai-v2-prerelease-20240606204146

1 year ago

0.0.0-v3-prerelease-20240801102736

12 months ago

0.0.0-v3-prerelease-20240708165959

1 year ago

0.0.0-v3-prerelease-20240708162325

1 year ago

0.0.0-prerelease-20240718194312

12 months ago

0.0.0-v3-prerelease-20240628191401

1 year ago

0.0.0-v3-prerelease-20240523152756

1 year ago

0.0.0-v3-prerelease-20240624162135

1 year ago

0.0.0-v3-prerelease-20240619135614

1 year ago

0.0.0-v3-prerelease-20240619111621

1 year ago

0.0.0-v3-prerelease-20240628145956

1 year ago

0.0.0-prerelease-20240529155427

1 year ago

0.0.0-v3-prerelease-20240705100038

1 year ago

0.0.0-v3-prerelease-20240619132212

1 year ago

2.3.19

1 year ago

0.0.0-v3-prerelease-20240606120239

1 year ago

0.0.0-prerelease-20240723165848

12 months ago

0.0.0-v3-prerelease-20240620110206

1 year ago

0.0.0-v3-prerelease-20240517082410

1 year ago

3.0.0-beta.33

1 year ago

0.0.0-v3-prerelease-20240517090458

1 year ago

3.0.0-beta.32

1 year ago

0.0.0-v3-prerelease-20240515122634

1 year ago

3.0.0-beta.30

1 year ago

3.0.0-beta.31

1 year ago

0.0.0-v3-prerelease-20240513193936

1 year ago

0.0.0-v3-prerelease-20240513155118

1 year ago

3.0.0-beta.29

1 year ago

0.0.0-v3-deploy-fix-20240506093509

1 year ago

0.0.0-v3-deploy-fix-20240506100153

1 year ago

0.0.0-v3-prerelease-20240506111619

1 year ago

3.0.0-beta.28

1 year ago

3.0.0-beta.27

1 year ago

3.0.0-beta.26

1 year ago

0.0.0-v3-prerelease-20240502144136

1 year ago

3.0.0-beta.25

1 year ago

0.0.0-v3-prerelease-20240501145152

1 year ago

3.0.0-beta.24

1 year ago

0.0.0-v3-prerelease-20240501131706

1 year ago

0.0.0-v3-prelease-20240429132319

1 year ago

3.0.0-beta.23

1 year ago

0.0.0-v3-prerelease-20240427071154

1 year ago

0.0.0-v3-typescript-fix-20240426160144

1 year ago

3.0.0-beta.21

1 year ago

3.0.0-beta.22

1 year ago

0.0.0-v3-prerelease-20240425102616

1 year ago

0.0.0-v3-prerelease-20240424094958

1 year ago

0.0.0-v3-decorators-20240424152300

1 year ago

0.0.0-v3-prerelease-20240424101411

1 year ago

3.0.0-beta.20

1 year ago

3.0.0-beta.19

1 year ago

3.0.0-beta.18

1 year ago

0.0.0-v3-update-command-20240423125505

1 year ago

0.0.0-v3-trigger-dirs-20240423123825

1 year ago

0.0.0-v3-trigger-dirs-20240423091017

1 year ago

3.0.0-beta.17

1 year ago

0.0.0-v3-update-command-20240423145551

1 year ago

0.0.0-v3-trigger-dirs-20240422221109

1 year ago

0.0.0-v3-trigger-dirs-20240422184026

1 year ago

0.0.0-v3-trigger-dirs-20240422172150

1 year ago

3.0.0-beta.16

1 year ago

3.0.0-beta.15

1 year ago

0.0.0-v3-prelease-20240419151535

1 year ago

0.0.0-prerelease-20240418145424

1 year ago

3.0.0-beta.14

1 year ago

0.0.0-v3-schedules-beta-20240417141912

1 year ago

3.0.0-beta.13

1 year ago

0.0.0-v3-schedules-beta-20240417103105

1 year ago

3.0.0-beta.11

1 year ago

3.0.0-beta.12

1 year ago

0.0.0-v3-pnpm-fix-20240411185916

1 year ago

0.0.0-v3-pnpm-fix-20240409123945

1 year ago

0.0.0-prerelease-20240410151927

1 year ago

0.0.0-prerelease-20240409175110

1 year ago

3.0.0-beta.7

1 year ago

0.0.0-prerelease-20240410145946

1 year ago

0.0.0-v3-pnpm-fix-20240409124823

1 year ago

0.0.0-prerelease-20240409174129

1 year ago

0.0.0-prerelease-20240409171136

1 year ago

0.0.0-prerelease-20240410143731

1 year ago

0.0.0-prerelease-20240410132612

1 year ago

0.0.0-v3-pnpm-fix-20240409125541

1 year ago

0.0.0-v3-pnpm-fix-20240409092025

1 year ago

0.0.0-v3-pnpm-fix-20240409132306

1 year ago

0.0.0-prerelease-20240409153610

1 year ago

0.0.0-prerelease-20240408121557

1 year ago

3.0.0-beta.6

1 year ago

0.0.0-v3-pnpm-fix-20240404122439

1 year ago

0.0.0-v3-pnpm-fix-20240404124258

1 year ago

0.0.0-v3-pnpm-fix-20240404112326

1 year ago

0.0.0-v3-pnpm-fix-20240404110601

1 year ago

3.0.0-beta.5

1 year ago

3.0.0-beta.4

1 year ago

0.0.0-v3-pnpm-fix-20240403154252

1 year ago

3.0.0-beta.3

1 year ago

0.0.0-prerelease-20240401121508

1 year ago

3.0.0-beta.1

1 year ago

3.0.0-beta.2

1 year ago

3.0.0-beta.0

1 year ago

0.0.0-beta-20240327140635

1 year ago

0.0.0-beta-20240327133444

1 year ago

0.0.0-v3-canary-20240325172431

1 year ago

0.0.0-v3-canary-20240325170325

1 year ago

0.0.0-v3-canary-20240324201508

1 year ago

0.0.0-v3-canary-20240322104917

1 year ago

0.0.0-v3-canary-20240322092243

1 year ago

0.0.0-v3-canary-20240322145829

1 year ago

0.0.0-v3-canary-20240322110240

1 year ago

0.0.0-nestfix-20240322145612

1 year ago

0.0.0-v3-canary-20240322141522

1 year ago

0.0.0-v3-canary-20240322110953

1 year ago

0.0.0-v3-canary-20240322152839

1 year ago

0.0.0-v3-canary-20240322112439

1 year ago

0.0.0-v3-canary-20240322152211

1 year ago

0.0.0-v3-canary-20240322220011

1 year ago

0.0.0-v3-canary-20240321134710

1 year ago

0.0.0-v3-canary-20240321115026

1 year ago

0.0.0-v3-canary-20240321164857

1 year ago

0.0.0-v3-canary-20240321165557

1 year ago

0.0.0-v3-canary-20240321121448

1 year ago

0.0.0-v3-canary-20240321105132

1 year ago

0.0.0-v3-canary-20240321171119

1 year ago

0.0.0-v3-canary-20240321162743

1 year ago

0.0.0-v3-canary-20240321210113

1 year ago

0.0.0-prerelease-20240219135254

1 year ago

2.3.18

1 year ago

2.3.17

1 year ago

2.3.16

1 year ago

0.0.0-yalt-timeout-20240117100229

1 year ago

2.3.13

1 year ago

2.3.15

1 year ago

2.3.12

1 year 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