Skip to content
StoryShelf

HttpRequestOptions

Defined in: packages/core/src/utils/http.ts:77

Options for httpJson.

Properties

Section titled “Properties”

form?

Section titled “form?”

optional form?: Record<string, string>

Defined in: packages/core/src/utils/http.ts:83

Body serialized as application/x-www-form-urlencoded (ignored when json is set).

headers?

Section titled “headers?”

optional headers?: Record<string, string>

Defined in: packages/core/src/utils/http.ts:79

json?

Section titled “json?”

optional json?: unknown

Defined in: packages/core/src/utils/http.ts:81

Body serialized as JSON with a content-type header.

logger?

Section titled “logger?”

optional logger?: Logger

Defined in: packages/core/src/utils/http.ts:90

method?

Section titled “method?”

optional method?: string

Defined in: packages/core/src/utils/http.ts:78

retries?

Section titled “retries?”

optional retries?: number

Defined in: packages/core/src/utils/http.ts:87

Total attempts including the first (default 3).

signal?

Section titled “signal?”

optional signal?: AbortSignal

Defined in: packages/core/src/utils/http.ts:89

Aborts the request (and any further retry) when it fires.

timeoutMs?

Section titled “timeoutMs?”

optional timeoutMs?: number

Defined in: packages/core/src/utils/http.ts:85

Per-attempt timeout in milliseconds (default 30s).