-
Notifications
You must be signed in to change notification settings - Fork 33
/
ServerMiddleware.ts
72 lines (68 loc) · 2.02 KB
/
ServerMiddleware.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
import {MethodDescriptor} from '../MethodDescriptor';
import {CallContext} from './CallContext';
/**
* Server middleware.
*
* Defined as an async generator function. The most basic no-op middleware looks
* like this:
*
* ```ts
* import {ServerMiddlewareCall, CallContext} from 'nice-grpc-common';
*
* async function* middleware<Request, Response>(
* call: ServerMiddlewareCall<Request, Response>,
* context: CallContext,
* ) {
* return yield* call.next(call.request, context);
* }
* ```
*
* @template CallContextExt Extra call context properties that are added by this
* middleware.
* @template RequiredCallContextExt Extra call context properties that are
* required by this middleware. Must be added by a middleware that is
* attached to the server before this middleware.
*/
export type ServerMiddleware<
CallContextExt = {},
RequiredCallContextExt = {},
> = <Request, Response>(
call: ServerMiddlewareCall<
Request,
Response,
CallContextExt & RequiredCallContextExt
>,
context: CallContext & RequiredCallContextExt,
) => AsyncGenerator<Response, Response | void, undefined>;
export type ServerMiddlewareCall<Request, Response, NextCallContextExt = {}> = {
method: MethodDescriptor;
} & ServerMiddlewareCallRequest<Request> &
ServerMiddlewareCallResponse<Request, Response, NextCallContextExt>;
export type ServerMiddlewareCallRequest<Request> =
| {
requestStream: false;
request: Request;
}
| {
requestStream: true;
request: AsyncIterable<Request>;
};
export type ServerMiddlewareCallResponse<
Request,
Response,
NextCallContextExt,
> =
| {
responseStream: false;
next(
request: Request | AsyncIterable<Request>,
context: CallContext & NextCallContextExt,
): AsyncGenerator<never, Response, undefined>;
}
| {
responseStream: true;
next(
request: Request | AsyncIterable<Request>,
context: CallContext & NextCallContextExt,
): AsyncGenerator<Response, void, undefined>;
};