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

    Interface KitoServerInstance<TExtensions>

    interface KitoServerInstance<TExtensions = {}> {
        use(
            middleware: MiddlewareDefinition | MiddlewareHandler,
        ): KitoRouterInstance<TExtensions>;
        mount(
            path: string,
            router: KitoRouterInstance<TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        get<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        get<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        get<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        get<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        post<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        post<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        post<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        post<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        put<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        put<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        put<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        put<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        delete<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        delete<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        delete<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        delete<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        patch<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        patch<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        patch<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        patch<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        head<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        head<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        head<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        head<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        options<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        options<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
        ): KitoRouterInstance<TExtensions>;
        options<TSchema extends SchemaDefinition = {}>(
            path: string,
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        options<TSchema extends SchemaDefinition = {}>(
            path: string,
            middlewares:
                | MiddlewareDefinition
                | TSchema
                | (MiddlewareDefinition | TSchema)[],
            handler: RouteHandler<TSchema, TExtensions>,
            schema: TSchema,
        ): KitoRouterInstance<TExtensions>;
        route(path: string): RouteChain<TExtensions>;
        route(
            path: string,
            middlewares: MiddlewareDefinition | MiddlewareDefinition[],
        ): RouteChain<TExtensions>;
        listen(callback?: () => void): Promise<ServerOptions>;
        listen(port?: number, callback?: () => void): Promise<ServerOptions>;
        listen(
            port?: number,
            host?: string,
            callback?: () => void,
        ): Promise<ServerOptions>;
        listen(
            options: ServerOptions,
            callback?: () => void,
        ): Promise<ServerOptions>;
        close(): void;
    }

    Type Parameters

    • TExtensions = {}

    Hierarchy (View Summary)

    Implemented by

    Index

    Methods

    post