Skip to content

Commit 167f32d

Browse files
authored
Add .d.ts for TypeScript compatibility (#401)
* Add .d.ts for TypeScript compatibility * Make json method return any
1 parent 3d5738a commit 167f32d

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

packages/micro/micro.d.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
/// <reference types="node" />
2+
3+
import { RequestListener, IncomingMessage, ServerResponse } from 'http'
4+
5+
export type RequestHandler = (req: IncomingMessage, res: ServerResponse) => any
6+
declare function serve(fn: RequestHandler): RequestListener
7+
8+
export function run(req: IncomingMessage, res: ServerResponse, fn: RequestHandler): Promise<void>
9+
export function json(req: IncomingMessage, info?: { limit?: string | number, encoding?: string }): Promise<any>
10+
export function text(req: IncomingMessage, info?: { limit?: string | number, encoding?: string }): Promise<string>
11+
export function buffer(req: IncomingMessage, info?: { limit?: string | number, encoding?: string }): Promise<Buffer | string>
12+
export function send(res: ServerResponse, code: number, data?: any): Promise<void>
13+
export function createError(code: number, msg: string, orig?: Error): Error & { statusCode: number, originalError?: Error }
14+
export function sendError(req: IncomingMessage, res: ServerResponse, info: { statusCode?: number, status?: number, message?: string, stack?: string }): Promise<void>
15+
export default serve

packages/micro/package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44
"description": "Asynchronous HTTP microservices",
55
"license": "MIT",
66
"main": "./lib/index.js",
7+
"types": "./micro.d.ts",
78
"files": [
89
"bin",
9-
"lib"
10+
"lib",
11+
"micro.d.ts"
1012
],
1113
"bin": {
1214
"micro": "./bin/micro.js"

0 commit comments

Comments
 (0)