型・APIリファレンス
    Preparing search index...

    Function provideServerErrors

    • サーバーエラー状態をprovideする(親コンポーネントで呼び出す)

      Parameters

      Returns {
          clearAllServerErrors: () => void;
          clearServerError: (propertyName: string) => void;
          getServerErrors: (propertyName: string) => string[];
          hasServerError: (propertyName: string) => boolean;
          setServerError: (params: SetServerErrorParams) => void;
          state: {
              errors: Record<string, string[]>;
              timers: Record<string, TimeoutHandle>;
          };
      }

      • clearAllServerErrors: () => void

        すべてのサーバーエラーをクリアする

      • clearServerError: (propertyName: string) => void

        指定プロパティのサーバーエラーをクリアする

      • getServerErrors: (propertyName: string) => string[]

        指定プロパティのサーバーエラーメッセージを取得する

      • hasServerError: (propertyName: string) => boolean

        指定プロパティにサーバーエラーが存在するかを判定する

      • setServerError: (params: SetServerErrorParams) => void

        指定プロパティにサーバーエラーを設定する

        既存のタイマーがあればクリアし、自動消去タイマーを設定する。 timeoutMs を指定すると、このプロパティに対してのみデフォルト値を上書きする。 timeoutMs が0以下の場合、自動消去を行わない。

      • state: { errors: Record<string, string[]>; timers: Record<string, TimeoutHandle> }
        • errors: Record<string, string[]>

          プロパティ名 → エラーメッセージ配列

        • timers: Record<string, TimeoutHandle>

          プロパティ名 → タイマーID(自動消去用)