Rspeedy logo
Rspeedy
Guide
APIs
Blog
Contribute
Guide
APIs
Blog
Contribute

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.
Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.