• 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

      PropertyModifiersTypeDescription
      configConfigThe user config.
      debug(message: string | (() => string)) => voidPrint debug logs.
      exit(code?: number) => Promise<void> | voidExit the process.
      loggertypeof loggerGet the Rspeedy logger.
      versionstringThe version of Rspeedy.