-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
request.test-d.ts
157 lines (138 loc) · 5.84 KB
/
request.test-d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
import { expectAssignable, expectType } from 'tsd'
import pino from 'pino'
import fastify, {
RouteHandler,
RawRequestDefaultExpression,
RequestBodyDefault,
RequestGenericInterface,
FastifyContext,
ContextConfigDefault,
FastifyContextConfig,
FastifyLogFn,
RouteHandlerMethod,
RawServerDefault,
RawReplyDefaultExpression,
FastifySchema,
FastifyTypeProviderDefault
} from '../../fastify'
import { RequestParamsDefault, RequestHeadersDefault, RequestQuerystringDefault } from '../../types/utils'
import { FastifyLoggerInstance } from '../../types/logger'
import { FastifyRequest, RequestRouteOptions } from '../../types/request'
import { FastifyReply } from '../../types/reply'
import { FastifyInstance } from '../../types/instance'
import { RouteGenericInterface } from '../../types/route'
interface RequestBody {
content: string;
}
interface RequestQuerystring {
from: string;
}
interface RequestParams {
id: number;
}
interface RequestHeaders {
'x-foobar': string;
}
interface RequestData extends RequestGenericInterface {
Body: RequestBody;
Querystring: RequestQuerystring;
Params: RequestParams;
Headers: RequestHeaders;
}
type Handler = RouteHandler<RequestData>
type CustomRequest = FastifyRequest<{
Body: RequestBody | undefined;
Querystring: RequestQuerystring;
Params: RequestParams;
Headers: RequestHeaders;
}>
type HTTPRequestPart = 'body' | 'query' | 'querystring' | 'params' | 'headers'
type ExpectedGetValidationFunction = (input: {[key: string]: unknown}) => boolean
interface CustomLoggerInterface extends FastifyLoggerInstance {
foo: FastifyLogFn; // custom severity logger method
}
const getHandler: RouteHandler = function (request, _reply) {
expectType<string>(request.url)
expectType<string>(request.method)
expectType<string>(request.routerPath)
expectType<string>(request.routerMethod)
expectType<Readonly<RequestRouteOptions>>(request.routeOptions)
expectType<boolean>(request.is404)
expectType<string>(request.hostname)
expectType<string>(request.ip)
expectType<string[] | undefined>(request.ips)
expectType<RawRequestDefaultExpression>(request.raw)
expectType<RequestBodyDefault>(request.body)
expectType<RequestParamsDefault>(request.params)
expectType<FastifyContext<ContextConfigDefault>>(request.context)
expectType<FastifyContextConfig>(request.context.config)
expectType<FastifyContextConfig>(request.routeConfig)
expectType<FastifySchema>(request.routeSchema)
expectType<RequestHeadersDefault & RawRequestDefaultExpression['headers']>(request.headers)
request.headers = {}
expectType<RequestQuerystringDefault>(request.query)
expectType<any>(request.id)
expectType<FastifyLoggerInstance>(request.log)
expectType<RawRequestDefaultExpression['socket']>(request.socket)
expectType<Error & { validation: any; validationContext: string } | undefined>(request.validationError)
expectType<FastifyInstance>(request.server)
expectAssignable<(httpPart: HTTPRequestPart) => ExpectedGetValidationFunction>(request.getValidationFunction)
expectAssignable<(schema: {[key: string]: unknown}) => ExpectedGetValidationFunction>(request.getValidationFunction)
expectAssignable<(input: {[key: string]: unknown}, schema: {[key: string]: unknown}, httpPart?: HTTPRequestPart) => boolean>(request.validateInput)
expectAssignable<(input: {[key: string]: unknown}, httpPart?: HTTPRequestPart) => boolean>(request.validateInput)
}
const getHandlerWithCustomLogger: RouteHandlerMethod<RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, RouteGenericInterface, ContextConfigDefault, FastifySchema, FastifyTypeProviderDefault, CustomLoggerInterface> = function (request, _reply) {
expectType<CustomLoggerInterface>(request.log)
}
const postHandler: Handler = function (request) {
expectType<RequestBody>(request.body)
expectType<RequestParams>(request.params)
expectType<RequestHeaders & RawRequestDefaultExpression['headers']>(request.headers)
expectType<RequestQuerystring>(request.query)
expectType<string>(request.body.content)
expectType<string>(request.query.from)
expectType<number>(request.params.id)
expectType<string>(request.headers['x-foobar'])
expectType<FastifyInstance>(request.server)
expectType<FastifyContext<ContextConfigDefault>>(request.context)
expectType<FastifyContextConfig>(request.context.config)
}
function putHandler (request: CustomRequest, reply: FastifyReply) {
expectType<RequestBody | undefined>(request.body)
expectType<RequestParams>(request.params)
expectType<RequestHeaders & RawRequestDefaultExpression['headers']>(request.headers)
expectType<RequestQuerystring>(request.query)
if (typeof request.body === 'undefined') {
expectType<undefined>(request.body)
} else {
expectType<string>(request.body.content)
}
expectType<string>(request.query.from)
expectType<number>(request.params.id)
expectType<string>(request.headers['x-foobar'])
expectType<FastifyInstance>(request.server)
expectType<FastifyContext<ContextConfigDefault>>(request.context)
expectType<FastifyContextConfig>(request.context.config)
}
const server = fastify()
server.get('/get', getHandler)
server.post('/post', postHandler)
server.put('/put', putHandler)
const customLogger: CustomLoggerInterface = {
level: 'info',
silent: () => { },
info: () => { },
warn: () => { },
error: () => { },
fatal: () => { },
trace: () => { },
debug: () => { },
foo: () => { }, // custom severity logger method
child: () => customLogger as pino.Logger<never>
}
const serverWithCustomLogger = fastify({ logger: customLogger })
expectType<
FastifyInstance<RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, CustomLoggerInterface>
& PromiseLike<FastifyInstance<RawServerDefault, RawRequestDefaultExpression, RawReplyDefaultExpression, CustomLoggerInterface>>
>(serverWithCustomLogger)
serverWithCustomLogger.get('/get', getHandlerWithCustomLogger)