Interface CpeakResponse

lib/types.ts:36–54

}

export interface CpeakResponse<ResBody = any> extends ServerResponse {
  sendFile: (path: string, mime?: string) => Promise<void>;
  status: (code: number) => CpeakResponse<ResBody>;
  attachment: (filename?: string) => CpeakResponse<ResBody>;
  cookie: (name: string, value: string, options?: CookieOptions) => CpeakResponse<ResBody>;
  redirect: (location: string) => void;
  json: (data: ResBody) => Promise<void>;
  compress: (
    mime: string,
    body: Buffer | string | Readable,
    size?: number
  ) => Promise<void>;
  render: (
    filePath: string,
    data: Record<string, unknown>,
    mime?: string
  ) => Promise<void>;
  [key: string]: any; // allow developers to add their onw extensions (e.g. res.test)
}

export type Next = (err?: any) => void;