Beignet API reference
    Preparing search index...

    Function createDevtoolsProvider

    • Devtools service provider.

      This provider attaches a DevtoolsPort to ctx.ports.devtools. It can be enabled/disabled via the DEVTOOLS_ENABLED environment variable. By default, it's enabled in non-production environments and disabled in production.

      Parameters

      Returns ServiceProvider<
          Record<string, unknown>,
          ZodObject<
              {
                  ENABLED: ZodPipe<
                      ZodOptional<ZodString>,
                      ZodTransform<boolean | undefined, string | undefined>,
                  >;
                  MAX_EVENTS: ZodOptional<ZodCoercedNumber<unknown>>;
                  PERSIST: ZodPipe<
                      ZodOptional<ZodString>,
                      ZodTransform<boolean | undefined, string | undefined>,
                  >;
                  PERSIST_PATH: ZodOptional<ZodString>;
              },
              $strip,
          >,
          { devtools: DevtoolsPort },
      >

      import { createDevtoolsProvider } from "@beignet/devtools";
      import { createServer } from "@beignet/core/server";

      const server = await createServer({
      ports,
      providers: [createDevtoolsProvider()],
      });

      To explicitly enable/disable:

      DEVTOOLS_ENABLED=true npm run dev
      DEVTOOLS_ENABLED=false npm run dev