poll

• poll
• PollOptions
• PollResult

Promise を返す関数 func と待機間隔 wait を渡し、固定間隔で非同期タスクをポーリングし、設定可能なリトライと実行時制御を提供する関数を返します。

オプション引数 options でリトライ設定を行います。詳細はこちら。

関数はポーリングを制御するオブジェクトを返します。詳細はこちら。

Added in v0.0.4

Usage

import { poll } from 'parsnip-kit'

const getList = () => {
  return fetch('https://example.url.test/list').then((response) => {
    response.json()
    // ...
  })
}
const polled = poll(getList, 1000)
const pollResult = polled()

// ...
// Stop polling
pollResult.stop()

API

Type Parameter

Arg	Type	Description
T		Type of the value returned by the Promise of function func

Arguments

Arg	Type	Optional	Default	Description
func	(...args: any[]) => Promise<T>	false	undefined	ポーリング対象の非同期関数
wait	number	false	undefined	ポーリング間隔（ミリ秒）
options	PollOptions<T>	true	undefined	ポーリング設定
options.maxRetries	number	true	3	失敗時の最大リトライ回数。成功時にカウンターをリセット
options.maxCalls	number	true	Infinity	Maximum number of calls of func
options.sequential	boolean	true	false	前回の実行が完了するまで次回を待機
options.leading	boolean	true	true	直ちに 1 回実行
options.onSuccess	(result: T, retries: number) => void	true	undefined	成功時のコールバック
options.onFailure	(error: any, retries: number) => void	true	undefined	失敗時のコールバック

Returns

Type
(...args: Parameters<typeof func>) => PollResult

PollOptions

poll 関数の options パラメーターの型。

Added in v0.0.4

Source

export interface PollOptions<T> {
  maxRetries?: number
  sequential?: boolean
  leading?: boolean
  maxCalls?: number
  onSuccess?: (result: T, retries: number) => void
  onFailure?: (error: any, retries: number) => void
}

PollResult

poll 関数の戻り値の型。

Added in v0.0.4

Source

export interface PollResult {
  stop: () => void
  start: () => void
  isRunning: () => boolean
}