静的メソッド

静的メソッドはプラグインインスタンスの一部ではありません。コンストラクタ関数にアタッチされています。これらのメソッドは、プラグインオプションとテーマ設定の検証と正規化に使用され、その後、コンストラクタパラメータとして使用されてプラグインインスタンスが初期化されます。

validateOptions({options, validate})

プラグインの検証済みで正規化されたオプションを返します。このメソッドは、プラグインが初期化される前に呼び出されます。初期化中にプラグインに渡されるため、オプションを返す必要があります。

options

validateOptionsは、検証と正規化のためにプラグインに渡されたoptionsを使用して呼び出されます。

validate

validateOptionsは、Joi スキーマとオプションを引数として受け取り、検証済みで正規化されたオプションを返すvalidate関数を使用して呼び出されます。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',
    // rest of methods
  };
}

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

validateThemeConfig({themeConfig, validate})

テーマの検証済みで正規化された設定を返します。

themeConfig

validateThemeConfigは、検証と正規化のためにdocusaurus.config.jsで指定されたthemeConfigを使用して呼び出されます。

validate

validateThemeConfigは、Joi スキーマとthemeConfigを引数として受け取り、検証済みで正規化されたオプションを返すvalidate関数を使用して呼び出されます。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',
    // rest of methods
  };
}

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