For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /api/rspeedy.exposedapi.md.
This is the dev preview website. Check out the document at lynx-stack.dev
  • English

      • Home > @lynx-js/rspeedy > ExposedAPI

      ExposedAPI interface

      The exposed API of Rspeedy. Can be used in Rsbuild plugin with api.useExposed.

      Signature:

      export interface ExposedAPI

      Example

      import type { ExposedAPI } from '@lynx-js/rspeedy'
const RsbuildPlugin = {
  name: 'my-rsbuild-plugin',
  pre: ['lynx:rsbuild:plugin-api'],
  setup(api) {
    const rspeedyAPI = api.useExposed<ExposedAPI>(Symbol.for('rspeedy.api'))
  },
}

      Properties

      Property

      Modifiers

      Type

      Description

      config

      Config

      The user config.

      debug

      (message: string | (() => string)) => void

      Print debug logs.

      exit

      (code?: number) => Promise<void> | void

      Exit the process.

      logger

      typeof logger

      Get the Rspeedy logger.

      version

      string

      The version of Rspeedy.