Kito Framework - v1.0.0-alpha.8
    Preparing search index...

    Interface KitoResponse<TResponseSchema>

    interface KitoResponse<TResponseSchema = unknown> {
        status(code: number): KitoResponse<TResponseSchema>;
        sendStatus(code: number): void;
        header(
            name: CommonResponseHeaderNames,
            value: string,
        ): KitoResponse<TResponseSchema>;
        header(name: string, value: string): KitoResponse<TResponseSchema>;
        headers(
            headers: Record<CommonResponseHeaderNames, string>,
        ): KitoResponse<TResponseSchema>;
        headers(headers: Record<string, string>): KitoResponse<TResponseSchema>;
        append(
            field: CommonResponseHeaderNames,
            value: string,
        ): KitoResponse<TResponseSchema>;
        append(field: string, value: string): KitoResponse<TResponseSchema>;
        set(
            field: CommonResponseHeaderNames,
            value: string,
        ): KitoResponse<TResponseSchema>;
        set(field: string, value: string): KitoResponse<TResponseSchema>;
        get(field: CommonResponseHeaderNames): string | undefined;
        get(field: string): string | undefined;
        type(contentType: string): KitoResponse<TResponseSchema>;
        contentType(contentType: string): KitoResponse<TResponseSchema>;
        cookie(
            name: string,
            value: string,
            options?: CookieOptions,
        ): KitoResponse<TResponseSchema>;
        clearCookie(
            name: string,
            options?: CookieOptions,
        ): KitoResponse<TResponseSchema>;
        end(): void;
        send(
            data: TResponseSchema extends SchemaType
                ? InferType<TResponseSchema<TResponseSchema>>
                : unknown,
        ): void;
        json(
            data: TResponseSchema extends SchemaType
                ? InferType<TResponseSchema<TResponseSchema>>
                : unknown,
        ): void;
        text(data: string): void;
        html(data: string): void;
        redirect(url: string, code?: number): void;
        location(url: string): KitoResponse<TResponseSchema>;
        attachment(filename?: string): KitoResponse<TResponseSchema>;
        download(path: string, filename?: string, options?: SendFileOptions): void;
        sendFile(path: string, options?: SendFileOptions): void;
        vary(field: string): KitoResponse<TResponseSchema>;
        links(links: Record<string, string>): KitoResponse<TResponseSchema>;
        format(obj: Record<string, () => void>): KitoResponse<TResponseSchema>;
        stream(): StreamWriter;
        sse(): SSEWriter;
    }

    Type Parameters

    • TResponseSchema = unknown
    Index

    Methods