@rapidrest/service-core 1.0.0-beta.4 → 1.0.0-beta.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/Server.js +30 -24
- package/dist/lib/Server.js.map +1 -1
- package/dist/lib/auth/JWTStrategy.js +2 -1
- package/dist/lib/auth/JWTStrategy.js.map +1 -1
- package/dist/lib/database/MongoSchemaSync.js +4 -4
- package/dist/lib/database/MongoSchemaSync.js.map +1 -1
- package/dist/lib/http/Adapters.js +31 -20
- package/dist/lib/http/Adapters.js.map +1 -1
- package/dist/lib/http/Router.js +11 -4
- package/dist/lib/http/Router.js.map +1 -1
- package/dist/lib/models/RepoUtils.js +17 -15
- package/dist/lib/models/RepoUtils.js.map +1 -1
- package/dist/lib/routes/ModelRoute.js +5 -4
- package/dist/lib/routes/ModelRoute.js.map +1 -1
- package/dist/lib/routes/RouteUtils.js +24 -18
- package/dist/lib/routes/RouteUtils.js.map +1 -1
- package/dist/lib/security/ACLUtils.js +62 -18
- package/dist/lib/security/ACLUtils.js.map +1 -1
- package/dist/types/auth/JWTStrategy.d.ts +1 -0
- package/dist/types/security/ACLUtils.d.ts +4 -1
- package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/TypeInfo.md +1 -1
- package/docs/reference/@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md +7 -7
- package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/EventListener.md +1 -1
- package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/OnEvent.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Cache.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/ChildEntity.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/DataStore.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Identifier.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Protect.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Reference.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Shard.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/TrackChanges.md +1 -1
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md +5 -5
- package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md +3 -3
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Unique.md +3 -3
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getColumnMetadata.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getEntityName.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getIndexMetadata.md +1 -1
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md +4 -4
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md +5 -5
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexInfo.md +4 -4
- package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/IndexOptions.md +5 -5
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/After.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Auth.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/AuthResult.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Before.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/ContentType.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Delete.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Get.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Head.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Header.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Method.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Model.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Options.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Param.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Patch.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Post.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Protect.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Put.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Query.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Request.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/RequiresRole.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Response.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Route.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Socket.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/User.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/Validate.md +1 -1
- package/docs/reference/@rapidrest/namespaces/RouteDecorators/functions/WebSocket.md +1 -1
- package/docs/reference/classes/ACLUtils.md +22 -10
- package/docs/reference/classes/AdminRoute.md +3 -3
- package/docs/reference/classes/AuthMiddleware.md +8 -8
- package/docs/reference/classes/BackgroundService.md +8 -8
- package/docs/reference/classes/BackgroundServiceManager.md +7 -7
- package/docs/reference/classes/BaseEntity.md +6 -6
- package/docs/reference/classes/BaseMongoEntity.md +7 -7
- package/docs/reference/classes/BasicStrategy.md +5 -5
- package/docs/reference/classes/BasicStrategyOptions.md +7 -7
- package/docs/reference/classes/BulkError.md +3 -3
- package/docs/reference/classes/ConnectionManager.md +4 -4
- package/docs/reference/classes/EventListenerManager.md +5 -5
- package/docs/reference/classes/HttpRouter.md +16 -16
- package/docs/reference/classes/JWTStrategy.md +10 -10
- package/docs/reference/classes/JWTStrategyOptions.md +10 -10
- package/docs/reference/classes/MetricsRoute.md +2 -2
- package/docs/reference/classes/ModelRoute.md +26 -26
- package/docs/reference/classes/ModelUtils.md +10 -10
- package/docs/reference/classes/MongoConnection.md +12 -12
- package/docs/reference/classes/MongoRepository.md +17 -17
- package/docs/reference/classes/MongoSchemaSync.md +7 -7
- package/docs/reference/classes/NetUtils.md +3 -3
- package/docs/reference/classes/NotificationUtils.md +3 -3
- package/docs/reference/classes/ObjectFactory.md +3 -3
- package/docs/reference/classes/OpenAPIRoute.md +5 -5
- package/docs/reference/classes/OpenApiSpec.md +45 -45
- package/docs/reference/classes/RecoverableBaseEntity.md +7 -7
- package/docs/reference/classes/RecoverableBaseMongoEntity.md +8 -8
- package/docs/reference/classes/RedisTransport.md +4 -4
- package/docs/reference/classes/RepoUtils.md +35 -35
- package/docs/reference/classes/RouteUtils.md +9 -9
- package/docs/reference/classes/Server.md +89 -89
- package/docs/reference/classes/SimpleEntity.md +3 -3
- package/docs/reference/classes/SimpleMongoEntity.md +4 -4
- package/docs/reference/classes/StatusExtraData.md +4 -4
- package/docs/reference/classes/StatusRoute.md +1 -1
- package/docs/reference/classes/UWSRequest.md +17 -17
- package/docs/reference/classes/UWSResponse.md +15 -15
- package/docs/reference/classes/UWSWebSocketShim.md +5 -5
- package/docs/reference/enumerations/ACLAction.md +7 -7
- package/docs/reference/enumerations/ApiErrorMessages.md +15 -15
- package/docs/reference/enumerations/ApiErrors.md +15 -15
- package/docs/reference/functions/createWebSocketStream.md +1 -1
- package/docs/reference/functions/isSqlDataSource.md +1 -1
- package/docs/reference/functions/readBody.md +3 -3
- package/docs/reference/functions/resolveCollectionName.md +1 -1
- package/docs/reference/functions/runChain.md +1 -1
- package/docs/reference/functions/snakeCase.md +1 -1
- package/docs/reference/interfaces/ACLRecord.md +8 -8
- package/docs/reference/interfaces/AccessControlList.md +5 -5
- package/docs/reference/interfaces/AuthResult.md +5 -5
- package/docs/reference/interfaces/AuthStrategy.md +4 -4
- package/docs/reference/interfaces/CreateRequestOptions.md +9 -9
- package/docs/reference/interfaces/DeleteRequestOptions.md +11 -11
- package/docs/reference/interfaces/FindRequestOptions.md +10 -10
- package/docs/reference/interfaces/HttpRequest.md +15 -15
- package/docs/reference/interfaces/HttpResponse.md +11 -11
- package/docs/reference/interfaces/JWTAuthResult.md +9 -9
- package/docs/reference/interfaces/RepoCreateOptions.md +7 -7
- package/docs/reference/interfaces/RepoDeleteOptions.md +9 -9
- package/docs/reference/interfaces/RepoFindOptions.md +11 -11
- package/docs/reference/interfaces/RepoOperationOptions.md +6 -6
- package/docs/reference/interfaces/RepoUpdateOptions.md +8 -8
- package/docs/reference/interfaces/RequestOptions.md +8 -8
- package/docs/reference/interfaces/RequestWS.md +17 -17
- package/docs/reference/interfaces/TruncateRequestOptions.md +13 -13
- package/docs/reference/interfaces/UpdateRequestOptions.md +11 -11
- package/docs/reference/type-aliases/ErrorHandler.md +1 -1
- package/docs/reference/type-aliases/NextFunction.md +1 -1
- package/docs/reference/type-aliases/OneOrMany.md +1 -1
- package/docs/reference/type-aliases/OneOrNull.md +1 -1
- package/docs/reference/type-aliases/PartialBaseEntity.md +1 -1
- package/docs/reference/type-aliases/PartialSimpleEntity.md +1 -1
- package/docs/reference/type-aliases/RequestHandler.md +1 -1
- package/docs/reference/type-aliases/UpdateObject.md +1 -1
- package/docs/reference/type-aliases/WsUpgradeAuth.md +1 -1
- package/docs/reference/type-aliases/WsUpgradeAuthResult.md +5 -5
- package/package.json +129 -125
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: BackgroundServiceManager
|
|
8
8
|
|
|
9
|
-
Defined in: [src/BackgroundServiceManager.ts:35](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/BackgroundServiceManager.ts:35](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L35)
|
|
10
10
|
|
|
11
11
|
The `BackgroundServiceManager` manages all configured background services in the application. It is responsible for
|
|
12
12
|
initializing the jobs, scheduling them and performing any related shutdown tasks. See the `BackgroundService`
|
|
@@ -43,7 +43,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
43
43
|
|
|
44
44
|
> **new BackgroundServiceManager**(`objectFactory`, `classes`, `config`, `logger`): `BackgroundServiceManager`
|
|
45
45
|
|
|
46
|
-
Defined in: [src/BackgroundServiceManager.ts:43](https://github.com/rapidrest/service-core/blob/
|
|
46
|
+
Defined in: [src/BackgroundServiceManager.ts:43](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L43)
|
|
47
47
|
|
|
48
48
|
#### Parameters
|
|
49
49
|
|
|
@@ -71,7 +71,7 @@ Defined in: [src/BackgroundServiceManager.ts:43](https://github.com/rapidrest/se
|
|
|
71
71
|
|
|
72
72
|
> **getService**(`name`): [`BackgroundService`](BackgroundService.md) \| `undefined`
|
|
73
73
|
|
|
74
|
-
Defined in: [src/BackgroundServiceManager.ts:55](https://github.com/rapidrest/service-core/blob/
|
|
74
|
+
Defined in: [src/BackgroundServiceManager.ts:55](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L55)
|
|
75
75
|
|
|
76
76
|
Returns the service instance with the given name.
|
|
77
77
|
|
|
@@ -93,7 +93,7 @@ The name of the background service to retrieve.
|
|
|
93
93
|
|
|
94
94
|
> **start**(`serviceName`, `clazz?`, ...`args`): `Promise`\<`void`\>
|
|
95
95
|
|
|
96
|
-
Defined in: [src/BackgroundServiceManager.ts:81](https://github.com/rapidrest/service-core/blob/
|
|
96
|
+
Defined in: [src/BackgroundServiceManager.ts:81](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L81)
|
|
97
97
|
|
|
98
98
|
Starts the background service with the given name.
|
|
99
99
|
|
|
@@ -127,7 +127,7 @@ The list of arguments to pass into the service constructor
|
|
|
127
127
|
|
|
128
128
|
> **startAll**(): `Promise`\<`void`\>
|
|
129
129
|
|
|
130
|
-
Defined in: [src/BackgroundServiceManager.ts:62](https://github.com/rapidrest/service-core/blob/
|
|
130
|
+
Defined in: [src/BackgroundServiceManager.ts:62](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L62)
|
|
131
131
|
|
|
132
132
|
Starts all configured background services.
|
|
133
133
|
|
|
@@ -141,7 +141,7 @@ Starts all configured background services.
|
|
|
141
141
|
|
|
142
142
|
> **stop**(`serviceName`): `Promise`\<`void`\>
|
|
143
143
|
|
|
144
|
-
Defined in: [src/BackgroundServiceManager.ts:139](https://github.com/rapidrest/service-core/blob/
|
|
144
|
+
Defined in: [src/BackgroundServiceManager.ts:139](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L139)
|
|
145
145
|
|
|
146
146
|
Stops the background service with the given name.
|
|
147
147
|
|
|
@@ -163,7 +163,7 @@ The name of the background service to stop.
|
|
|
163
163
|
|
|
164
164
|
> **stopAll**(): `Promise`\<`void`\>
|
|
165
165
|
|
|
166
|
-
Defined in: [src/BackgroundServiceManager.ts:124](https://github.com/rapidrest/service-core/blob/
|
|
166
|
+
Defined in: [src/BackgroundServiceManager.ts:124](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BackgroundServiceManager.ts#L124)
|
|
167
167
|
|
|
168
168
|
Stops all currently active background services that are owned by the manager.
|
|
169
169
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Abstract Class: BaseEntity
|
|
8
8
|
|
|
9
|
-
Defined in: [src/models/BaseEntity.ts:18](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/models/BaseEntity.ts:18](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L18)
|
|
10
10
|
|
|
11
11
|
Provides a common base class for all entity's that will be persisted to a datastore.
|
|
12
12
|
|
|
@@ -29,7 +29,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
29
29
|
|
|
30
30
|
> **new BaseEntity**(`other?`): `BaseEntity`
|
|
31
31
|
|
|
32
|
-
Defined in: [src/models/BaseEntity.ts:52](https://github.com/rapidrest/service-core/blob/
|
|
32
|
+
Defined in: [src/models/BaseEntity.ts:52](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L52)
|
|
33
33
|
|
|
34
34
|
#### Parameters
|
|
35
35
|
|
|
@@ -47,7 +47,7 @@ Defined in: [src/models/BaseEntity.ts:52](https://github.com/rapidrest/service-c
|
|
|
47
47
|
|
|
48
48
|
> **dateCreated**: `Date`
|
|
49
49
|
|
|
50
|
-
Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/
|
|
50
|
+
Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L35)
|
|
51
51
|
|
|
52
52
|
The date and time that the entity was created.
|
|
53
53
|
|
|
@@ -57,7 +57,7 @@ The date and time that the entity was created.
|
|
|
57
57
|
|
|
58
58
|
> **dateModified**: `Date`
|
|
59
59
|
|
|
60
|
-
Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/
|
|
60
|
+
Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L43)
|
|
61
61
|
|
|
62
62
|
The date and time that the entity was last modified.
|
|
63
63
|
|
|
@@ -67,7 +67,7 @@ The date and time that the entity was last modified.
|
|
|
67
67
|
|
|
68
68
|
> **uid**: `string`
|
|
69
69
|
|
|
70
|
-
Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/
|
|
70
|
+
Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L27)
|
|
71
71
|
|
|
72
72
|
The universally unique identifier of the entity.
|
|
73
73
|
|
|
@@ -77,6 +77,6 @@ The universally unique identifier of the entity.
|
|
|
77
77
|
|
|
78
78
|
> **version**: `number` = `0`
|
|
79
79
|
|
|
80
|
-
Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/
|
|
80
|
+
Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L50)
|
|
81
81
|
|
|
82
82
|
The optimistic lock version.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Abstract Class: BaseMongoEntity
|
|
8
8
|
|
|
9
|
-
Defined in: [src/models/BaseMongoEntity.ts:15](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/models/BaseMongoEntity.ts:15](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseMongoEntity.ts#L15)
|
|
10
10
|
|
|
11
11
|
Provides a common base class for all entity's that will be persisted in a MongoDB database.
|
|
12
12
|
|
|
@@ -24,7 +24,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
24
24
|
|
|
25
25
|
> **new BaseMongoEntity**(`other?`): `BaseMongoEntity`
|
|
26
26
|
|
|
27
|
-
Defined in: [src/models/BaseMongoEntity.ts:23](https://github.com/rapidrest/service-core/blob/
|
|
27
|
+
Defined in: [src/models/BaseMongoEntity.ts:23](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseMongoEntity.ts#L23)
|
|
28
28
|
|
|
29
29
|
#### Parameters
|
|
30
30
|
|
|
@@ -46,7 +46,7 @@ Defined in: [src/models/BaseMongoEntity.ts:23](https://github.com/rapidrest/serv
|
|
|
46
46
|
|
|
47
47
|
> `optional` **\_id?**: `any`
|
|
48
48
|
|
|
49
|
-
Defined in: [src/models/BaseMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/
|
|
49
|
+
Defined in: [src/models/BaseMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseMongoEntity.ts#L21)
|
|
50
50
|
|
|
51
51
|
The internal unique identifier used by MongoDB.
|
|
52
52
|
|
|
@@ -56,7 +56,7 @@ The internal unique identifier used by MongoDB.
|
|
|
56
56
|
|
|
57
57
|
> **dateCreated**: `Date`
|
|
58
58
|
|
|
59
|
-
Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/
|
|
59
|
+
Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L35)
|
|
60
60
|
|
|
61
61
|
The date and time that the entity was created.
|
|
62
62
|
|
|
@@ -70,7 +70,7 @@ The date and time that the entity was created.
|
|
|
70
70
|
|
|
71
71
|
> **dateModified**: `Date`
|
|
72
72
|
|
|
73
|
-
Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/
|
|
73
|
+
Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L43)
|
|
74
74
|
|
|
75
75
|
The date and time that the entity was last modified.
|
|
76
76
|
|
|
@@ -84,7 +84,7 @@ The date and time that the entity was last modified.
|
|
|
84
84
|
|
|
85
85
|
> **uid**: `string`
|
|
86
86
|
|
|
87
|
-
Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/
|
|
87
|
+
Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L27)
|
|
88
88
|
|
|
89
89
|
The universally unique identifier of the entity.
|
|
90
90
|
|
|
@@ -98,7 +98,7 @@ The universally unique identifier of the entity.
|
|
|
98
98
|
|
|
99
99
|
> **version**: `number` = `0`
|
|
100
100
|
|
|
101
|
-
Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/
|
|
101
|
+
Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/models/BaseEntity.ts#L50)
|
|
102
102
|
|
|
103
103
|
The optimistic lock version.
|
|
104
104
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: BasicStrategy
|
|
8
8
|
|
|
9
|
-
Defined in: [src/auth/BasicStrategy.ts:39](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/auth/BasicStrategy.ts:39](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L39)
|
|
10
10
|
|
|
11
11
|
## Author
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
22
22
|
|
|
23
23
|
> **new BasicStrategy**(`options?`): `BasicStrategy`
|
|
24
24
|
|
|
25
|
-
Defined in: [src/auth/BasicStrategy.ts:43](https://github.com/rapidrest/service-core/blob/
|
|
25
|
+
Defined in: [src/auth/BasicStrategy.ts:43](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L43)
|
|
26
26
|
|
|
27
27
|
#### Parameters
|
|
28
28
|
|
|
@@ -40,7 +40,7 @@ Defined in: [src/auth/BasicStrategy.ts:43](https://github.com/rapidrest/service-
|
|
|
40
40
|
|
|
41
41
|
> `readonly` **name**: `string` = `"basic"`
|
|
42
42
|
|
|
43
|
-
Defined in: [src/auth/BasicStrategy.ts:40](https://github.com/rapidrest/service-core/blob/
|
|
43
|
+
Defined in: [src/auth/BasicStrategy.ts:40](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L40)
|
|
44
44
|
|
|
45
45
|
The unique name of the strategy used to register with the `AuthMiddleware`.
|
|
46
46
|
|
|
@@ -54,7 +54,7 @@ The unique name of the strategy used to register with the `AuthMiddleware`.
|
|
|
54
54
|
|
|
55
55
|
> **authenticate**(`req`, `res`, `required?`): `Promise`\<[`AuthResult`](../interfaces/AuthResult.md) \| `undefined`\>
|
|
56
56
|
|
|
57
|
-
Defined in: [src/auth/BasicStrategy.ts:80](https://github.com/rapidrest/service-core/blob/
|
|
57
|
+
Defined in: [src/auth/BasicStrategy.ts:80](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L80)
|
|
58
58
|
|
|
59
59
|
Attempts to perform authentication with the given request data. If authentication was successful, returns an
|
|
60
60
|
`AuthResult` containing the authentication details. If authentication fails and `required` is set to `true`
|
|
@@ -94,7 +94,7 @@ Set to `true` to if authentication is required to pass, otherwise set to `false`
|
|
|
94
94
|
|
|
95
95
|
> **authenticateSync**(`req`, `res`, `required?`): [`AuthResult`](../interfaces/AuthResult.md) \| `undefined`
|
|
96
96
|
|
|
97
|
-
Defined in: [src/auth/BasicStrategy.ts:112](https://github.com/rapidrest/service-core/blob/
|
|
97
|
+
Defined in: [src/auth/BasicStrategy.ts:112](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L112)
|
|
98
98
|
|
|
99
99
|
Attempts to perform authentication with the given request data. If authentication was successful, returns an
|
|
100
100
|
`AuthResult` containing the authentication details. If authentication fails and `required` is set to `true`
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: BasicStrategyOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [src/auth/BasicStrategy.ts:13](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/auth/BasicStrategy.ts:13](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L13)
|
|
10
10
|
|
|
11
11
|
Describes the configuration options that can be used to initialize BasicStrategy.
|
|
12
12
|
|
|
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz
|
|
|
30
30
|
|
|
31
31
|
> **allowQueryParam**: `boolean` = `false`
|
|
32
32
|
|
|
33
|
-
Defined in: [src/auth/BasicStrategy.ts:25](https://github.com/rapidrest/service-core/blob/
|
|
33
|
+
Defined in: [src/auth/BasicStrategy.ts:25](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L25)
|
|
34
34
|
|
|
35
35
|
Set to `true` to allow credentials to be supplied via the `queryKey` URL parameter.
|
|
36
36
|
Disabled by default — query parameters appear in server logs, browser history, and
|
|
@@ -42,7 +42,7 @@ Referer headers, which permanently exposes credentials outside the application.
|
|
|
42
42
|
|
|
43
43
|
> **headerKey**: `string` = `"authorization"`
|
|
44
44
|
|
|
45
|
-
Defined in: [src/auth/BasicStrategy.ts:15](https://github.com/rapidrest/service-core/blob/
|
|
45
|
+
Defined in: [src/auth/BasicStrategy.ts:15](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L15)
|
|
46
46
|
|
|
47
47
|
The name of the header to look for when performing header based authentication. Default value is `Authorization`.
|
|
48
48
|
|
|
@@ -52,7 +52,7 @@ The name of the header to look for when performing header based authentication.
|
|
|
52
52
|
|
|
53
53
|
> **headerScheme**: `string` = `"basic"`
|
|
54
54
|
|
|
55
|
-
Defined in: [src/auth/BasicStrategy.ts:17](https://github.com/rapidrest/service-core/blob/
|
|
55
|
+
Defined in: [src/auth/BasicStrategy.ts:17](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L17)
|
|
56
56
|
|
|
57
57
|
The authorization scheme type when using header based authentication. Default value is `jwt`.
|
|
58
58
|
|
|
@@ -62,7 +62,7 @@ The authorization scheme type when using header based authentication. Default va
|
|
|
62
62
|
|
|
63
63
|
> **queryKey**: `string` = `"auth_basic"`
|
|
64
64
|
|
|
65
|
-
Defined in: [src/auth/BasicStrategy.ts:19](https://github.com/rapidrest/service-core/blob/
|
|
65
|
+
Defined in: [src/auth/BasicStrategy.ts:19](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L19)
|
|
66
66
|
|
|
67
67
|
The name of the request query parameter to retrieve the token from when using query based authentication. Default value is `auth_basic`.
|
|
68
68
|
|
|
@@ -72,7 +72,7 @@ The name of the request query parameter to retrieve the token from when using qu
|
|
|
72
72
|
|
|
73
73
|
> **verify**(`uid`, `secret`): `JWTUser` \| `Promise`\<`JWTUser` \| `undefined`\> \| `undefined`
|
|
74
74
|
|
|
75
|
-
Defined in: [src/auth/BasicStrategy.ts:27](https://github.com/rapidrest/service-core/blob/
|
|
75
|
+
Defined in: [src/auth/BasicStrategy.ts:27](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L27)
|
|
76
76
|
|
|
77
77
|
Override this function to handle asynchronous (non-blocking) verification of the login info.
|
|
78
78
|
|
|
@@ -96,7 +96,7 @@ Override this function to handle asynchronous (non-blocking) verification of the
|
|
|
96
96
|
|
|
97
97
|
> **verifySync**(`uid`, `secret`): `JWTUser` \| `undefined`
|
|
98
98
|
|
|
99
|
-
Defined in: [src/auth/BasicStrategy.ts:31](https://github.com/rapidrest/service-core/blob/
|
|
99
|
+
Defined in: [src/auth/BasicStrategy.ts:31](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/BasicStrategy.ts#L31)
|
|
100
100
|
|
|
101
101
|
Override this function to handle synchronous (blocking) verification of the login info.
|
|
102
102
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: BulkError
|
|
8
8
|
|
|
9
|
-
Defined in: [src/BulkError.ts:6](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/BulkError.ts:6](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BulkError.ts#L6)
|
|
10
10
|
|
|
11
11
|
An error take that takes an array of other errors.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ An error take that takes an array of other errors.
|
|
|
20
20
|
|
|
21
21
|
> **new BulkError**(`errs`, `code`, `defaultStatus`, `message?`): `BulkError`
|
|
22
22
|
|
|
23
|
-
Defined in: [src/BulkError.ts:12](https://github.com/rapidrest/service-core/blob/
|
|
23
|
+
Defined in: [src/BulkError.ts:12](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BulkError.ts#L12)
|
|
24
24
|
|
|
25
25
|
#### Parameters
|
|
26
26
|
|
|
@@ -68,7 +68,7 @@ The unique code of the error.
|
|
|
68
68
|
|
|
69
69
|
> `readonly` **errors**: (`Error` \| `null`)[] = `[]`
|
|
70
70
|
|
|
71
|
-
Defined in: [src/BulkError.ts:10](https://github.com/rapidrest/service-core/blob/
|
|
71
|
+
Defined in: [src/BulkError.ts:10](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/BulkError.ts#L10)
|
|
72
72
|
|
|
73
73
|
The list of errors that have been thrown.
|
|
74
74
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ConnectionManager
|
|
8
8
|
|
|
9
|
-
Defined in: [src/database/ConnectionManager.ts:17](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/database/ConnectionManager.ts:17](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/database/ConnectionManager.ts#L17)
|
|
10
10
|
|
|
11
11
|
Provides database connection management.
|
|
12
12
|
|
|
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz
|
|
|
30
30
|
|
|
31
31
|
> **connections**: `Map`\<`string`, `Redis` \| `DataSource` \| [`MongoConnection`](MongoConnection.md)\>
|
|
32
32
|
|
|
33
|
-
Defined in: [src/database/ConnectionManager.ts:18](https://github.com/rapidrest/service-core/blob/
|
|
33
|
+
Defined in: [src/database/ConnectionManager.ts:18](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/database/ConnectionManager.ts#L18)
|
|
34
34
|
|
|
35
35
|
## Methods
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ Defined in: [src/database/ConnectionManager.ts:18](https://github.com/rapidrest/
|
|
|
38
38
|
|
|
39
39
|
> **connect**(`datastores`, `models`): `Promise`\<`void`\>
|
|
40
40
|
|
|
41
|
-
Defined in: [src/database/ConnectionManager.ts:60](https://github.com/rapidrest/service-core/blob/
|
|
41
|
+
Defined in: [src/database/ConnectionManager.ts:60](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/database/ConnectionManager.ts#L60)
|
|
42
42
|
|
|
43
43
|
Attempts to initiate all database connections as defined in the config.
|
|
44
44
|
|
|
@@ -66,7 +66,7 @@ A map of model names and associated class definitions to establish database conn
|
|
|
66
66
|
|
|
67
67
|
> **disconnect**(): `Promise`\<`void`\>
|
|
68
68
|
|
|
69
|
-
Defined in: [src/database/ConnectionManager.ts:136](https://github.com/rapidrest/service-core/blob/
|
|
69
|
+
Defined in: [src/database/ConnectionManager.ts:136](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/database/ConnectionManager.ts#L136)
|
|
70
70
|
|
|
71
71
|
Attempts to disconnect all active database connections.
|
|
72
72
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: EventListenerManager
|
|
8
8
|
|
|
9
|
-
Defined in: [src/EventListenerManager.ts:18](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/EventListenerManager.ts:18](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/EventListenerManager.ts#L18)
|
|
10
10
|
|
|
11
11
|
The `EventListenerManager` is responsible for managing event handlers and processing of incoming
|
|
12
12
|
events from the configured redis pubsub channels. An event handler is any function that has been
|
|
@@ -25,7 +25,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
|
|
|
25
25
|
|
|
26
26
|
> **new EventListenerManager**(`objectFactory`, `redis`): `EventListenerManager`
|
|
27
27
|
|
|
28
|
-
Defined in: [src/EventListenerManager.ts:27](https://github.com/rapidrest/service-core/blob/
|
|
28
|
+
Defined in: [src/EventListenerManager.ts:27](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/EventListenerManager.ts#L27)
|
|
29
29
|
|
|
30
30
|
#### Parameters
|
|
31
31
|
|
|
@@ -47,7 +47,7 @@ Defined in: [src/EventListenerManager.ts:27](https://github.com/rapidrest/servic
|
|
|
47
47
|
|
|
48
48
|
> **destroy**(): `Promise`\<`void`\>
|
|
49
49
|
|
|
50
|
-
Defined in: [src/EventListenerManager.ts:77](https://github.com/rapidrest/service-core/blob/
|
|
50
|
+
Defined in: [src/EventListenerManager.ts:77](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/EventListenerManager.ts#L77)
|
|
51
51
|
|
|
52
52
|
#### Returns
|
|
53
53
|
|
|
@@ -59,7 +59,7 @@ Defined in: [src/EventListenerManager.ts:77](https://github.com/rapidrest/servic
|
|
|
59
59
|
|
|
60
60
|
> **init**(): `Promise`\<`void`\>
|
|
61
61
|
|
|
62
|
-
Defined in: [src/EventListenerManager.ts:33](https://github.com/rapidrest/service-core/blob/
|
|
62
|
+
Defined in: [src/EventListenerManager.ts:33](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/EventListenerManager.ts#L33)
|
|
63
63
|
|
|
64
64
|
#### Returns
|
|
65
65
|
|
|
@@ -71,7 +71,7 @@ Defined in: [src/EventListenerManager.ts:33](https://github.com/rapidrest/servic
|
|
|
71
71
|
|
|
72
72
|
> **register**(`obj`): `void`
|
|
73
73
|
|
|
74
|
-
Defined in: [src/EventListenerManager.ts:128](https://github.com/rapidrest/service-core/blob/
|
|
74
|
+
Defined in: [src/EventListenerManager.ts:128](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/EventListenerManager.ts#L128)
|
|
75
75
|
|
|
76
76
|
Registers the given object to be notified of events that arrive.
|
|
77
77
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: HttpRouter
|
|
8
8
|
|
|
9
|
-
Defined in: [src/http/Router.ts:
|
|
9
|
+
Defined in: [src/http/Router.ts:222](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L222)
|
|
10
10
|
|
|
11
11
|
Thin Express-compatible wrapper over `uWS.TemplatedApp`.
|
|
12
12
|
|
|
@@ -29,7 +29,7 @@ Also supports:
|
|
|
29
29
|
|
|
30
30
|
> **new HttpRouter**(`uwsApp`): `HttpRouter`
|
|
31
31
|
|
|
32
|
-
Defined in: [src/http/Router.ts:
|
|
32
|
+
Defined in: [src/http/Router.ts:234](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L234)
|
|
33
33
|
|
|
34
34
|
#### Parameters
|
|
35
35
|
|
|
@@ -47,7 +47,7 @@ Defined in: [src/http/Router.ts:226](https://github.com/rapidrest/service-core/b
|
|
|
47
47
|
|
|
48
48
|
> **listenPort**: `number` = `0`
|
|
49
49
|
|
|
50
|
-
Defined in: [src/http/Router.ts:
|
|
50
|
+
Defined in: [src/http/Router.ts:232](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L232)
|
|
51
51
|
|
|
52
52
|
The port the server is currently listening on (set after a successful `listen()` call).
|
|
53
53
|
|
|
@@ -59,7 +59,7 @@ The port the server is currently listening on (set after a successful `listen()`
|
|
|
59
59
|
|
|
60
60
|
> **get** **isListening**(): `boolean`
|
|
61
61
|
|
|
62
|
-
Defined in: [src/http/Router.ts:
|
|
62
|
+
Defined in: [src/http/Router.ts:239](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L239)
|
|
63
63
|
|
|
64
64
|
Returns `true` if the server is currently listening.
|
|
65
65
|
|
|
@@ -73,7 +73,7 @@ Returns `true` if the server is currently listening.
|
|
|
73
73
|
|
|
74
74
|
> **close**(): `void`
|
|
75
75
|
|
|
76
|
-
Defined in: [src/http/Router.ts:
|
|
76
|
+
Defined in: [src/http/Router.ts:479](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L479)
|
|
77
77
|
|
|
78
78
|
Closes the listen socket, stopping the server from accepting new connections.
|
|
79
79
|
|
|
@@ -87,7 +87,7 @@ Closes the listen socket, stopping the server from accepting new connections.
|
|
|
87
87
|
|
|
88
88
|
> **delete**(`routePath`, ...`handlers`): `this`
|
|
89
89
|
|
|
90
|
-
Defined in: [src/http/Router.ts:
|
|
90
|
+
Defined in: [src/http/Router.ts:283](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L283)
|
|
91
91
|
|
|
92
92
|
#### Parameters
|
|
93
93
|
|
|
@@ -109,7 +109,7 @@ Defined in: [src/http/Router.ts:275](https://github.com/rapidrest/service-core/b
|
|
|
109
109
|
|
|
110
110
|
> **get**(`routePath`, ...`handlers`): `this`
|
|
111
111
|
|
|
112
|
-
Defined in: [src/http/Router.ts:
|
|
112
|
+
Defined in: [src/http/Router.ts:265](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L265)
|
|
113
113
|
|
|
114
114
|
#### Parameters
|
|
115
115
|
|
|
@@ -131,7 +131,7 @@ Defined in: [src/http/Router.ts:257](https://github.com/rapidrest/service-core/b
|
|
|
131
131
|
|
|
132
132
|
> **head**(`routePath`, ...`handlers`): `this`
|
|
133
133
|
|
|
134
|
-
Defined in: [src/http/Router.ts:
|
|
134
|
+
Defined in: [src/http/Router.ts:295](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L295)
|
|
135
135
|
|
|
136
136
|
#### Parameters
|
|
137
137
|
|
|
@@ -153,7 +153,7 @@ Defined in: [src/http/Router.ts:287](https://github.com/rapidrest/service-core/b
|
|
|
153
153
|
|
|
154
154
|
> **listen**(`host`, `port`): `Promise`\<`void`\>
|
|
155
155
|
|
|
156
|
-
Defined in: [src/http/Router.ts:
|
|
156
|
+
Defined in: [src/http/Router.ts:458](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L458)
|
|
157
157
|
|
|
158
158
|
Starts listening on the given host and port.
|
|
159
159
|
Resolves when the server is ready; rejects if the port cannot be bound.
|
|
@@ -178,7 +178,7 @@ Resolves when the server is ready; rejects if the port cannot be bound.
|
|
|
178
178
|
|
|
179
179
|
> **options**(`routePath`, ...`handlers`): `this`
|
|
180
180
|
|
|
181
|
-
Defined in: [src/http/Router.ts:
|
|
181
|
+
Defined in: [src/http/Router.ts:302](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L302)
|
|
182
182
|
|
|
183
183
|
#### Parameters
|
|
184
184
|
|
|
@@ -200,7 +200,7 @@ Defined in: [src/http/Router.ts:294](https://github.com/rapidrest/service-core/b
|
|
|
200
200
|
|
|
201
201
|
> **patch**(`routePath`, ...`handlers`): `this`
|
|
202
202
|
|
|
203
|
-
Defined in: [src/http/Router.ts:
|
|
203
|
+
Defined in: [src/http/Router.ts:289](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L289)
|
|
204
204
|
|
|
205
205
|
#### Parameters
|
|
206
206
|
|
|
@@ -222,7 +222,7 @@ Defined in: [src/http/Router.ts:281](https://github.com/rapidrest/service-core/b
|
|
|
222
222
|
|
|
223
223
|
> **post**(`routePath`, ...`handlers`): `this`
|
|
224
224
|
|
|
225
|
-
Defined in: [src/http/Router.ts:
|
|
225
|
+
Defined in: [src/http/Router.ts:271](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L271)
|
|
226
226
|
|
|
227
227
|
#### Parameters
|
|
228
228
|
|
|
@@ -244,7 +244,7 @@ Defined in: [src/http/Router.ts:263](https://github.com/rapidrest/service-core/b
|
|
|
244
244
|
|
|
245
245
|
> **put**(`routePath`, ...`handlers`): `this`
|
|
246
246
|
|
|
247
|
-
Defined in: [src/http/Router.ts:
|
|
247
|
+
Defined in: [src/http/Router.ts:277](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L277)
|
|
248
248
|
|
|
249
249
|
#### Parameters
|
|
250
250
|
|
|
@@ -266,7 +266,7 @@ Defined in: [src/http/Router.ts:269](https://github.com/rapidrest/service-core/b
|
|
|
266
266
|
|
|
267
267
|
> **static**(`basePath`): `this`
|
|
268
268
|
|
|
269
|
-
Defined in: [src/http/Router.ts:
|
|
269
|
+
Defined in: [src/http/Router.ts:428](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L428)
|
|
270
270
|
|
|
271
271
|
Serves static files from a directory via a wildcard GET route.
|
|
272
272
|
Files not found on disk return 404.
|
|
@@ -287,7 +287,7 @@ Files not found on disk return 404.
|
|
|
287
287
|
|
|
288
288
|
> **use**(...`handlers`): `this`
|
|
289
289
|
|
|
290
|
-
Defined in: [src/http/Router.ts:
|
|
290
|
+
Defined in: [src/http/Router.ts:244](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L244)
|
|
291
291
|
|
|
292
292
|
Register global middleware that runs before every route handler.
|
|
293
293
|
|
|
@@ -307,7 +307,7 @@ Register global middleware that runs before every route handler.
|
|
|
307
307
|
|
|
308
308
|
> **ws**(`routePath`, `handlers`, `wsOptions?`, `upgradeAuth?`): `this`
|
|
309
309
|
|
|
310
|
-
Defined in: [src/http/Router.ts:
|
|
310
|
+
Defined in: [src/http/Router.ts:320](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/http/Router.ts#L320)
|
|
311
311
|
|
|
312
312
|
Registers a WebSocket route. Handlers follow the same `(req, res, next)` pattern
|
|
313
313
|
as HTTP routes; they receive `req.websocket` containing the uWS WebSocket handle.
|
|
@@ -6,15 +6,15 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: JWTStrategy
|
|
8
8
|
|
|
9
|
-
Defined in: [src/auth/JWTStrategy.ts:63](https://github.com/rapidrest/service-core/blob/
|
|
9
|
+
Defined in: [src/auth/JWTStrategy.ts:63](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/JWTStrategy.ts#L63)
|
|
10
10
|
|
|
11
|
-
JWT authentication strategy. Performs JWT verification and searches for a token by one of the
|
|
12
|
-
following methods (in order of precedence):
|
|
13
|
-
* Query Parameter
|
|
14
|
-
* Authorization Header
|
|
11
|
+
JWT authentication strategy. Performs JWT verification and searches for a token by one of the
|
|
12
|
+
following methods (in order of precedence):
|
|
13
|
+
* Query Parameter
|
|
14
|
+
* Authorization Header
|
|
15
15
|
* Cookie
|
|
16
16
|
|
|
17
|
-
This class no longer extends `passport-strategy`; it is used directly by route middleware
|
|
17
|
+
This class no longer extends `passport-strategy`; it is used directly by route middleware
|
|
18
18
|
and returns a plain result object instead of calling Passport callbacks.
|
|
19
19
|
|
|
20
20
|
## Author
|
|
@@ -27,7 +27,7 @@ Jean-Philippe Steinmetz
|
|
|
27
27
|
|
|
28
28
|
> **new JWTStrategy**(`options?`): `JWTStrategy`
|
|
29
29
|
|
|
30
|
-
Defined in: [src/auth/JWTStrategy.ts:
|
|
30
|
+
Defined in: [src/auth/JWTStrategy.ts:72](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/JWTStrategy.ts#L72)
|
|
31
31
|
|
|
32
32
|
#### Parameters
|
|
33
33
|
|
|
@@ -45,7 +45,7 @@ Defined in: [src/auth/JWTStrategy.ts:71](https://github.com/rapidrest/service-co
|
|
|
45
45
|
|
|
46
46
|
> `readonly` **name**: `string` = `"jwt"`
|
|
47
47
|
|
|
48
|
-
Defined in: [src/auth/JWTStrategy.ts:67](https://github.com/rapidrest/service-core/blob/
|
|
48
|
+
Defined in: [src/auth/JWTStrategy.ts:67](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/JWTStrategy.ts#L67)
|
|
49
49
|
|
|
50
50
|
## Methods
|
|
51
51
|
|
|
@@ -53,7 +53,7 @@ Defined in: [src/auth/JWTStrategy.ts:67](https://github.com/rapidrest/service-co
|
|
|
53
53
|
|
|
54
54
|
> **authenticate**(`req`, `res`, `required?`): `Promise`\<[`JWTAuthResult`](../interfaces/JWTAuthResult.md) \| `undefined`\>
|
|
55
55
|
|
|
56
|
-
Defined in: [src/auth/JWTStrategy.ts:
|
|
56
|
+
Defined in: [src/auth/JWTStrategy.ts:136](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/JWTStrategy.ts#L136)
|
|
57
57
|
|
|
58
58
|
#### Parameters
|
|
59
59
|
|
|
@@ -79,7 +79,7 @@ Defined in: [src/auth/JWTStrategy.ts:134](https://github.com/rapidrest/service-c
|
|
|
79
79
|
|
|
80
80
|
> **authenticateSync**(`req`, `res`, `required?`): [`JWTAuthResult`](../interfaces/JWTAuthResult.md) \| `undefined`
|
|
81
81
|
|
|
82
|
-
Defined in: [src/auth/JWTStrategy.ts:
|
|
82
|
+
Defined in: [src/auth/JWTStrategy.ts:171](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/auth/JWTStrategy.ts#L171)
|
|
83
83
|
|
|
84
84
|
#### Parameters
|
|
85
85
|
|