@types/easy-xapi

TypeScript definitions for easy-xapi

Stats

StarsIssuesVersionUpdatedCreatedSize
@types/easy-xapi
0.0.384 months ago5 years agoMinified + gzip package size for @types/easy-xapi in KB

Readme

Installation

npm install --save @types/easy-xapi

Summary

This package contains type definitions for easy-xapi (https://github.com/DeadAlready/easy-xapi).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/easy-xapi.

index.d.ts

// Type definitions for easy-xapi
// Project: https://github.com/DeadAlready/easy-xapi
// Definitions by: Karl Düüna <https://github.com/DeadAlready>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3

/// <reference types="easy-jsend" />
/// <reference types="bunyan" />
/// <reference types="express" />
/// <reference types="node" />

declare namespace Express {
    export interface Request {
        log: any;
    }
}

declare module "easy-xapi" {
    import express = require('express');
    import http = require('http');
    import Logger = require('bunyan');

    interface InitConfig {
        jSend?: {partial: boolean} | undefined;
    }

    interface Config {
        root: string;
        port: number;
        name: string;
        xHeaderDefaults?: Object | undefined;
        log: {
            name: string;
            level: string
        }
        mount: (app: express.Application) => void
    }

    interface Result {
        express: any;
        app: express.Application;
        server: http.Server;
        log: Logger;
        listen: () => void;
    }

    export function init(conf: InitConfig): void;
    export function create(conf: Config): Result;
}

Additional Details

Credits

These definitions were written by Karl Düüna.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.