svelxios
v2.1.0
Published
SvelteKit Axios Wrapper
Downloads
8
Maintainers
Readme
Svelxios: Svelte Axios Wrapper
How to use?
Download the CLI to your SvelteKit Project with the package manager of your choice:
npm i svelxios
# or
yarn add svelxios
# or
pnpm add svelxios
Note: After using the CLI, you can uninstall it.
Then, execute the CLI:
npx svelxios
Here the CLI would install axios and write the code for the axios wrapper for sveltekit in these files:
src/app.d.ts
: In the app locals for better use on the server side.src/lib/server/client.ts
: Here is the Axios Client.src/lib/utils/debugger.ts
: Axios Debuggerssrc/hooks.server.ts
: Here the client would be loaded to the app locals.
And then?
Use it as a common axios client on the server side of your SvelteKit app:
import type {PageServerLoad} from './$types';
export const load: PageServerLoad = async ({locals:{svelxios}}) => {
const response = await svelxios.get('/your-api');
console.log(response);
}
Special notes
- You must have a .env file that has a baseUrl for this axios client, this is used on the creation of the client.
import {baseUrl} from "$env/static/private";
const client = axios.create(
baseURL: baseUrl
);
// ...
// more code
export {client}
- Once you has svelxios running properly, you can uninstall the CLI.
Special thanks to:
- 4ndual
- gracrys
- Axios Team (Great http client, thanks)