Home > @lynx-js/rspeedy > ExposedAPI
The exposed API of Rspeedy. Can be used in Rsbuild plugin with api.useExposed.
Signature:
export interface ExposedAPI 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'))
},
}|
Property |
Modifiers |
Type |
Description |
|---|---|---|---|
|
The user config. | |||
|
(message: string | (() => string)) => void |
Print debug logs. | ||
|
RsbuildEntry |
(Optional) Used for plugin qrcode get entry points from self-defined environments rather than default lynx environment. | ||
|
(code?: number) => Promise<void> | void |
Exit the process. | ||
|
typeof logger |
Get the Rspeedy logger. | ||
|
string |
The version of Rspeedy. |