Interface PrepareChangelogOverlayOptions

Options for evaluating and fetching entries for the What's-New changelog overlay.

interface PrepareChangelogOverlayOptions {
    onlyIfUnseen?: boolean;
    signal?: AbortSignal;
    timeoutMs?: number;
    tokenStore?: UserTokenStore;
}

Properties

onlyIfUnseen?: boolean

If true, returns null if the latest changelog entry has already been marked as seen by the user.

false

signal?: AbortSignal

Optional abort signal to cancel the overlay configuration and changelog fetching.

timeoutMs?: number

Optional request timeout override in milliseconds.

Optional custom UserTokenStore instance used to query seen status from. Defaults to UserTokenStore.shared.