createClient

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

Example

import { createClient, ofetchBuilder } from 'apiful'

interface JSONPlaceholderTodoResponse {
  userId: number
  id: number
  title: string
  completed: boolean
}

const client = createClient({
  baseURL: 'https://jsonplaceholder.typicode.com',
}).with(ofetchBuilder())

const response = await client<JSONPlaceholderTodoResponse>('todos/1')

Type Definition

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

NOTE

FetchOptions are imported from ofetch.