Install & Compatibility
Where this runs
No compatibility data collected yet for this library.
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
HttpClient
✓ import HttpClient from 'http-client'
✗ import { HttpClient } from 'http-client'
Default export only.
HttpClientConfig
✓ import HttpClient, { HttpClientConfig } from 'http-client'
✗ import { HttpClientConfig } from 'http-client'
Config type is a named export alongside default.
HttpClientRequestConfig
✓ import HttpClient, { HttpClientRequestConfig } from 'http-client'
✗ import { HttpClientRequestConfig } from 'http-client'
Request config type is a named export.
type imports
✓ import type { HttpClientConfig, HttpClientRequestConfig } from 'http-client'
✗ import { HttpClientConfig } from 'http-client'
Types can be imported using `import type` in TypeScript for better tree-shaking.
Shows initialization of HttpClient with config including base URL, auth headers, and message hook, then a simple GET request.
import HttpClient, { HttpClientConfig, HttpClientRequestConfig } from 'http-client'
const config: HttpClientConfig = {
baseURL: 'https://api.example.com',
headers: { Authorization: 'Bearer ' + (process.env.KEY ?? 'your-token') },
showMessage: ({ code, message }: { code: number; message: string }) => alert(message)
}
const http = new HttpClient(config)
const options: HttpClientRequestConfig = { url: '/users' }
http.request(options).then(res => console.log(res))
Errors
Common errors & fixes
TypeError: Cannot destructure property 'code' of 'undefined'
Response object is not in expected shape, likely because ArrayBuffer response was not handled correctly.
fixSet `responseType: 'arraybuffer'` on the request config for binary responses.
Uncaught (in promise) TypeError: axios is not a function
Missing peer dependency 'axios' is not installed.
fixRun `npm install axios@^0.27.2`.
Module not found: Can't resolve 'qs'
Missing peer dependency 'qs' is not installed.
fixRun `npm install qs@^6.11.0`.
Audit
Dependencies
axiosrequiredpeer dependency for HTTP requests
qsrequiredpeer dependency for query string parsing