Skip to main content

Quick start

1. Install​

npm install @parcely/core

2. Create a client​

import { createClient } from '@parcely/core'

const http = createClient({
  baseURL: 'https://api.example.com',
  headers: { Accept: 'application/json' },
  timeout: 5000,
})

3. Make requests​

// GET
const { data, status } = await http.get('/users/me')

// POST with JSON body
await http.post('/users', { name: 'Mickey' })

// PUT
await http.put('/users/1', { name: 'Updated' })

// DELETE
await http.delete('/users/1')

4. Handle errors​

import { isHttpError } from '@parcely/core'

try {
  await http.get('/might-fail')
} catch (err) {
  if (isHttpError(err)) {
    console.log(err.code)       // e.g. 'ERR_HTTP_STATUS'
    console.log(err.status)     // e.g. 404
    console.log(err.response)   // the HttpResponse envelope, if available
  }
}

5. Add interceptors​

// Request interceptor
http.interceptors.request.use((config) => ({
  ...config,
  headers: { ...config.headers, 'X-Request-Id': crypto.randomUUID() },
}))

// Response interceptor
http.interceptors.response.use(
  (response) => response,
  (err) => { console.error(err); throw err },
)

6. Validate responses at runtime (optional)​

import { z } from 'zod'

const UserSchema = z.object({ id: z.string(), name: z.string() })

const { data } = await http.get('/users/me', {
  validate: UserSchema,
})
// data is typed as { id: string; name: string }

Next steps​