sveltekit-zero-api

Provides type-safety between front- and backend of your SvelteKit project


Keywords
sveltekit, api, endpoint, typesafety, typescript
License
MIT
Install
npm install sveltekit-zero-api@0.15.8

Documentation

SurrealDB Icon

Seamless type-safety   means   better developer experience.

 

Quick Start

npm i -D sveltekit-zero-api  /  pnpm add -D sveltekit-zero-api

// vite.config.ts
import { zeroAPI } from 'sveltekit-zero-api'

const config: UserConfig = {
	plugins: [
		sveltekit(),
		zeroAPI()
	]
}

// .gitignore
**/sveltekit-zero-api.d.ts

  What is SvelteKit Zero API?

Zero API attempts to sow the gap between the frontend and backend. This includes typing backend response codes and their content and dealing with them effectively using callback functions. This may also include error handling.

  • Body and query is typed seemlessly in both frontend, and endpoints
  • Queries are easier to use with querySpread which supports objects as query parameters
  • Endpoint routes are automatically typed
  • Generic endpoints
  • Typed endpoint pipeline
  • The returned content of endpoints are typed
  • Supports slugged routes
  • Can be used in the page Load function
  • You can type-define variables with endpoint responses
  • Has handy backend utility functions; querySpread and Error Handling

Assigning variables directly Intellisense with API calls


Installation, usage and utility types can all be fond on the GitHub Wiki



Acknowledgments

Thank you ymzuiku for igniting the initial concept and codebase svelte-zero-api. And naturally, a big thanks to the Vite and Svelte family for the worlds best framework!💘