API reference

Every public export, by entry point.

Entry points

import	exports
@itsy/corgi	corgi, compose, order, ORDER, HttpError, isHttpError, isTimeoutError, isAbortError + types
@itsy/corgi/timeout	withTimeout (2022-safe)
@itsy/corgi/timeout-modern	withTimeout (Baseline 2024)
@itsy/corgi/retry	withRetry, type RetryOptions
@itsy/corgi/abort-previous	abortPrevious
@itsy/corgi/schema	schema, parseWith, ValidationError, isValidationError, type StandardSchemaV1
@itsy/corgi/chonk	enhanced corgi, CorgiChonkOptions, CorgiChonk, CorgiChonkAPI, and re-exports of everything above

@itsy/corgi

The root entry: the client, the composition engine, and errors.

• The Corgi interface documents the callable, the verb shortcuts, and raw/extend.
• Options & types lists RequestOptions, CorgiOptions, MappedResponse, ParseAs, and Query.
• Errors & guards covers HttpError and the name-based guards.
• Composition engine holds compose, order, ORDER, Fetcher, and Plugin.

Plugins (opt-in)

The middleware, each on its own import path: Plugins reference →