tuil
ReferencePackages@mwillbanks/tuil-streamingAPI

BackpressureController

interface exported by @mwillbanks/tuil-streaming.

View rawEdit

interface

Public interface exported by @mwillbanks/tuil-streaming.

export interface BackpressureController {
  readonly desiredSize: number;
  wait(signal?: AbortSignal): Promise<void>;
  release(count?: number): void;
}

Members

MemberTypeRequiredDescriptionRelated types
desiredSizenumberYesThe desiredSize member uses the number contract.
wait(signal?: AbortSignal) => Promise<void>YesThe wait member uses the (signal?: AbortSignal) => Promise<void> contract.
release(count?: number) => voidYesThe release member uses the (count?: number) => void contract.

Parameters

This declaration has no public members.

Returns

This declaration does not return a value.

Throws

No thrown errors are documented for this declaration.

No package-local related types.

Source

View the secondary source reference

Package

@mwillbanks/tuil-streaming

On this page