mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-07-04 17:20:09 +00:00
Make the type of koa's ctx accessible
This commit is contained in:
197
koa/koa.d.ts
vendored
197
koa/koa.d.ts
vendored
@@ -8,6 +8,10 @@
|
||||
import * as Koa from "koa"
|
||||
const app = new Koa()
|
||||
|
||||
async function (ctx: Koa.IContext, next: Function) {
|
||||
// ...
|
||||
}
|
||||
|
||||
=============================================== */
|
||||
/// <reference path="../node/node.d.ts" />
|
||||
|
||||
@@ -16,99 +20,101 @@ declare module "koa" {
|
||||
import * as http from "http";
|
||||
import * as net from "net";
|
||||
|
||||
interface IContext extends IRequest, IResponse {
|
||||
body?: any;
|
||||
request?: IRequest;
|
||||
response?: IResponse;
|
||||
originalUrl?: string;
|
||||
state?: any;
|
||||
name?: string;
|
||||
cookies?: any;
|
||||
writable?: Boolean;
|
||||
respond?: Boolean;
|
||||
app?: Koa;
|
||||
req?: http.IncomingMessage;
|
||||
res?: http.ServerResponse;
|
||||
onerror(err: any): void;
|
||||
toJSON(): any;
|
||||
inspect(): any;
|
||||
throw(): void;
|
||||
assert(): void;
|
||||
}
|
||||
module Koa {
|
||||
export interface IContext extends IRequest, IResponse {
|
||||
body?: any;
|
||||
request?: IRequest;
|
||||
response?: IResponse;
|
||||
originalUrl?: string;
|
||||
state?: any;
|
||||
name?: string;
|
||||
cookies?: any;
|
||||
writable?: Boolean;
|
||||
respond?: Boolean;
|
||||
app?: Koa;
|
||||
req?: http.IncomingMessage;
|
||||
res?: http.ServerResponse;
|
||||
onerror(err: any): void;
|
||||
toJSON(): any;
|
||||
inspect(): any;
|
||||
throw(code?: any, message?: any): void;
|
||||
assert(): void;
|
||||
}
|
||||
|
||||
interface IRequest {
|
||||
_querycache?: string;
|
||||
app?: Koa;
|
||||
req?: http.IncomingMessage;
|
||||
res?: http.ServerResponse;
|
||||
response?: IResponse;
|
||||
ctx?: IContext;
|
||||
headers?: any;
|
||||
header?: any;
|
||||
method?: string;
|
||||
length?: any;
|
||||
url?: string;
|
||||
origin?: string;
|
||||
originalUrl?: string;
|
||||
href?: string;
|
||||
path?: string;
|
||||
querystring?: string;
|
||||
query?: any;
|
||||
search?: string;
|
||||
idempotent?: Boolean;
|
||||
socket?: net.Socket;
|
||||
protocol?: string;
|
||||
host?: string;
|
||||
hostname?: string;
|
||||
fresh?: Boolean;
|
||||
stale?: Boolean;
|
||||
charset?: string;
|
||||
secure?: Boolean;
|
||||
ips?: Array<string>;
|
||||
ip?: string;
|
||||
subdomains?: Array<string>;
|
||||
accept?: any;
|
||||
type?: string;
|
||||
accepts?: () => any;
|
||||
acceptsEncodings?: () => any;
|
||||
acceptsCharsets?: () => any;
|
||||
acceptsLanguages?: () => any;
|
||||
is?: (types: any) => any;
|
||||
toJSON?: () => any;
|
||||
inspect?: () => any;
|
||||
get?: (field: string) => string;
|
||||
}
|
||||
export interface IRequest {
|
||||
_querycache?: string;
|
||||
app?: Koa;
|
||||
req?: http.IncomingMessage;
|
||||
res?: http.ServerResponse;
|
||||
response?: IResponse;
|
||||
ctx?: IContext;
|
||||
headers?: any;
|
||||
header?: any;
|
||||
method?: string;
|
||||
length?: any;
|
||||
url?: string;
|
||||
origin?: string;
|
||||
originalUrl?: string;
|
||||
href?: string;
|
||||
path?: string;
|
||||
querystring?: string;
|
||||
query?: any;
|
||||
search?: string;
|
||||
idempotent?: Boolean;
|
||||
socket?: net.Socket;
|
||||
protocol?: string;
|
||||
host?: string;
|
||||
hostname?: string;
|
||||
fresh?: Boolean;
|
||||
stale?: Boolean;
|
||||
charset?: string;
|
||||
secure?: Boolean;
|
||||
ips?: Array<string>;
|
||||
ip?: string;
|
||||
subdomains?: Array<string>;
|
||||
accept?: any;
|
||||
type?: string;
|
||||
accepts?: () => any;
|
||||
acceptsEncodings?: () => any;
|
||||
acceptsCharsets?: () => any;
|
||||
acceptsLanguages?: () => any;
|
||||
is?: (types: any) => any;
|
||||
toJSON?: () => any;
|
||||
inspect?: () => any;
|
||||
get?: (field: string) => string;
|
||||
}
|
||||
|
||||
interface IResponse {
|
||||
_body?: any;
|
||||
_explicitStatus?: Boolean;
|
||||
app?: Koa;
|
||||
res?: http.ServerResponse;
|
||||
req?: http.IncomingMessage;
|
||||
ctx?: IContext;
|
||||
request?: IRequest;
|
||||
socket?: net.Socket;
|
||||
header?: any;
|
||||
headers?: any;
|
||||
status?: number;
|
||||
message?: string;
|
||||
type?: string;
|
||||
body?: any;
|
||||
length?: any;
|
||||
headerSent?: Boolean;
|
||||
lastModified?: Date;
|
||||
etag?: string;
|
||||
writable?: Boolean;
|
||||
is?: (types: any) => any;
|
||||
redirect?: (url: string, alt: string) => void;
|
||||
attachment?: (filename?: string) => void;
|
||||
vary?: (field: string) => void;
|
||||
get?: (field: string) => string;
|
||||
set?: (field: any, val: any) => void;
|
||||
remove?: (field: string) => void;
|
||||
append?: (field: string, val: any) => void;
|
||||
toJSON?: () => any;
|
||||
inspect?: () => any;
|
||||
export interface IResponse {
|
||||
_body?: any;
|
||||
_explicitStatus?: Boolean;
|
||||
app?: Koa;
|
||||
res?: http.ServerResponse;
|
||||
req?: http.IncomingMessage;
|
||||
ctx?: IContext;
|
||||
request?: IRequest;
|
||||
socket?: net.Socket;
|
||||
header?: any;
|
||||
headers?: any;
|
||||
status?: number;
|
||||
message?: string;
|
||||
type?: string;
|
||||
body?: any;
|
||||
length?: any;
|
||||
headerSent?: Boolean;
|
||||
lastModified?: Date;
|
||||
etag?: string;
|
||||
writable?: Boolean;
|
||||
is?: (types: any) => any;
|
||||
redirect?: (url: string, alt: string) => void;
|
||||
attachment?: (filename?: string) => void;
|
||||
vary?: (field: string) => void;
|
||||
get?: (field: string) => string;
|
||||
set?: (field: any, val: any) => void;
|
||||
remove?: (field: string) => void;
|
||||
append?: (field: string, val: any) => void;
|
||||
toJSON?: () => any;
|
||||
inspect?: () => any;
|
||||
}
|
||||
}
|
||||
|
||||
class Koa extends EventEmitter {
|
||||
@@ -117,12 +123,12 @@ declare module "koa" {
|
||||
proxy: Boolean;
|
||||
server: http.Server;
|
||||
env: string;
|
||||
context: IContext;
|
||||
request: IRequest;
|
||||
response: IResponse;
|
||||
context: Koa.IContext;
|
||||
request: Koa.IRequest;
|
||||
response: Koa.IResponse;
|
||||
silent: Boolean;
|
||||
constructor();
|
||||
use(middleware: (ctx: IContext, next: Function) => any): Koa;
|
||||
use(middleware: (ctx: Koa.IContext, next: Function) => any): Koa;
|
||||
callback(): (req: http.IncomingMessage, res: http.ServerResponse) => void;
|
||||
listen(port: number, callback?: Function): http.Server;
|
||||
toJSON(): any;
|
||||
@@ -131,6 +137,5 @@ declare module "koa" {
|
||||
}
|
||||
|
||||
namespace Koa {}
|
||||
|
||||
export = Koa;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user