Interface OverlapOptions<This, Args>

interface OverlapOptions<This, Args extends readonly unknown[]> {
    mode: OverlapMode;
    key: (context: OverlapKeyContext<This, Args>) => PropertyKey;
    maxQueue?: number;
    cancelWhenUnused?: boolean;
}

Type Parameters

This
Args extends readonly unknown[]

Index

Properties

mode key maxQueue? cancelWhenUnused?

Properties

`Readonly`mode

mode: OverlapMode

`Readonly`key

key: (context: OverlapKeyContext<This, Args>) => PropertyKey

Returns the state partition used to coordinate overlapping calls.

`Optional` `Readonly`maxQueue

maxQueue?: number

Maximum waiting calls per key. The active call does not count toward it.

`Optional` `Readonly` `Experimental`cancelWhenUnused

cancelWhenUnused?: boolean

Only in share mode: abort cooperatively after the last consumer withdraws.