A helper package to easily enable/disable NestJS Devtools integration!
- Add
snapshot
totrue
forNestFactory.create
call - Import
DevtoolsModule.register({ http: true, port: 8000 })
into the module passed to theNestFactory.create
call if it was not imported already
that reduces the amount of boilerplate code you would have to write and
also allows us to not import that DevtoolsModule
with no effort.
You must have @nestjs/core
(v9.3 or greater), @nestjs/devtools-integration
and reflect-metadata
installed!
npm install --save-dev nestjs-devtools-loader
You need to supply the --require nestjs-devtools-loader/register
option to node
With NestJS's CLI, you can do:
nest start --exec "node -r nestjs-devtools-loader/register"
# ^~ an alias to --require
If you want to change the default options that are supplied to DevtoolsModule.register()
, use the environment variable: NESTJS_DEVTOOLS_LOADER
like this:
NESTJS_DEVTOOLS_LOADER='{"http":true,"port":3001}'
import { loader } from 'nestjs-devtools-loader'
// ...
// Before calling `NestFactory.create()`:
loader({ http: true, port: 8000 })
If you want to disable the loader while still injecting it into your app, set the environment variable NESTJS_DEVTOOLS_LOADER_DISABLED
to "true"
If the env. var. DEBUG
contains the string "nestjs-devtools-loader"
like:
DEBUG=nestjs-devtools-loader
you'll see if the loader was injected or not.