Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function createApp
- create
App(options, callback?): Promise<void> create Kever App
+Parameters
- options: AppOptions
Optionalcallback: Callback
Returns Promise<void>
Generated using TypeDoc
Function enhanceMiddleware
- enhance
Middleware(middlewares): ((ctx, next) => void)[] Parameters
- middlewares: KeverMiddleware[]
Returns ((ctx, next) => void)[]
Generated using TypeDoc
Generated using TypeDoc
Function Injectable
- Injectable(tag): ClassDecorator
Marks the current class as injectable
+Parameters
- tag: Tag
Returns ClassDecorator
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function patchMiddleware
- patch
Middleware(tag, payload): void Parameters
- tag: Tag
- payload: Payload
Returns void
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function parseRouter
- parse
Router(controllerMetas): Router Parameters
- controllerMetas: Set<ControllerMeta>
Returns Router
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function getFilesPath
- get
Files Path(loadFileDir, logger): Promise<Set<string>> get files path in dir
+Parameters
- loadFileDir: string
- logger: Logger
Returns Promise<Set<string>>
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function loadModule
- load
Module(filePath, logger): Promise<void> load module
+Parameters
- filePath: string
- logger: Logger
Returns Promise<void>
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
@kever/monorepo
kever 
A lightweight inversion of control nodejs framework based on TypeScript.
+
+ 
+
+
+
+
+
+Quick Start
Web Application
Install
npm insatll -g @kever/cli
+Create Project
kever init
+Generated using TypeDoc
Interface App
app
+interface App {
    context: BaseContext & DefaultContext;
    env: string;
    keys: string[] | Keygrip;
    maxIpsCount: number;
    middleware: Middleware<DefaultState, DefaultContext, any>[];
    options: Required<AppOptions>;
    proxy: boolean;
    proxyIpHeader: string;
    request: BaseRequest;
    response: BaseResponse;
    silent: boolean;
    subdomainOffset: number;
    addListener(event, listener): this;
    callback(): ((req, res) => Promise<void>);
    createContext<StateT>(req, res): ParameterizedContext<StateT, DefaultContext, unknown>;
    emit(event, ...args): boolean;
    eventNames(): (string | symbol)[];
    getMaxListeners(): number;
    inspect(): any;
    listen(port?, hostname?, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(port, hostname?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(port, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(port, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(path, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(path, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(options, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(handle, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(handle, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listenerCount(event): number;
    listeners(event): Function[];
    off(event, listener): this;
    on(event, listener): this;
    once(event, listener): this;
    onerror(err): void;
    prependListener(event, listener): this;
    prependOnceListener(event, listener): this;
    rawListeners(event): Function[];
    removeAllListeners(event?): this;
    removeListener(event, listener): this;
    setMaxListeners(n): this;
    toJSON(): any;
    use<NewStateT, NewContextT>(middleware): __module;
}
    context: BaseContext & DefaultContext;
    env: string;
    keys: string[] | Keygrip;
    maxIpsCount: number;
    middleware: Middleware<DefaultState, DefaultContext, any>[];
    options: Required<AppOptions>;
    proxy: boolean;
    proxyIpHeader: string;
    request: BaseRequest;
    response: BaseResponse;
    silent: boolean;
    subdomainOffset: number;
    addListener(event, listener): this;
    callback(): ((req, res) => Promise<void>);
    createContext<StateT>(req, res): ParameterizedContext<StateT, DefaultContext, unknown>;
    emit(event, ...args): boolean;
    eventNames(): (string | symbol)[];
    getMaxListeners(): number;
    inspect(): any;
    listen(port?, hostname?, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(port, hostname?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(port, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(port, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(path, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(path, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(options, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(handle, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listen(handle, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>;
    listenerCount(event): number;
    listeners(event): Function[];
    off(event, listener): this;
    on(event, listener): this;
    once(event, listener): this;
    onerror(err): void;
    prependListener(event, listener): this;
    prependOnceListener(event, listener): this;
    rawListeners(event): Function[];
    removeAllListeners(event?): this;
    removeListener(event, listener): this;
    setMaxListeners(n): this;
    toJSON(): any;
    use<NewStateT, NewContextT>(middleware): __module;
}
Hierarchy
- Application
- App
Index
Properties
context
+env
+keys
+max
Methods
Properties
context
context: BaseContext & DefaultContext
env
env: string
keys
keys: string[] | Keygrip
max
max
middleware
middleware: Middleware<DefaultState, DefaultContext, any>[]
options
proxy
proxy: boolean
proxy
proxy
request
request: BaseRequest
response
response: BaseResponse
silent
silent: boolean
subdomain
subdomain
Methods
add
callback
create
emit
event
get
inspect
listen
- listen(port?, hostname?, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>
Shorthand for:
+http.createServer(app.callback()).listen(...)
+Parameters
Optionalport: numberOptionalhostname: stringOptionalbacklog: numberOptionallisteningListener: (() => void)- (): void
Returns void
Returns Server<typeof IncomingMessage, typeof ServerResponse>
- listen(port, hostname?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>
Parameters
- port: number
Optionalhostname: stringOptionallisteningListener: (() => void)- (): void
Returns void
Returns Server<typeof IncomingMessage, typeof ServerResponse>
- listen(port, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>
Parameters
- port: number
Optionalbacklog: numberOptionallisteningListener: (() => void)- (): void
Returns void
Returns Server<typeof IncomingMessage, typeof ServerResponse>
- listen(port, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>
Parameters
- port: number
OptionallisteningListener: (() => void)- (): void
Returns void
Returns Server<typeof IncomingMessage, typeof ServerResponse>
- listen(path, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>
Parameters
- path: string
Optionalbacklog: numberOptionallisteningListener: (() => void)- (): void
Returns void
Returns Server<typeof IncomingMessage, typeof ServerResponse>
- listen(path, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>
Parameters
- path: string
OptionallisteningListener: (() => void)- (): void
Returns void
Returns Server<typeof IncomingMessage, typeof ServerResponse>
- listen(options, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>
Parameters
- options: ListenOptions
OptionallisteningListener: (() => void)- (): void
Returns void
Returns Server<typeof IncomingMessage, typeof ServerResponse>
- listen(handle, backlog?, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>
Parameters
- handle: any
Optionalbacklog: numberOptionallisteningListener: (() => void)- (): void
Returns void
Returns Server<typeof IncomingMessage, typeof ServerResponse>
- listen(handle, listeningListener?): Server<typeof IncomingMessage, typeof ServerResponse>
Parameters
- handle: any
OptionallisteningListener: (() => void)- (): void
Returns void
Returns Server<typeof IncomingMessage, typeof ServerResponse>
listener
listeners
off
on
once
onerror
prepend
prepend
raw
remove
remove
set
toJSON
use
- use<NewStateT, NewContextT>(middleware): __module
Use the given middleware
+fn.Old-style middleware will be converted.
+Type Parameters
Parameters
- middleware: Middleware<DefaultState & NewStateT, DefaultContext & NewContextT, any>
Returns __module
Generated using TypeDoc
Interface AppOptions
Kever app option
+interface AppOptions {
    bodyparser?: Options;
    env?: Env;
    exclude?: string[];
    host?: string;
    include?: string[];
    logger?: Logger;
    middlewares?: (string | Middleware)[];
    port?: number;
    tsconfig?: string;
}
    bodyparser?: Options;
    env?: Env;
    exclude?: string[];
    host?: string;
    include?: string[];
    logger?: Logger;
    middlewares?: (string | Middleware)[];
    port?: number;
    tsconfig?: string;
}
Index
Properties
Properties
Optional bodyparser
bodyparser?: Options
Optional env
app env, default is development
+Optional exclude
exclude?: string[]
Exclude load modules file path，follow the glob npm package rules.
+By default it will exclude ['node_modules/**'].
+The current working directory in which to search. Defaults to process.cwd().
See
+Optional host
host?: string
http host, default is 127.0.0.1
+Optional include
include?: string[]
Auto load modules file path，follow the glob npm package rules.
+By default it will include ['src/app/**/*.{ts,js}']
+The current working directory in which to search. Defaults to process.cwd().
See
+Optional logger
custom logger, default is console
+Optional middlewares
middlewares?: (string | Middleware)[]
koa or kever middlewares
+Optional port
port?: number
http port, default is 8080
+Optional tsconfig
tsconfig?: string
tsoncifg file path, default is root tsconfig file
+Generated using TypeDoc
Interface Context
interface Context {
    URL: URL;
    accept: Accepts;
    app: __module;
    assert: typeof assert;
    body: unknown;
    cookies: Cookies;
    etag: string;
    fresh: boolean;
    getBody: (<T>(key?) => undefined | T);
    getParams: (<T>(key?) => undefined | T);
    getQuery: (<T>(key?) => undefined | T);
    header: IncomingHttpHeaders;
    headerSent: boolean;
    headers: IncomingHttpHeaders;
    host: string;
    hostname: string;
    href: string;
    html: ((string) => void);
    idempotent: boolean;
    ip: string;
    ips: string[];
    json: ((object) => void);
    lastModified: Date;
    length: number;
    logger: Logger;
    message: string;
    method: string;
    origin: string;
    originalUrl: string;
    path: string;
    protocol: string;
    query: ParsedUrlQuery;
    querystring: string;
    req: IncomingMessage;
    request: Request;
    res: ServerResponse;
    respond?: boolean;
    response: Response & {
        body: unknown;
    };
    search: string;
    secure: boolean;
    socket: Socket;
    stale: boolean;
    state: DefaultState;
    status: number;
    subdomains: string[];
    type: string;
    url: string;
    writable: boolean;
    accepts(): string[];
    accepts(...types): string | false;
    accepts(types): string | false;
    acceptsCharsets(): string[];
    acceptsCharsets(...charsets): string | false;
    acceptsCharsets(charsets): string | false;
    acceptsEncodings(): string[];
    acceptsEncodings(...encodings): string | false;
    acceptsEncodings(encodings): string | false;
    acceptsLanguages(): string[];
    acceptsLanguages(...langs): string | false;
    acceptsLanguages(langs): string | false;
    append(field, val): void;
    attachment(filename?, options?): void;
    flushHeaders(): void;
    get(field): string;
    inspect(): any;
    is(...types): null | string | false;
    is(types): null | string | false;
    onerror(err): void;
    redirect(url, alt?): void;
    remove(field): void;
    set(field): void;
    set(field, val): void;
    throw(message, code?, properties?): never;
    throw(status): never;
    throw(...properties): never;
    toJSON(): any;
    vary(field): void;
}
    URL: URL;
    accept: Accepts;
    app: __module;
    assert: typeof assert;
    body: unknown;
    cookies: Cookies;
    etag: string;
    fresh: boolean;
    getBody: (<T>(key?) => undefined | T);
    getParams: (<T>(key?) => undefined | T);
    getQuery: (<T>(key?) => undefined | T);
    header: IncomingHttpHeaders;
    headerSent: boolean;
    headers: IncomingHttpHeaders;
    host: string;
    hostname: string;
    href: string;
    html: ((string) => void);
    idempotent: boolean;
    ip: string;
    ips: string[];
    json: ((object) => void);
    lastModified: Date;
    length: number;
    logger: Logger;
    message: string;
    method: string;
    origin: string;
    originalUrl: string;
    path: string;
    protocol: string;
    query: ParsedUrlQuery;
    querystring: string;
    req: IncomingMessage;
    request: Request;
    res: ServerResponse;
    respond?: boolean;
    response: Response & {
        body: unknown;
    };
    search: string;
    secure: boolean;
    socket: Socket;
    stale: boolean;
    state: DefaultState;
    status: number;
    subdomains: string[];
    type: string;
    url: string;
    writable: boolean;
    accepts(): string[];
    accepts(...types): string | false;
    accepts(types): string | false;
    acceptsCharsets(): string[];
    acceptsCharsets(...charsets): string | false;
    acceptsCharsets(charsets): string | false;
    acceptsEncodings(): string[];
    acceptsEncodings(...encodings): string | false;
    acceptsEncodings(encodings): string | false;
    acceptsLanguages(): string[];
    acceptsLanguages(...langs): string | false;
    acceptsLanguages(langs): string | false;
    append(field, val): void;
    attachment(filename?, options?): void;
    flushHeaders(): void;
    get(field): string;
    inspect(): any;
    is(...types): null | string | false;
    is(types): null | string | false;
    onerror(err): void;
    redirect(url, alt?): void;
    remove(field): void;
    set(field): void;
    set(field, val): void;
    throw(message, code?, properties?): never;
    throw(status): never;
    throw(...properties): never;
    toJSON(): any;
    vary(field): void;
}
Hierarchy (view full)
- KoaContext
- Context
Index
Properties
URL
+accept
+app
+assert
+body
+cookies
+etag
+fresh
+get
Methods
accepts
+accepts
Properties
URL
URL: URL
Get WHATWG parsed URL object.
+accept
accept: Accepts
app
app: __module
assert
assert: typeof assert
Similar to .throw(), adds assertion.
+this.assert(this.user, 401, 'Please login!');
+ +body
body: unknown
Get/Set response body.
+cookies
cookies: Cookies
etag
etag: string
Get/Set the ETag of a response. +This will normalize the quotes if necessary.
+this.response.etag = 'md5hashsum';
this.response.etag = '"md5hashsum"';
this.response.etag = 'W/"123456789"';
+Param: etag
Api
public
+fresh
fresh: boolean
Check if the request is fresh, aka +Last-Modified and/or the ETag +still match.
+get
get
get
header
header: IncomingHttpHeaders
Return request header.
+header
header
Check if a header has been written to the socket.
+headers
headers: IncomingHttpHeaders
Return request header, alias as request.header
+host
host: string
Parse the "Host" header field host +and support X-Forwarded-Host when a +proxy is enabled.
+hostname
hostname: string
Parse the "Host" header field hostname +and support X-Forwarded-Host when a +proxy is enabled.
+href
href: string
Get full request URL.
+html
html: ((string) => void)
Type declaration
- (string): void
Parameters
- string: string
Returns void
idempotent
idempotent: boolean
Check if the request is idempotent.
+ip
ip: string
Request remote address. Supports X-Forwarded-For when app.proxy is true.
+ips
ips: string[]
When app.proxy is true, parse
+the "X-Forwarded-For" ip address list.
For example if the value were "client, proxy1, proxy2"
+you would receive the array ["client", "proxy1", "proxy2"]
+where "proxy2" is the furthest down-stream.
json
json: ((object) => void)
Type declaration
- (object): void
Parameters
- object: Record<string, unknown>
Returns void
last
last
Get the Last-Modified date in Date form, if it exists. +Set the Last-Modified date using a string or a Date.
+this.response.lastModified = new Date();
this.response.lastModified = '2013-09-13';
+length
length: number
Return parsed response Content-Length when present.
+Set Content-Length field to n.
logger
message
message: string
Get response status message
+method
method: string
Get/Set request method.
+origin
origin: string
Get origin of URL.
+original
original
path
path: string
Get request pathname. +Set pathname, retaining the query-string when present.
+protocol
protocol: string
Return the protocol string "http" or "https" +when requested with TLS. When the proxy setting +is enabled the "X-Forwarded-Proto" header +field will be trusted. If you're running behind +a reverse proxy that supplies https for you this +may be enabled.
+query
query: ParsedUrlQuery
Get parsed query-string. +Set query-string as an object.
+querystring
querystring: string
Get/Set query string.
+req
req: IncomingMessage
request
request: Request
res
res: ServerResponse
Optional respond
respond?: boolean
To bypass Koa's built-in response handling, you may explicitly set ctx.respond = false;
response
response: Response & {
    body: unknown;
}
    body: unknown;
}
Type declaration
body: unknown
search
search: string
Get the search string. Same as the querystring +except it includes the leading ?.
+Set the search string. Same as +response.querystring= but included for ubiquity.
+secure
secure: boolean
Short-hand for:
+this.protocol == 'https'
+socket
socket: Socket
Return the request socket.
+stale
stale: boolean
Check if the request is stale, aka +"Last-Modified" and / or the "ETag" for the +resource has changed.
+state
state: DefaultState
status
status: number
Get/Set response status code.
+subdomains
subdomains: string[]
Return subdomains as an array.
+Subdomains are the dot-separated parts of the host before the main domain
+of the app. By default, the domain of the app is assumed to be the last two
+parts of the host. This can be changed by setting app.subdomainOffset.
For example, if the domain is "tobi.ferrets.example.com":
+If app.subdomainOffset is not set, this.subdomains is
+["ferrets", "tobi"].
+If app.subdomainOffset is 3, this.subdomains is ["tobi"].
type
type: string
Return the response mime type void of +parameters such as "charset".
+Set Content-Type response header with type through mime.lookup()
+when it does not contain a charset.
Examples:
+this.type = '.html';
this.type = 'html';
this.type = 'json';
this.type = 'application/json';
this.type = 'png';
+url
url: string
Get/Set request URL.
+writable
writable: boolean
Checks if the request is writable. +Tests for the existence of the socket +as node sometimes does not set it.
+Methods
accepts
- accepts(): string[]
Check if the given
+type(s)is acceptable, returning +the best match when true, otherwisefalse, in which +case you should respond with 406 "Not Acceptable".The
+typevalue may be a single mime type string +such as "application/json", the extension name +such as "json" or an array["json", "html", "text/plain"]. When a list +or array is given the best match, if any is returned.Examples:
+
+// Accept: text/html
this.accepts('html');
// => "html"
// Accept: text/*, application/json
this.accepts('html');
// => "html"
this.accepts('text/html');
// => "text/html"
this.accepts('json', 'text');
// => "json"
this.accepts('application/json');
// => "application/json"
// Accept: text/*, application/json
this.accepts('image/png');
this.accepts('png');
// => undefined
// Accept: text/*;q=.5, application/json
this.accepts(['html', 'json']);
this.accepts('html', 'json');
// => "json" +Returns string[]
- accepts(...types): string | false
Parameters
Rest...types: string[]
Returns string | false
- accepts(types): string | false
Parameters
- types: string[]
Returns string | false
accepts
- accepts
Charsets(): string[] Return accepted charsets or best fit based on
+charsets.Given
+Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5+an array sorted by quality is returned:
+['utf-8', 'utf-7', 'iso-8859-1'] +Returns string[]
- accepts
Charsets(...charsets): string | false Parameters
Rest...charsets: string[]
Returns string | false
- accepts
Charsets(charsets): string | false Parameters
- charsets: string[]
Returns string | false
accepts
- accepts
Encodings(): string[] Return accepted encodings or best fit based on
+encodings.Given
+Accept-Encoding: gzip, deflate+an array sorted by quality is returned:
+['gzip', 'deflate'] +Returns string[]
- accepts
Encodings(...encodings): string | false Parameters
Rest...encodings: string[]
Returns string | false
- accepts
Encodings(encodings): string | false Parameters
- encodings: string[]
Returns string | false
accepts
- accepts
Languages(): string[] Return accepted languages or best fit based on
+langs.Given
+Accept-Language: en;q=0.8, es, pt+an array sorted by quality is returned:
+['es', 'pt', 'en'] +Returns string[]
- accepts
Languages(...langs): string | false Parameters
Rest...langs: string[]
Returns string | false
- accepts
Languages(langs): string | false Parameters
- langs: string[]
Returns string | false
append
- append(field, val): void
Append additional header
+fieldwith valueval.Examples:
+
+this.append('Link', ['<http://localhost/>', '<http://localhost:3000/>']);
this.append('Set-Cookie', 'foo=bar; Path=/; HttpOnly');
this.append('Warning', '199 Miscellaneous warning'); +Parameters
- field: string
- val: string | string[]
Returns void
attachment
flush
get
- get(field): string
Return request header. If the header is not set, will return an empty +string.
+The
+Referrerheader field is special-cased, bothReferrerand +Refererare interchangeable.Examples:
+
+this.get('Content-Type');
// => "text/plain"
this.get('content-type');
// => "text/plain"
this.get('Something');
// => '' +Parameters
- field: string
Returns string
inspect
is
- is(...types): null | string | false
Check if the incoming request contains the "Content-Type" +header field, and it contains any of the give mime
+types. +If there is no request body,nullis returned. +If there is no content type,falseis returned. +Otherwise, it returns the firsttypethat matches.Examples:
+
+// With Content-Type: text/html; charset=utf-8
this.is('html'); // => 'html'
this.is('text/html'); // => 'text/html'
this.is('text/*', 'application/json'); // => 'text/html'
// When Content-Type is application/json
this.is('json', 'urlencoded'); // => 'json'
this.is('application/json'); // => 'application/json'
this.is('html', 'application/*'); // => 'application/json'
this.is('html'); // => false +Parameters
Rest...types: string[]
Returns null | string | false
- is(types): null | string | false
Parameters
- types: string[]
Returns null | string | false
onerror
redirect
- redirect(url, alt?): void
Perform a 302 redirect to
+url.The string "back" is special-cased +to provide Referrer support, when Referrer +is not present
+altor "/" is used.Examples:
+this.redirect('back'); + this.redirect('back', '/index.html'); + this.redirect('/login'); + this.redirect('http://google.com');
+Parameters
- url: string
Optionalalt: string
Returns void
remove
set
- set(field): void
Set header
+fieldtoval, or pass +an object of header fields.Examples:
+this.set('Foo', ['bar', 'baz']); + this.set('Accept', 'application/json'); + this.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
+Parameters
- field: {
    [key: string]: string | string[];
}[key: string]: string | string[]
Returns void
- field: {
- set(field, val): void
Parameters
- field: string
- val: string | string[]
Returns void
throw
- throw(message, code?, properties?): never
Throw an error with
+msgand optionalstatus+defaulting to 500. Note that these are user-level +errors, and the message may be exposed to the client.this.throw(403) + this.throw('name required', 400) + this.throw(400, 'name required') + this.throw('something exploded') + this.throw(new Error('invalid'), 400); + this.throw(400, new Error('invalid'));
+ +Parameters
- message: string
Optionalcode: numberOptionalproperties: {}
Returns never
- throw(status): never
Parameters
- status: number
Returns never
- throw(...properties): never
Parameters
Rest...properties: (string | number | {})[]
Returns never
toJSON
vary
Generated using TypeDoc
Interface Logger
interface Logger {
    debug: ((msg, ...args) => void);
    error: ((msg, ...args) => void);
    fatal: ((msg) => void);
    info: ((msg, ...args) => void);
    trace: ((msg, ...args) => void);
    warn: ((msg, ...args) => void);
}
    debug: ((msg, ...args) => void);
    error: ((msg, ...args) => void);
    fatal: ((msg) => void);
    info: ((msg, ...args) => void);
    trace: ((msg, ...args) => void);
    warn: ((msg, ...args) => void);
}
Properties
debug
debug: ((msg, ...args) => void)
Type declaration
- (msg, ...args): void
Parameters
- msg: string
Rest...args: unknown[]
Returns void
error
error: ((msg, ...args) => void)
Type declaration
- (msg, ...args): void
Parameters
- msg: string
Rest...args: unknown[]
Returns void
fatal
fatal: ((msg) => void)
Type declaration
- (msg): void
Parameters
- msg: string
Returns void
info
info: ((msg, ...args) => void)
Type declaration
- (msg, ...args): void
Parameters
- msg: string
Rest...args: unknown[]
Returns void
trace
trace: ((msg, ...args) => void)
Type declaration
- (msg, ...args): void
Parameters
- msg: string
Rest...args: unknown[]
Returns void
warn
warn: ((msg, ...args) => void)
Type declaration
- (msg, ...args): void
Parameters
- msg: string
Rest...args: unknown[]
Returns void
Generated using TypeDoc
Generated using TypeDoc
Interface RouteMiddlewareMeta
interface RouteMiddlewareMeta {
    0: KeverMiddleware[];
    1: KeverMiddleware[];
    middlewareKey: Tag;
}
    0: KeverMiddleware[];
    1: KeverMiddleware[];
    middlewareKey: Tag;
}
Index
Properties
Properties
0
1
middleware
Generated using TypeDoc
Interface ControllerMeta
Index
Properties
controller
+path
+
Properties
controller
controller: Object
path
path: string
Generated using TypeDoc
Interface KoaContext
interface KoaContext {
    URL: URL;
    accept: Accepts;
    app: __module;
    assert: typeof assert;
    body: unknown;
    cookies: Cookies;
    etag: string;
    fresh: boolean;
    header: IncomingHttpHeaders;
    headerSent: boolean;
    headers: IncomingHttpHeaders;
    host: string;
    hostname: string;
    href: string;
    idempotent: boolean;
    ip: string;
    ips: string[];
    lastModified: Date;
    length: number;
    message: string;
    method: string;
    origin: string;
    originalUrl: string;
    path: string;
    protocol: string;
    query: ParsedUrlQuery;
    querystring: string;
    req: IncomingMessage;
    request: Request;
    res: ServerResponse;
    respond?: boolean;
    response: Response & {
        body: unknown;
    };
    search: string;
    secure: boolean;
    socket: Socket;
    stale: boolean;
    state: DefaultState;
    status: number;
    subdomains: string[];
    type: string;
    url: string;
    writable: boolean;
    accepts(): string[];
    accepts(...types): string | false;
    accepts(types): string | false;
    acceptsCharsets(): string[];
    acceptsCharsets(...charsets): string | false;
    acceptsCharsets(charsets): string | false;
    acceptsEncodings(): string[];
    acceptsEncodings(...encodings): string | false;
    acceptsEncodings(encodings): string | false;
    acceptsLanguages(): string[];
    acceptsLanguages(...langs): string | false;
    acceptsLanguages(langs): string | false;
    append(field, val): void;
    attachment(filename?, options?): void;
    flushHeaders(): void;
    get(field): string;
    inspect(): any;
    is(...types): null | string | false;
    is(types): null | string | false;
    onerror(err): void;
    redirect(url, alt?): void;
    remove(field): void;
    set(field): void;
    set(field, val): void;
    throw(message, code?, properties?): never;
    throw(status): never;
    throw(...properties): never;
    toJSON(): any;
    vary(field): void;
}
    URL: URL;
    accept: Accepts;
    app: __module;
    assert: typeof assert;
    body: unknown;
    cookies: Cookies;
    etag: string;
    fresh: boolean;
    header: IncomingHttpHeaders;
    headerSent: boolean;
    headers: IncomingHttpHeaders;
    host: string;
    hostname: string;
    href: string;
    idempotent: boolean;
    ip: string;
    ips: string[];
    lastModified: Date;
    length: number;
    message: string;
    method: string;
    origin: string;
    originalUrl: string;
    path: string;
    protocol: string;
    query: ParsedUrlQuery;
    querystring: string;
    req: IncomingMessage;
    request: Request;
    res: ServerResponse;
    respond?: boolean;
    response: Response & {
        body: unknown;
    };
    search: string;
    secure: boolean;
    socket: Socket;
    stale: boolean;
    state: DefaultState;
    status: number;
    subdomains: string[];
    type: string;
    url: string;
    writable: boolean;
    accepts(): string[];
    accepts(...types): string | false;
    accepts(types): string | false;
    acceptsCharsets(): string[];
    acceptsCharsets(...charsets): string | false;
    acceptsCharsets(charsets): string | false;
    acceptsEncodings(): string[];
    acceptsEncodings(...encodings): string | false;
    acceptsEncodings(encodings): string | false;
    acceptsLanguages(): string[];
    acceptsLanguages(...langs): string | false;
    acceptsLanguages(langs): string | false;
    append(field, val): void;
    attachment(filename?, options?): void;
    flushHeaders(): void;
    get(field): string;
    inspect(): any;
    is(...types): null | string | false;
    is(types): null | string | false;
    onerror(err): void;
    redirect(url, alt?): void;
    remove(field): void;
    set(field): void;
    set(field, val): void;
    throw(message, code?, properties?): never;
    throw(status): never;
    throw(...properties): never;
    toJSON(): any;
    vary(field): void;
}
Hierarchy (view full)
- ParameterizedContext
- KoaContext
Index
Properties
URL
+accept
+app
+assert
+body
+cookies
+etag
+fresh
+header
+header
Methods
accepts
+accepts
Properties
URL
URL: URL
Get WHATWG parsed URL object.
+accept
accept: Accepts
app
app: __module
assert
assert: typeof assert
Similar to .throw(), adds assertion.
+this.assert(this.user, 401, 'Please login!');
+ +body
body: unknown
Get/Set response body.
+cookies
cookies: Cookies
etag
etag: string
Get/Set the ETag of a response. +This will normalize the quotes if necessary.
+this.response.etag = 'md5hashsum';
this.response.etag = '"md5hashsum"';
this.response.etag = 'W/"123456789"';
+Param: etag
Api
public
+fresh
fresh: boolean
Check if the request is fresh, aka +Last-Modified and/or the ETag +still match.
+header
header: IncomingHttpHeaders
Return request header.
+header
header
Check if a header has been written to the socket.
+headers
headers: IncomingHttpHeaders
Return request header, alias as request.header
+host
host: string
Parse the "Host" header field host +and support X-Forwarded-Host when a +proxy is enabled.
+hostname
hostname: string
Parse the "Host" header field hostname +and support X-Forwarded-Host when a +proxy is enabled.
+href
href: string
Get full request URL.
+idempotent
idempotent: boolean
Check if the request is idempotent.
+ip
ip: string
Request remote address. Supports X-Forwarded-For when app.proxy is true.
+ips
ips: string[]
When app.proxy is true, parse
+the "X-Forwarded-For" ip address list.
For example if the value were "client, proxy1, proxy2"
+you would receive the array ["client", "proxy1", "proxy2"]
+where "proxy2" is the furthest down-stream.
last
last
Get the Last-Modified date in Date form, if it exists. +Set the Last-Modified date using a string or a Date.
+this.response.lastModified = new Date();
this.response.lastModified = '2013-09-13';
+length
length: number
Return parsed response Content-Length when present.
+Set Content-Length field to n.
message
message: string
Get response status message
+method
method: string
Get/Set request method.
+origin
origin: string
Get origin of URL.
+original
original
path
path: string
Get request pathname. +Set pathname, retaining the query-string when present.
+protocol
protocol: string
Return the protocol string "http" or "https" +when requested with TLS. When the proxy setting +is enabled the "X-Forwarded-Proto" header +field will be trusted. If you're running behind +a reverse proxy that supplies https for you this +may be enabled.
+query
query: ParsedUrlQuery
Get parsed query-string. +Set query-string as an object.
+querystring
querystring: string
Get/Set query string.
+req
req: IncomingMessage
request
request: Request
res
res: ServerResponse
Optional respond
respond?: boolean
To bypass Koa's built-in response handling, you may explicitly set ctx.respond = false;
response
response: Response & {
    body: unknown;
}
    body: unknown;
}
Type declaration
body: unknown
search
search: string
Get the search string. Same as the querystring +except it includes the leading ?.
+Set the search string. Same as +response.querystring= but included for ubiquity.
+secure
secure: boolean
Short-hand for:
+this.protocol == 'https'
+socket
socket: Socket
Return the request socket.
+stale
stale: boolean
Check if the request is stale, aka +"Last-Modified" and / or the "ETag" for the +resource has changed.
+state
state: DefaultState
status
status: number
Get/Set response status code.
+subdomains
subdomains: string[]
Return subdomains as an array.
+Subdomains are the dot-separated parts of the host before the main domain
+of the app. By default, the domain of the app is assumed to be the last two
+parts of the host. This can be changed by setting app.subdomainOffset.
For example, if the domain is "tobi.ferrets.example.com":
+If app.subdomainOffset is not set, this.subdomains is
+["ferrets", "tobi"].
+If app.subdomainOffset is 3, this.subdomains is ["tobi"].
type
type: string
Return the response mime type void of +parameters such as "charset".
+Set Content-Type response header with type through mime.lookup()
+when it does not contain a charset.
Examples:
+this.type = '.html';
this.type = 'html';
this.type = 'json';
this.type = 'application/json';
this.type = 'png';
+url
url: string
Get/Set request URL.
+writable
writable: boolean
Checks if the request is writable. +Tests for the existence of the socket +as node sometimes does not set it.
+Methods
accepts
- accepts(): string[]
Check if the given
+type(s)is acceptable, returning +the best match when true, otherwisefalse, in which +case you should respond with 406 "Not Acceptable".The
+typevalue may be a single mime type string +such as "application/json", the extension name +such as "json" or an array["json", "html", "text/plain"]. When a list +or array is given the best match, if any is returned.Examples:
+
+// Accept: text/html
this.accepts('html');
// => "html"
// Accept: text/*, application/json
this.accepts('html');
// => "html"
this.accepts('text/html');
// => "text/html"
this.accepts('json', 'text');
// => "json"
this.accepts('application/json');
// => "application/json"
// Accept: text/*, application/json
this.accepts('image/png');
this.accepts('png');
// => undefined
// Accept: text/*;q=.5, application/json
this.accepts(['html', 'json']);
this.accepts('html', 'json');
// => "json" +Returns string[]
- accepts(...types): string | false
Parameters
Rest...types: string[]
Returns string | false
- accepts(types): string | false
Parameters
- types: string[]
Returns string | false
accepts
- accepts
Charsets(): string[] Return accepted charsets or best fit based on
+charsets.Given
+Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5+an array sorted by quality is returned:
+['utf-8', 'utf-7', 'iso-8859-1'] +Returns string[]
- accepts
Charsets(...charsets): string | false Parameters
Rest...charsets: string[]
Returns string | false
- accepts
Charsets(charsets): string | false Parameters
- charsets: string[]
Returns string | false
accepts
- accepts
Encodings(): string[] Return accepted encodings or best fit based on
+encodings.Given
+Accept-Encoding: gzip, deflate+an array sorted by quality is returned:
+['gzip', 'deflate'] +Returns string[]
- accepts
Encodings(...encodings): string | false Parameters
Rest...encodings: string[]
Returns string | false
- accepts
Encodings(encodings): string | false Parameters
- encodings: string[]
Returns string | false
accepts
- accepts
Languages(): string[] Return accepted languages or best fit based on
+langs.Given
+Accept-Language: en;q=0.8, es, pt+an array sorted by quality is returned:
+['es', 'pt', 'en'] +Returns string[]
- accepts
Languages(...langs): string | false Parameters
Rest...langs: string[]
Returns string | false
- accepts
Languages(langs): string | false Parameters
- langs: string[]
Returns string | false
append
- append(field, val): void
Append additional header
+fieldwith valueval.Examples:
+
+this.append('Link', ['<http://localhost/>', '<http://localhost:3000/>']);
this.append('Set-Cookie', 'foo=bar; Path=/; HttpOnly');
this.append('Warning', '199 Miscellaneous warning'); +Parameters
- field: string
- val: string | string[]
Returns void
attachment
flush
get
- get(field): string
Return request header. If the header is not set, will return an empty +string.
+The
+Referrerheader field is special-cased, bothReferrerand +Refererare interchangeable.Examples:
+
+this.get('Content-Type');
// => "text/plain"
this.get('content-type');
// => "text/plain"
this.get('Something');
// => '' +Parameters
- field: string
Returns string
inspect
is
- is(...types): null | string | false
Check if the incoming request contains the "Content-Type" +header field, and it contains any of the give mime
+types. +If there is no request body,nullis returned. +If there is no content type,falseis returned. +Otherwise, it returns the firsttypethat matches.Examples:
+
+// With Content-Type: text/html; charset=utf-8
this.is('html'); // => 'html'
this.is('text/html'); // => 'text/html'
this.is('text/*', 'application/json'); // => 'text/html'
// When Content-Type is application/json
this.is('json', 'urlencoded'); // => 'json'
this.is('application/json'); // => 'application/json'
this.is('html', 'application/*'); // => 'application/json'
this.is('html'); // => false +Parameters
Rest...types: string[]
Returns null | string | false
- is(types): null | string | false
Parameters
- types: string[]
Returns null | string | false
onerror
redirect
- redirect(url, alt?): void
Perform a 302 redirect to
+url.The string "back" is special-cased +to provide Referrer support, when Referrer +is not present
+altor "/" is used.Examples:
+this.redirect('back'); + this.redirect('back', '/index.html'); + this.redirect('/login'); + this.redirect('http://google.com');
+Parameters
- url: string
Optionalalt: string
Returns void
remove
set
- set(field): void
Set header
+fieldtoval, or pass +an object of header fields.Examples:
+this.set('Foo', ['bar', 'baz']); + this.set('Accept', 'application/json'); + this.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
+Parameters
- field: {
    [key: string]: string | string[];
}[key: string]: string | string[]
Returns void
- field: {
- set(field, val): void
Parameters
- field: string
- val: string | string[]
Returns void
throw
- throw(message, code?, properties?): never
Throw an error with
+msgand optionalstatus+defaulting to 500. Note that these are user-level +errors, and the message may be exposed to the client.this.throw(403) + this.throw('name required', 400) + this.throw(400, 'name required') + this.throw('something exploded') + this.throw(new Error('invalid'), 400); + this.throw(400, new Error('invalid'));
+ +Parameters
- message: string
Optionalcode: numberOptionalproperties: {}
Returns never
- throw(status): never
Parameters
- status: number
Returns never
- throw(...properties): never
Parameters
Rest...properties: (string | number | {})[]
Returns never
toJSON
vary
Generated using TypeDoc
Module cli/src
Index
Functions
default
+
Generated using TypeDoc
Generated using TypeDoc
Module enhance/src
Index
Functions
Generated using TypeDoc
Module ioc/src
Index
Enumerations
Interfaces
Functions
Generated using TypeDoc
Module kever/src
Index
References
Functions
References
Aop
Re-exports AopApp
Re-exports AppApp
Re-exports AppOptionsBase
Re-exports BaseMiddlewareContext
Re-exports ContextController
Re-exports ControllerEnv
Re-exports EnvInject
Re-exports InjectInjectable
Re-exports InjectableLogger
Re-exports LoggerMType
Re-exports MTypeMiddleware
Re-exports MiddlewareNext
Re-exports NextProperty
Re-exports PropertyRoute
Re-exports RouteRoute
Re-exports RouteMiddlewareMetacreate
Re-exports createAppdestory
Re-exports destoryAllMiddlewareenhance
Re-exports enhanceMiddlewareget
Re-exports getGlobalMiddlewareget
Re-exports getInjectableNumget
Re-exports getMiddlewaresNumpatch
Re-exports patchMiddlewareGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Type alias Next
Generated using TypeDoc
Type alias Instance
Instance: (new (...args) => unknown)
Type declaration
- new (...args): unknown
Parameters
Rest...args: unknown[]
Returns unknown
Generated using TypeDoc
Generated using TypeDoc
Type alias KoaMiddleware
Koa
Type declaration
- (context, next): void
Parameters
- context: KoaContext
- next: KoaNext
Returns void
Generated using TypeDoc
Type alias KoaNext
Koa
Type declaration
- (): Promise<any>
Returns Promise<any>
Generated using TypeDoc
Type alias Tag
Tag: string | symbol
Generated using TypeDoc
Generated using TypeDoc
Variable META_INJECT_PROPERTYConst
Generated using TypeDoc
Variable META_LOGGERConst
Generated using TypeDoc
Variable META_MIDDLEWARE_ALLConst
Generated using TypeDoc
Variable META_MIDDLEWARE_GLOBALConst
Generated using TypeDoc
Variable META_MIDDLEWARE_ROUTERConst
Generated using TypeDoc
Variable META_ROUTERConst
Generated using TypeDoc
Generated using TypeDoc
app env
+