https://github.com/henrriusdev/svelxios

A CLI for a SvelteKit Axios Wrapper
https://github.com/henrriusdev/svelxios

axios javascript library sveltekit typescript wrapper

Last synced: about 1 month ago
JSON representation

A CLI for a SvelteKit Axios Wrapper

• Host: GitHub
• URL: https://github.com/henrriusdev/svelxios
• Owner: henrriusdev
• Created: 2023-11-26T21:07:33.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-28T14:25:11.000Z (about 1 year ago)
• Last Synced: 2024-08-05T14:19:21.794Z (6 months ago)
• Topics: axios, javascript, library, sveltekit, typescript, wrapper
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/svelxios
• Size: 253 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![Svelxios logo](docs/svelxios.png)

# Svelxios: Svelte Axios Wrapper

## How to use?

Download the CLI to your **SvelteKit Project** with the package manager of your choice:

```bash

npm i svelxios

# or

yarn add svelxios

# or

pnpm add svelxios

```

**Note: After using the CLI, you can uninstall it.**

Then, execute the CLI:

```bash

npx svelxios

```

Here the CLI would install axios and write the code for the axios wrapper for sveltekit in these files:

1. `src/app.d.ts`: In the app locals for better use on the server side.

2. `src/lib/server/client.ts`: Here is the Axios Client.

3. `src/lib/utils/debugger.ts`: Axios Debuggers

4. `src/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:

```typescript

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.

```typescript

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](https://github.com/4ndual)

* [gracrys](https://github.com/gracrys)

* [Axios Team](https://github.com/axios/axios) (Great http client, thanks)