Skip to main content

Development

corepack enable
pnpm install

Layout​

path
src/clientInngestClientProxy, InngestRecordBuilder
src/serverInngestStrategy, InngestContext, the functions, the serving, the exception filter
src/sharedInngestTriggers, InngestEvent
src/testingFakeInngest — published as nestjs-inngest-transport/testing
test/integrationa real Nest application on Express and Fastify
test/e2ethe real Inngest dev server in Docker
test/packagethe packed tarball, loaded from CommonJS and ESM
docsthis documentation, as MDX
websitethe Docusaurus site that builds it

The test suites​

commandsuiteneeds
pnpm testunit, beside the code (*.spec.ts)nothing
pnpm test:integrationtest/integration (*.int-spec.ts)nothing
pnpm test:e2etest/e2e (*.e2e-spec.ts)Docker
pnpm test:packagetest/package (*.pkg-spec.ts)nothing — it builds first
pnpm test:coverageunit and integration, with coveragenothing

The integration suite runs each function in process with @inngest/test, through the whole Nest pipeline. The end-to-end suite starts inngest/inngest with Testcontainers, has the application register with it, sends events through InngestClientProxy and reads the runs back from the dev server's API. Set INNGEST_IMAGE to pin another image.

The documentation site​

pnpm docs:dev # live, on http://localhost:3000/nestjs-inngest-transport/
pnpm docs:build # what CI builds; fails on a broken link or anchor

The site's dependencies are installed apart, in website/, so they never reach the package's lockfile.