Skip to main content

Home > flowp > Progress > onProgress

Progress.onProgress() method

&gte; This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment. &gte;

register a listener on progress report, and use the returned function to cancel listening.

listeners won't receive messages on progress rejection

Signature:

onProgress(listener: (progress: Readonly<CurrentProgress>) => unknown): () => boolean;

Parameters

ParameterTypeDescription
listener(progress: Readonly<CurrentProgress>) => unknown

Returns:

() => boolean