Skip to content

Commit

Permalink
Add .d.ts for TypeScript compatibility (#401)
Browse files Browse the repository at this point in the history
* Add .d.ts for TypeScript compatibility

* Make json method return any
  • Loading branch information
timneutkens committed May 13, 2019
1 parent 3d5738a commit 167f32d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
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

0 comments on commit 167f32d

Please sign in to comment.