GithubHelp home page GithubHelp logo

henrriusdev / svelxios Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 259 KB

A CLI for a SvelteKit Axios Wrapper

Home Page: https://www.npmjs.com/package/svelxios

TypeScript 97.01% JavaScript 2.99%
axios javascript library sveltekit typescript wrapper

svelxios's Introduction

Svelxios logo

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:

  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:

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:

svelxios's People

Contributors

henrriusdev avatar

Stargazers

Jerson Tapias avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.