dredgeRoute()

// route.ts
import { dredgeRoute } from 'dredge-route'

export const route = dredgeRoute();

With initial context.

// route.ts
import { dredgeRoute } from 'dredge-route'
import type { DB } from './db'

export const route = dredgeRoute<{ db: DB }>()

route.path()

import { route } from './route'

route.path('/user/admin')
route.path('/user').path('/admin') // same as above


route.path('/user/:id') // param

route.params()

import { route } from './route'

route.path('/user/:id').params({
	id: z.number()
})

For schema, you can use zod, superstruct, yup. Before defining schema for param, be sure to define it in path.

route.searchParams()

import { route } from './route'

route.path('/entries').searchParams({
	skip: z.number(), 
})

route.<method>()

Define the method of the route, if the method support body, you can pass schema for the data. Well data is the parsed body.

import { route } from './route'

route.path('/posts').get()
route.path('/posts/:id').delete()


route.path('/posts').post(z.object({
	title: z.string(),
	content: z.string()
	createdAt: z.date()
}))

route.path('/posts/:id').put(
	z.object({
		title: z.string().optional(),
		content: z.string().optional(),
		createdAt: z.date().optional()
	})
)

route.use()

import { route } from './route'

route.use((req, res) => {
	// do something...
})

These are the middleware which will run after the success of validation. Checkout RouteRequest and RouteResponse for more information.

route.error()

import { route } from './route'

route.error((error, req, res) => {
	// do something...
})

These are the middleware which will run after the failure of validation or if you throw error in success middleware. Checkout RouteRequest and RouteResponse for more information.

route.options()

dataType

import { route } from './route'

route.options({
	dataTypes: {
		json: 'application/json',
		form: 'multipart/form-data',
		yaml: 'application/yaml',
	}
})

route.build()

As of now, you need to call build() to get the route object which you can then pass to dredgeRouter().

import { route } from './route'

const getPostsRoute = route
    .path('/posts')
    .get()
    .use((req, res) => {
        return res.next({
            data: db.getPosts()
			headers: {
				'content-type': 'application/json'
			}
        })
    })
	.build()