Event

event is basically a context object for the request.

interface RequestEvent<ReqSchema extends SchemaDefinition = SchemaDefinition, ResSchema = unknown, Path extends string = string> extends BaseEvent {
  cookies: Cookies;
  headers: Omit<Headers, 'toJSON' | 'count' | 'getAll'>;
  html: typeof html;
  json: (data: ResSchema, init?: ResponseInit) => ResponseT<ResSchema>;
  locals: Api.Locals;
  params: ParsePath<Path>;
  platform: Record<string, any>;
  redirect: typeof redirect;
  request: Request;
  setHeaders: (headers: Record<string, any>) => void;
  store: Store | null;
  text: typeof text;
  url: Omit<URL, 'createObjectURL' | 'revokeObjectURL' | 'canParse'>;
  valid: ReqSchema;
}

Cookie Handling

Use event.cookies to delete, get, getAll, and set cookies.

import { Xin } from "@xinkjs/xin"

const api = new Xin()

api.route("/")
  .get(({ cookies }) => {
    // name, value, options
    cookies.set("xin", "is awesome", { maxAge: 60 * 60 * 24 * 365 })

    const cookie_value = cookies.get("xin")
    const all_cookies = cookies.getAll()
    cookies.delete("xin")

    return new Response("Hello from xin")
  })

Locals

event.locals is available for you to define custom information per request. This is good for use with middleware or hooks.

middleware/fn1.ts

export const middlewareFn1: Handle = (event, resolve) => {
  event.locals.xin = "is awesome"

  return resolve(event)
}

/* index.ts */
import { Xin } from "@xinkjs/xin"

const api = new Xin()

api.route("/")
  .get((event) => {
    console.log(event.locals.xin) // is awesome
  })

export default api

To type your locals, create an api.d.ts file in the root of your project.

declare global {
  namespace Api {
    interface Locals {
      xin: string;
    }
  }
}

export {}

Setting Headers

Use event.setHeaders to set response headers. These will be added right before xin returns the response. So, if set within a handler, your middleware will not see these.

You cannot set cookies using this method; instead, use event.cookies.

import { Xin } from "@xinkjs/xin"

const api = new Xin()

api.route("/")
  .get((event) => {
    event.setHeaders({
      "Powered-By": "xin"
    })

    const response = new Response("Hey") // you will not see the headers here

    return response
  )

export default api