跳到主要内容

静态方法

静态方法不是插件实例的一部分 - 它们附加到构造函数上。这些方法用于验证和规范化插件选项和主题配置，然后在初始化插件实例时作为构造函数参数使用。

validateOptions({options, validate})​

返回插件的验证和规范化选项。此方法在插件初始化之前调用。您必须返回选项，因为它们将在初始化期间传递给插件。

options​

validateOptions 使用传递给插件的 options 进行验证和规范化。

validate​

validateOptions 使用 validate 函数，该函数接受一个 Joi 模式和选项作为参数，返回验证和规范化的选项。validate 将自动处理错误和验证配置。

提示

建议使用 Joi 进行选项的验证和规范化。

为避免混合 Joi 版本，请使用 import {Joi} from '@docusaurus/utils-validation'

如果不使用 Joi 进行验证，可以在选项无效时抛出错误，在成功时返回选项。

my-plugin/src/index.js
export default function myPlugin(context, options) {
  return {
    name: 'docusaurus-plugin',
    // 其余方法
  };
}

export function validateOptions({options, validate}) {
  const validatedOptions = validate(myValidationSchema, options);
  return validatedOptions;
}

validateThemeConfig({themeConfig, validate})​

返回主题的验证和规范化配置。

themeConfig​

validateThemeConfig 使用在 docusaurus.config.js 中提供的 themeConfig 进行验证和规范化。

validate​

validateThemeConfig 使用 validate 函数，该函数接受一个 Joi 模式和 themeConfig 作为参数，返回验证和规范化的选项。validate 将自动处理错误和验证配置。

提示

建议使用 Joi 进行主题配置的验证和规范化。

为避免混合 Joi 版本，请使用 import {Joi} from '@docusaurus/utils-validation'

如果不使用 Joi 进行验证，可以在选项无效时抛出错误。

my-theme/src/index.js
export default function myPlugin(context, options) {
  return {
    name: 'docusaurus-plugin',
    // 其余方法
  };
}

export function validateThemeConfig({themeConfig, validate}) {
  const validatedThemeConfig = validate(myValidationSchema, options);
  return validatedThemeConfig;
}