Skip to content

Docs: docs/api.md's StreamBuilder reference omits ratePerSecond() and submit() #463

Description

@Jaydbrown

docs/api.md's "Fluent Builder API" section for StreamBuilder documents only token(), sender(), recipient(), amount(), and build(). It omits .ratePerSecond(val: number | bigint) entirely (a real, meaningfully-different alternative to amount()-only streams), and also omits .submit(submitFn, options) — a substantial documented-in-code method (src/builder.ts) with retry/backoff, concurrency control via a semaphore, a pendingQueue with backpressure, and AbortSignal support, referenced by closed issues #188 and #199. A reader following only docs/api.md would not know either of these methods exist.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions