Sveltekit Zero Api

[!IMPORTANT]
It is with happy consideration, that sveltekit-zero-api is being deprecated in favor of SvelteKits Remote Functions which includes both networking improvements, taking advantage of SvelteKit's other features such as Transport Hooks and general best practices when writing clean code. This library is no longer in active development, and stands proud as an artifact from the past.

Happy coding and may the Svelte be with you!

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

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

Getting Started

Backend - Setting up endpoints

Frontend - Using the API

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!💘