📚 Table of Contents

🧠 How It Works

🚀 Getting Started

1. Clone the repository

git clone https://github.com/Falk33n/sveltekit-rpc.gitcd sveltekit-rpc

2. Install dependencies

# (or use `bun install` / `pnpm install` / `yarn install` if you prefer).npm install

3. Start the dev server

# (or use `bun run dev` / `pnpm run dev` / `yarn run dev` if you prefer).npm run dev

🛠️ How To Use

1. Define the routes

import{exampleInputSchema,exampleOutputSchema}from'$lib/schemas/example';import{createRouter,publicProcedure}from'../setup';exportconstexampleRouter=createRouter({example:{method:'post',handler:publicProcedure.input(exampleInputSchema).output(exampleOutputSchema).resolve(async(event,input)=>{// The input is directly parsed from the input schema.const{ id}=input;// The event is the same as the event that comes from SvelteKit backend.console.log(event.params);// The output is directly parsed from the output schema.return{status:200,data:{ id,name:'hanna'},message:'OK',};}),},});

2. Create the app router

import{exampleRouter}from'./routers';import{createAppRouter}from'./setup';// This is the root of all the endpoints, we define this to get a better structure of different// categories of routers.exportconstappRouter=createAppRouter({example:exampleRouter,});

3. Calling the API

<scriptlang="ts">import {callApi }from'../lib/client/caller';asyncfunction onclick() {// Fully typesafe api caller, that will give you the correct input,// output and method based on the endpoint string.const api=awaitcallApi('example.example', {input: { id:'hoho' },method:'post',});// Logs the return object of the api.console.log(api);}</script><button {onclick}>test</button>

4. Creating an middleware

import{publicProcedure}from'../setup';// This is how we define an middleware to be used and called inbefore each endpoint runs.constexampleProcedure=publicProcedure.use((event)=>console.log(event.cookies.getAll()));

License

🐛 Found a Bug?