0.2.5 • Published 6 months ago

@types/cyberblast__webserver v0.2.5

Weekly downloads
1
License
MIT
Repository
github
Last release
6 months ago

Installation

npm install --save @types/cyberblast__webserver

Summary

This package contains type definitions for @cyberblast/webserver (https://github.com/cyberblast/WebServer).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cyberblast__webserver.

index.d.ts

// Type definitions for @cyberblast/webserver 0.2
// Project: https://github.com/cyberblast/WebServer
// Definitions by: cyberblast <https://github.com/cyberblast>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference types="node" />
import { IncomingMessage, ServerResponse } from "http";
import { Logger } from "@cyberblast/logger";

export interface ServerContext {
    server: WebServer;
    request: IncomingMessage;
    response: ServerResponse;
    logger?: Logger | undefined;
    client?: string | undefined;
    route?: { [key: string]: any } | undefined;
    data?: string | Buffer | undefined;
}

export class WebServer {
    constructor(webConfigFile?: string, logConfigFile?: string);
    start(): Promise<void>;
    stop(): void;
    respondError(error: string|Error, context: ServerContext, code?: number, message?: string): Promise<void>;
}

Additional Details

Credits

These definitions were written by cyberblast.