Types

The core types used throughout the Httx library.

HttpMethod

type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS'

Supported HTTP methods for requests.

HttxResponse

interface HttxResponse<T> {
  data: T
  status: number
  headers: Headers
  timing: {
    start: number
    end: number
    duration: number
  }
}

Response object containing the parsed data and metadata.

Properties

data

data: T

The parsed response data. Type T is determined by the generic type parameter of the request.

status

status: number

The HTTP status code of the response.

headers

headers: Headers

The response headers.

timing

timing: {
  start: number
  end: number
  duration: number
}

Timing information for the request:

• start: Timestamp when the request started
• end: Timestamp when the request completed
• duration: Total duration in milliseconds

Result

type Result<T, E> = Ok<T> | Err<E>

A type representing either a successful result (Ok) or an error (Err).

Ok

interface Ok<T> {
  isOk: () => true
  isErr: () => false
  value: T
}

Represents a successful result.

Err

interface Err<E> {
  isOk: () => false
  isErr: () => true
  error: E
}

Represents an error result.

ContentType

type ContentType = 'json' | 'form' | 'multipart'

Supported content types for requests.

DebugCategory

type DebugCategory = 'request' | 'response' | 'error' | 'timing'

Categories for debug logging.

Examples

Using Result Type

const result = await client.request<User>('/api/users/1', {
  method: 'GET',
  json: true
})

if (result.isOk()) {
  const user = result.value.data
  console.log(user.name)
}
else {
  console.error(result.error.message)
}

Using HttxResponse

const result = await client.request<User>('/api/users/1', {
  method: 'GET',
  json: true
})

if (result.isOk()) {
  const response = result.value
  console.log('Status:', response.status)
  console.log('User:', response.data)
  console.log('Request duration:', response.timing.duration, 'ms')
}

Type Inference

// TypeScript will infer User as the response data type
interface User {
  id: number
  name: string
  email: string
}

const result = await client.request<User>('/api/users/1', {
  method: 'GET',
  json: true
})

if (result.isOk()) {
  // TypeScript knows this is a User
  const user = result.value.data
  console.log(user.name) // OK
  console.log(user.unknown) // TypeScript error
}