Skip to content

std/build/http

std/build/http

Classes

HttpFailure

Defined in: apps/website/.api-docs-entry/std/build/http/index.d.ts:11

Failure from the owned HTTP request helper. Call sites map this into a domain tagged error rather than inventing a second fetch wrapper.

Extends

  • HttpFailure_base

Constructors

Constructor
new HttpFailure(...args): HttpFailure;

Defined in: node_modules/.pnpm/effect@4.0.0-rc.112/node_modules/effect/dist/Schema.d.ts:9273

Parameters
Parameter Type
...args [object, MakeOptions]
Returns

HttpFailure

Inherited from
HttpFailure_base.constructor

Properties

message
readonly message: string;

Defined in: apps/website/.api-docs-entry/std/build/http/index.d.ts:12

Overrides
HttpFailure_base.message

operation
readonly operation: string;

Defined in: apps/website/.api-docs-entry/std/build/http/index.d.ts:3

Inherited from
HttpFailure_base.operation

reason
readonly reason: string;

Defined in: apps/website/.api-docs-entry/std/build/http/index.d.ts:5

Inherited from
HttpFailure_base.reason

status?
readonly optional status?: number;

Defined in: apps/website/.api-docs-entry/std/build/http/index.d.ts:4

Inherited from
HttpFailure_base.status

Type Aliases

HttpRequestOptions

type HttpRequestOptions = Readonly<{
  init?: NonNullable<Parameters<typeof globalThis.fetch>[1]>;
  operation?: string;
  transport?: typeof globalThis.fetch;
}>;

Defined in: apps/website/.api-docs-entry/std/build/http/index.d.ts:14

Variables

httpRequest

const httpRequest: (input, options?) => Effect.Effect<Response, HttpFailure>;

Defined in: apps/website/.api-docs-entry/std/build/http/index.d.ts:23

The one place production code may reach globalThis.fetch. Callers receive a typed Effect and never write fetch( themselves.

Parameters

Parameter Type
input Parameters<typeof globalThis.fetch>[0]
options? HttpRequestOptions

Returns

Effect.Effect<Response, HttpFailure>