UNPKG

@twin.org/api-tenant-processor

Version:

API Tenant Processor for converting and api key to a tenant id.

twindev.org

twinfoundation/api

100 lines (50 loc) • 1.35 kB
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
# Class: TenantProcessor Handles incoming api keys and maps them to tenant ids. ## Implements - `IBaseRouteProcessor` ## Constructors ### Constructor > **new TenantProcessor**(`options?`): `TenantProcessor` Create a new instance of NodeTenantProcessor. #### Parameters ##### options? [`ITenantProcessorConstructorOptions`](../interfaces/ITenantProcessorConstructorOptions.md) Options for the processor. #### Returns `TenantProcessor` ## Properties ### CLASS\_NAME > `readonly` `static` **CLASS\_NAME**: `string` Runtime name for the class. ## Methods ### className() > **className**(): `string` Returns the class name of the component. #### Returns `string` The class name of the component. #### Implementation of `IBaseRouteProcessor.className` *** ### pre() > **pre**(`request`, `response`, `route`, `contextIds`, `processorState`): `Promise`\<`void`\> Pre process the REST request for the specified route. #### Parameters ##### request `IHttpServerRequest` The incoming request. ##### response `IHttpResponse` The outgoing response. ##### route The route to process. `IBaseRoute` | `undefined` ##### contextIds `IContextIds` The context IDs of the request. ##### processorState The state handed through the processors. #### Returns `Promise`\<`void`\> #### Implementation of `IBaseRouteProcessor.pre`