createClient

Heart of APIful. Creates an ApiClient instance with the given default options.

Example

import { createClient, ofetchBuilder } from 'apiful'

const client = createClient({
  baseURL: 'https://api.example.com',
  headers: {
    Authorization: `Bearer ${process.env.API_KEY}`,
  },
})
  .with(ofetchBuilder())

// GET request to https://api.example.com/users/1
const user = await client('users/1', { method: 'GET' })

// POST request with JSON body
const newUser = await client('users', {
  method: 'POST',
  body: { name: 'John Doe', email: 'john@example.com' }
})

Type Definition

declare function createClient<const BaseURL extends string = '/'>(
  defaultOptions?: Omit<FetchOptions, 'baseURL'> & { baseURL?: BaseURL }
): ApiClient<BaseURL>

NOTE

FetchOptions are imported from ofetch.