Skip to content

after

n回目の呼び出しから実行される関数を生成します。 提供された関数はn回目の呼び出しから実行されます。

これは、特定の回数の呼び出し後にのみ動作が発生する必要があるイベントや非同期タスクに有用です。

インターフェース

typescript
function after<F extends (...args: any[]) => any>(
  n: number,
  func: F
): (...args: Parameters<F>) => ReturnType<F> | undefined;

パラメータ

  • n (number): funcが実行されるために必要な呼び出し回数です。
  • func (F): 実行される関数です。

戻り値

((...args: Parameters<F>) => ReturnType<F> | undefined): 新しい関数を返します。この関数は以下の機能を持ちます:

  • 呼び出された回数を追跡します。
  • n回目の呼び出しからfuncを呼び出します。
  • 呼び出しがn回に達するまでundefinedを返します。

エラー

nが負の場合、エラーを発生させます。

typescript
import { after } from 'es-toolkit/function';

const mockFn = () => {
  console.log('実行されました');
};
const afterFn = after(3, mockFn);

// 何もログに出力しません
afterFn();
// 何もログに出力しません
afterFn();
// '実行されました'をログに出力します
afterFn();

MIT ライセンスの下で配布されています。