Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add .d.ts for TypeScript compatibility #401

Merged
merged 2 commits into from May 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions packages/micro/micro.d.ts
@@ -0,0 +1,15 @@
/// <reference types="node" />

import { RequestListener, IncomingMessage, ServerResponse } from 'http'

export type RequestHandler = (req: IncomingMessage, res: ServerResponse) => any
declare function serve(fn: RequestHandler): RequestListener

export function run(req: IncomingMessage, res: ServerResponse, fn: RequestHandler): Promise<void>
export function json(req: IncomingMessage, info?: { limit?: string | number, encoding?: string }): Promise<any>
export function text(req: IncomingMessage, info?: { limit?: string | number, encoding?: string }): Promise<string>
export function buffer(req: IncomingMessage, info?: { limit?: string | number, encoding?: string }): Promise<Buffer | string>
export function send(res: ServerResponse, code: number, data?: any): Promise<void>
export function createError(code: number, msg: string, orig?: Error): Error & { statusCode: number, originalError?: Error }
export function sendError(req: IncomingMessage, res: ServerResponse, info: { statusCode?: number, status?: number, message?: string, stack?: string }): Promise<void>
export default serve
4 changes: 3 additions & 1 deletion packages/micro/package.json
Expand Up @@ -4,9 +4,11 @@
"description": "Asynchronous HTTP microservices",
"license": "MIT",
"main": "./lib/index.js",
"types": "./micro.d.ts",
"files": [
"bin",
"lib"
"lib",
"micro.d.ts"
],
"bin": {
"micro": "./bin/micro.js"
Expand Down