Rspeedy logo
Rspeedy
指引
API
博客
贡献
指引
API
博客
贡献
简体中文

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.
除非另有说明，本项目采用知识共享署名 4.0 国际许可协议进行许可，代码示例采用 Apache License 2.0 许可协议进行许可。