API reference

FlagsSubscriptionOptions

Hook polling and visibility refresh controls.

Current section

Component and config reference

Use these pages when you need props, defaults, and provider behavior details.

FlagsSubscriptionOptions

Hook options that control polling cadence and visibility-aware refresh behavior.

More on this: these options apply to the React flag hooks that run within FeatureFlareProvider.

export type FlagsSubscriptionOptions = {
  refreshIntervalMs?: number;
  hiddenRefreshIntervalMs?: number;
  pauseWhenHidden?: boolean;
  enabled?: boolean;
};

Fields

refreshIntervalMs?: number

Foreground polling interval when realtime transport is unavailable or disabled.

hiddenRefreshIntervalMs?: number

Polling interval used while the document is hidden when hidden polling is still allowed.

pauseWhenHidden?: boolean

When true, polling stops entirely while the document is hidden.

enabled?: boolean

Master switch for the hook subscription.