@loopback/docs 5.1.3 → 5.1.5

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.
Files changed (249) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/package.json +4 -4
  3. package/site/apidocs/apiconnect.apiconnectspecoptions.md +1 -1
  4. package/site/apidocs/authentication-jwt.credentials.md +1 -1
  5. package/site/apidocs/authentication-jwt.refereshtokenwithrelations.md +1 -1
  6. package/site/apidocs/authentication-jwt.securityschemeobjects.md +1 -1
  7. package/site/apidocs/authentication-jwt.tokenobject.md +1 -1
  8. package/site/apidocs/authentication-jwt.usercredentialswithrelations.md +1 -1
  9. package/site/apidocs/authentication-jwt.userwithrelations.md +1 -1
  10. package/site/apidocs/authorization.authorizer.md +1 -1
  11. package/site/apidocs/boot.artifactoptions.md +1 -1
  12. package/site/apidocs/boot.bootexecutionoptions.md +1 -1
  13. package/site/apidocs/boot.bootoptions.md +1 -1
  14. package/site/apidocs/context-explorer.bindingnodefilter.md +1 -1
  15. package/site/apidocs/context-explorer.contextexplorerconfig.md +1 -1
  16. package/site/apidocs/context-explorer.contextgraphoptions.md +1 -1
  17. package/site/apidocs/context.aliasbindingsource.md +1 -1
  18. package/site/apidocs/context.asinterceptedfunction.md +1 -1
  19. package/site/apidocs/context.asvalueorpromise.md +1 -1
  20. package/site/apidocs/context.asyncproxy.md +1 -1
  21. package/site/apidocs/context.bindingaddress.md +1 -1
  22. package/site/apidocs/context.bindingevent.md +1 -1
  23. package/site/apidocs/context.bindingeventlistener.md +1 -1
  24. package/site/apidocs/context.bindingfromclassoptions.md +1 -1
  25. package/site/apidocs/context.bindingmetadata.md +1 -1
  26. package/site/apidocs/context.bindingscopeandtags.md +1 -1
  27. package/site/apidocs/context.bindingselector.md +1 -1
  28. package/site/apidocs/context.bindingsource.md +1 -1
  29. package/site/apidocs/context.bindingspec.md +1 -1
  30. package/site/apidocs/context.bindingtag.md +1 -1
  31. package/site/apidocs/context.bindingtemplate.md +1 -1
  32. package/site/apidocs/context.boundvalue.md +1 -1
  33. package/site/apidocs/context.classbindingsource.md +1 -1
  34. package/site/apidocs/context.constantbindingsource.md +1 -1
  35. package/site/apidocs/context.constructor.md +1 -1
  36. package/site/apidocs/context.contextevent.md +1 -1
  37. package/site/apidocs/context.contexteventlistener.md +1 -1
  38. package/site/apidocs/context.contexteventobserver.md +1 -1
  39. package/site/apidocs/context.contexteventtype.md +1 -1
  40. package/site/apidocs/context.contextobserverfn.md +1 -1
  41. package/site/apidocs/context.dynamicvaluebindingsource.md +1 -1
  42. package/site/apidocs/context.genericinterceptor.md +1 -1
  43. package/site/apidocs/context.genericinterceptororkey.md +1 -1
  44. package/site/apidocs/context.getter.md +1 -1
  45. package/site/apidocs/context.interceptororkey.md +1 -1
  46. package/site/apidocs/context.invocationargs.md +1 -1
  47. package/site/apidocs/context.invocationoptions.md +1 -1
  48. package/site/apidocs/context.invocationresult.md +1 -1
  49. package/site/apidocs/context.jsonprimitive.md +1 -1
  50. package/site/apidocs/context.jsonvalue.md +1 -1
  51. package/site/apidocs/context.mapobject.md +1 -1
  52. package/site/apidocs/context.next.md +1 -1
  53. package/site/apidocs/context.nonvoid.md +1 -1
  54. package/site/apidocs/context.providerbindingsource.md +1 -1
  55. package/site/apidocs/context.resolutionaction.md +1 -1
  56. package/site/apidocs/context.resolutionelement.md +1 -1
  57. package/site/apidocs/context.resolutionoptionsorsession.md +1 -1
  58. package/site/apidocs/context.setter.md +1 -1
  59. package/site/apidocs/context.tagmap.md +1 -1
  60. package/site/apidocs/context.typenamespacemapping.md +1 -1
  61. package/site/apidocs/context.valuefactory.md +1 -1
  62. package/site/apidocs/context.valueorpromise.md +1 -1
  63. package/site/apidocs/core.controllerclass.md +1 -1
  64. package/site/apidocs/core.lifecycleobservergroup.md +1 -1
  65. package/site/apidocs/core.lifecycleobserveroptions.md +1 -1
  66. package/site/apidocs/core.mixintarget.md +1 -1
  67. package/site/apidocs/core.serviceinterface.md +1 -1
  68. package/site/apidocs/core.serviceorproviderclass.md +1 -1
  69. package/site/apidocs/core.shutdownoptions.md +1 -1
  70. package/site/apidocs/cron.cronjobconfig.md +1 -1
  71. package/site/apidocs/cron.cronjoboptions.md +1 -1
  72. package/site/apidocs/express.expressrequesthandler.md +1 -1
  73. package/site/apidocs/express.expressserverconfig.md +1 -1
  74. package/site/apidocs/express.middlewareorkey.md +1 -1
  75. package/site/apidocs/filter.condition.md +1 -1
  76. package/site/apidocs/filter.direction.md +1 -1
  77. package/site/apidocs/filter.fields.md +1 -1
  78. package/site/apidocs/filter.filterexcludingwhere.md +1 -1
  79. package/site/apidocs/filter.inclusionfilter.md +1 -1
  80. package/site/apidocs/filter.keyof.md +1 -1
  81. package/site/apidocs/filter.operators.md +1 -1
  82. package/site/apidocs/filter.order.md +1 -1
  83. package/site/apidocs/filter.predicatecomparison.md +1 -1
  84. package/site/apidocs/filter.shorthandequaltype.md +1 -1
  85. package/site/apidocs/filter.where.md +1 -1
  86. package/site/apidocs/graphql.graphqlserver.exportgraphqlschema.md +5 -2
  87. package/site/apidocs/health.healthconfig.md +1 -1
  88. package/site/apidocs/health.healthoptions.md +1 -1
  89. package/site/apidocs/health.livecheck.md +1 -1
  90. package/site/apidocs/health.readycheck.md +1 -1
  91. package/site/apidocs/http-server.httpprotocol.md +1 -1
  92. package/site/apidocs/http-server.httpserveroptions.md +1 -1
  93. package/site/apidocs/http-server.httpserverproperties.md +1 -1
  94. package/site/apidocs/http-server.requestlistener.md +1 -1
  95. package/site/apidocs/logging.loggingcomponentconfig.md +1 -1
  96. package/site/apidocs/metadata.decoratortype.md +1 -1
  97. package/site/apidocs/metadata.metadatakey.md +1 -1
  98. package/site/apidocs/metrics.metricsconfig.md +1 -1
  99. package/site/apidocs/model-api-builder.modelapiconfig.md +1 -1
  100. package/site/apidocs/openapi-v3.openapispec.md +1 -1
  101. package/site/apidocs/openapi-v3.responsedecoratormetadata.md +1 -1
  102. package/site/apidocs/openapi-v3.responsemodelorspec.md +1 -1
  103. package/site/apidocs/openapi-v3.schemaref.md +1 -1
  104. package/site/apidocs/repository-json-schema.optional.md +1 -1
  105. package/site/apidocs/repository-tests.crudrepositoryctor.md +1 -1
  106. package/site/apidocs/repository-tests.datasourceoptions.md +1 -1
  107. package/site/apidocs/repository-tests.transactionalrepositoryctor.md +1 -1
  108. package/site/apidocs/repository.callback.md +1 -1
  109. package/site/apidocs/repository.command.md +1 -1
  110. package/site/apidocs/repository.constructor.md +1 -1
  111. package/site/apidocs/repository.dataobject.md +1 -1
  112. package/site/apidocs/repository.deeppartial.md +1 -1
  113. package/site/apidocs/repository.defaultcrudrepository.entitytodata.md +2 -2
  114. package/site/apidocs/repository.dynamicmodelctor.md +1 -1
  115. package/site/apidocs/repository.entitydata.md +1 -1
  116. package/site/apidocs/repository.entityresolver.md +1 -1
  117. package/site/apidocs/repository.hasmanythroughrepositoryfactory.md +1 -1
  118. package/site/apidocs/repository.inclusionresolver.md +1 -1
  119. package/site/apidocs/repository.keyvaluefilter.md +1 -1
  120. package/site/apidocs/repository.md +1 -0
  121. package/site/apidocs/repository.namedparameters.md +1 -1
  122. package/site/apidocs/repository.nonfunction.md +21 -0
  123. package/site/apidocs/repository.options.md +1 -1
  124. package/site/apidocs/repository.positionalparameters.md +1 -1
  125. package/site/apidocs/repository.propertymap.md +1 -1
  126. package/site/apidocs/repository.propertytype.md +1 -1
  127. package/site/apidocs/repository.prototypeof.md +1 -1
  128. package/site/apidocs/repository.relationdefinitionmap.md +1 -1
  129. package/site/apidocs/repository.relationmetadata.md +1 -1
  130. package/site/apidocs/repository.repositorydecorator.md +1 -1
  131. package/site/apidocs/repository.resolvetype.md +2 -2
  132. package/site/apidocs/repository.resolvetype_1.md +2 -2
  133. package/site/apidocs/repository.stringkeyof.md +1 -1
  134. package/site/apidocs/repository.transactionalentityrepository.md +1 -1
  135. package/site/apidocs/repository.typeresolver.md +1 -1
  136. package/site/apidocs/rest-explorer.restexplorerconfig.md +1 -1
  137. package/site/apidocs/rest.ajverroroptions.md +1 -1
  138. package/site/apidocs/rest.ajvfactory.md +1 -1
  139. package/site/apidocs/rest.ajvformat.md +1 -1
  140. package/site/apidocs/rest.ajvkeyword.md +1 -1
  141. package/site/apidocs/rest.bodyparserfunction.md +1 -1
  142. package/site/apidocs/rest.bodyparsermiddleware.md +1 -1
  143. package/site/apidocs/rest.controllerclass.md +1 -1
  144. package/site/apidocs/rest.controllerfactory.md +1 -1
  145. package/site/apidocs/rest.controllerinstance.md +1 -1
  146. package/site/apidocs/rest.findroute.md +1 -1
  147. package/site/apidocs/rest.httprequestlistener.md +1 -1
  148. package/site/apidocs/rest.invokemethod.md +1 -1
  149. package/site/apidocs/rest.logerror.md +1 -1
  150. package/site/apidocs/rest.nodewithvalue.md +1 -1
  151. package/site/apidocs/rest.operationargs.md +1 -1
  152. package/site/apidocs/rest.operationretval.md +1 -1
  153. package/site/apidocs/rest.parseparams.md +1 -1
  154. package/site/apidocs/rest.pathparametervalues.md +1 -1
  155. package/site/apidocs/rest.reject.md +1 -1
  156. package/site/apidocs/rest.requestbody.md +1 -1
  157. package/site/apidocs/rest.requestbodyvalidationoptions.md +1 -1
  158. package/site/apidocs/rest.restcomponentconfig.md +1 -1
  159. package/site/apidocs/rest.restrouteroptions.md +1 -1
  160. package/site/apidocs/rest.restserverconfig.md +1 -1
  161. package/site/apidocs/rest.restserveroptions.md +1 -1
  162. package/site/apidocs/rest.restserverresolvedconfig.md +1 -1
  163. package/site/apidocs/rest.routerspec.md +1 -1
  164. package/site/apidocs/rest.schemavalidatorcache.md +1 -1
  165. package/site/apidocs/rest.send.md +1 -1
  166. package/site/apidocs/rest.sequencefunction.md +1 -1
  167. package/site/apidocs/service-proxy.serviceproxydecorator.md +1 -1
  168. package/site/apidocs/socketio.socketiodonefunction.md +1 -1
  169. package/site/apidocs/socketio.socketioinvokemethod.md +1 -1
  170. package/site/apidocs/socketio.socketiooptions.md +1 -1
  171. package/site/apidocs/socketio.socketiorejectmethod.md +1 -1
  172. package/site/apidocs/socketio.socketiosendmethod.md +1 -1
  173. package/site/apidocs/socketio.sockiomiddleware.md +1 -1
  174. package/site/apidocs/testlab.client.md +1 -1
  175. package/site/apidocs/testlab.observedresponse.md +1 -1
  176. package/site/apidocs/testlab.shotcallback.md +1 -1
  177. package/site/apidocs/testlab.shotresponsector.md +1 -1
  178. package/site/apidocs/testlab.stubbedinstancewithsinonaccessor.md +1 -1
  179. package/site/apidocs/testlab.testdefinition.md +1 -1
  180. package/site/apidocs/typeorm.propertytype.md +1 -1
  181. package/site/apidocs/typeorm.stringifiedtypeoptions.md +1 -1
  182. package/site/apidocs/typeorm.typeormcomponentoptions.md +1 -1
  183. package/site/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +37 -107
  184. package/site/changelogs/examples/access-control-migration/CHANGELOG.md +35 -216
  185. package/site/changelogs/examples/binding-resolution/CHANGELOG.md +46 -109
  186. package/site/changelogs/examples/context/CHANGELOG.md +35 -322
  187. package/site/changelogs/examples/express-composition/CHANGELOG.md +53 -428
  188. package/site/changelogs/examples/file-transfer/CHANGELOG.md +31 -205
  189. package/site/changelogs/examples/graphql/CHANGELOG.md +49 -119
  190. package/site/changelogs/examples/greeter-extension/CHANGELOG.md +34 -366
  191. package/site/changelogs/examples/greeting-app/CHANGELOG.md +31 -324
  192. package/site/changelogs/examples/hello-world/CHANGELOG.md +129 -696
  193. package/site/changelogs/examples/lb3-application/CHANGELOG.md +46 -356
  194. package/site/changelogs/examples/log-extension/CHANGELOG.md +133 -709
  195. package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +29 -236
  196. package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +33 -190
  197. package/site/changelogs/examples/passport-login/CHANGELOG.md +39 -209
  198. package/site/changelogs/examples/references-many/CHANGELOG.md +9 -14
  199. package/site/changelogs/examples/rest-crud/CHANGELOG.md +31 -205
  200. package/site/changelogs/examples/rpc-server/CHANGELOG.md +132 -666
  201. package/site/changelogs/examples/soap-calculator/CHANGELOG.md +219 -697
  202. package/site/changelogs/examples/socketio/CHANGELOG.md +19 -97
  203. package/site/changelogs/examples/todo/CHANGELOG.md +247 -893
  204. package/site/changelogs/examples/todo-jwt/CHANGELOG.md +29 -159
  205. package/site/changelogs/examples/todo-list/CHANGELOG.md +145 -652
  206. package/site/changelogs/examples/validation-app/CHANGELOG.md +31 -204
  207. package/site/changelogs/examples/webpack/CHANGELOG.md +51 -114
  208. package/site/changelogs/extensions/apiconnect/CHANGELOG.md +49 -198
  209. package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +76 -205
  210. package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +78 -270
  211. package/site/changelogs/extensions/context-explorer/CHANGELOG.md +49 -181
  212. package/site/changelogs/extensions/cron/CHANGELOG.md +47 -193
  213. package/site/changelogs/extensions/graphql/CHANGELOG.md +51 -121
  214. package/site/changelogs/extensions/health/CHANGELOG.md +70 -289
  215. package/site/changelogs/extensions/logging/CHANGELOG.md +79 -224
  216. package/site/changelogs/extensions/metrics/CHANGELOG.md +89 -261
  217. package/site/changelogs/extensions/pooling/CHANGELOG.md +48 -138
  218. package/site/changelogs/extensions/socketio/CHANGELOG.md +42 -101
  219. package/site/changelogs/extensions/typeorm/CHANGELOG.md +46 -139
  220. package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +42 -156
  221. package/site/changelogs/packages/authentication/CHANGELOG.md +321 -876
  222. package/site/changelogs/packages/authorization/CHANGELOG.md +77 -296
  223. package/site/changelogs/packages/boot/CHANGELOG.md +259 -758
  224. package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +73 -362
  225. package/site/changelogs/packages/build/CHANGELOG.md +310 -702
  226. package/site/changelogs/packages/cli/CHANGELOG.md +1189 -1601
  227. package/site/changelogs/packages/context/CHANGELOG.md +508 -905
  228. package/site/changelogs/packages/core/CHANGELOG.md +262 -744
  229. package/site/changelogs/packages/eslint-config/CHANGELOG.md +159 -372
  230. package/site/changelogs/packages/express/CHANGELOG.md +85 -197
  231. package/site/changelogs/packages/filter/CHANGELOG.md +51 -118
  232. package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +90 -479
  233. package/site/changelogs/packages/http-server/CHANGELOG.md +199 -620
  234. package/site/changelogs/packages/metadata/CHANGELOG.md +194 -642
  235. package/site/changelogs/packages/model-api-builder/CHANGELOG.md +48 -219
  236. package/site/changelogs/packages/monorepo/CHANGELOG.md +42 -94
  237. package/site/changelogs/packages/openapi-spec-builder/CHANGELOG.md +193 -660
  238. package/site/changelogs/packages/openapi-v3/CHANGELOG.md +331 -805
  239. package/site/changelogs/packages/repository/CHANGELOG.md +602 -1039
  240. package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +315 -808
  241. package/site/changelogs/packages/repository-tests/CHANGELOG.md +107 -340
  242. package/site/changelogs/packages/rest/CHANGELOG.md +694 -1155
  243. package/site/changelogs/packages/rest-crud/CHANGELOG.md +76 -279
  244. package/site/changelogs/packages/rest-explorer/CHANGELOG.md +73 -433
  245. package/site/changelogs/packages/security/CHANGELOG.md +51 -259
  246. package/site/changelogs/packages/service-proxy/CHANGELOG.md +172 -607
  247. package/site/changelogs/packages/testlab/CHANGELOG.md +224 -672
  248. package/site/changelogs/packages/tsdocs/CHANGELOG.md +76 -330
  249. package/site/express-with-lb4-rest-tutorial.md +1 -1
@@ -18,7 +18,7 @@ Named parameters, such as `{x: 1, y: 'a'}`
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type NamedParameters = AnyObject;
21
+ export type NamedParameters = AnyObject;
22
22
  ```
23
23
  <b>References:</b> [AnyObject](./repository.anyobject.md)
24
24
 
@@ -0,0 +1,21 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: repository.nonfunction'
4
+ keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
5
+ sidebar: lb4_sidebar
6
+ editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
7
+ permalink: /doc/en/lb4/apidocs.repository.nonfunction.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [NonFunction](./repository.nonfunction.md)
13
+
14
+ ## NonFunction type
15
+
16
+ <b>Signature:</b>
17
+
18
+ ```typescript
19
+ export type NonFunction<T> = T extends Function ? never : T;
20
+ ```
21
+
@@ -18,7 +18,7 @@ Type alias for Node.js options object
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type Options = AnyObject;
21
+ export type Options = AnyObject;
22
22
  ```
23
23
  <b>References:</b> [AnyObject](./repository.anyobject.md)
24
24
 
@@ -18,6 +18,6 @@ Positional parameters, such as \[1, 'a'\]
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type PositionalParameters = any[];
21
+ export type PositionalParameters = any[];
22
22
  ```
23
23
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.repository.propertymap.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type PropertyMap = MetadataMap<Partial<PropertyDefinition>>;
19
+ export type PropertyMap = MetadataMap<Partial<PropertyDefinition>>;
20
20
  ```
21
21
  <b>References:</b> [MetadataMap](./metadata.metadatamap.md)<!-- -->, [PropertyDefinition](./repository.propertydefinition.md)
22
22
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.repository.propertytype.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type PropertyType = string | Function | object | Type<any> | TypeResolver<Model>;
19
+ export type PropertyType = string | Function | object | Type<any> | TypeResolver<Model>;
20
20
  ```
21
21
  <b>References:</b> [Type](./repository.type.md)<!-- -->, [TypeResolver](./repository.typeresolver.md)<!-- -->, [Model](./repository.model.md)
22
22
 
@@ -20,7 +20,7 @@ Example: `PrototypeOf<typeof Entity>` is resolved to `Entity`<!-- -->.
20
20
  <b>Signature:</b>
21
21
 
22
22
  ```typescript
23
- export declare type PrototypeOf<Ctor extends Function> = Ctor extends {
23
+ export type PrototypeOf<Ctor extends Function> = Ctor extends {
24
24
  prototype: infer Proto;
25
25
  } ? Proto : never;
26
26
  ```
@@ -18,7 +18,7 @@ A key-value map describing model relations. A relation name is used as the key,
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type RelationDefinitionMap = {
21
+ export type RelationDefinitionMap = {
22
22
  [relationName: string]: RelationMetadata;
23
23
  };
24
24
  ```
@@ -18,7 +18,7 @@ A union type describing all possible Relation metadata objects.
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type RelationMetadata = HasManyDefinition | BelongsToDefinition | HasOneDefinition | ReferencesManyDefinition | RelationDefinitionBase;
21
+ export type RelationMetadata = HasManyDefinition | BelongsToDefinition | HasOneDefinition | ReferencesManyDefinition | RelationDefinitionBase;
22
22
  ```
23
23
  <b>References:</b> [HasManyDefinition](./repository.hasmanydefinition.md)<!-- -->, [BelongsToDefinition](./repository.belongstodefinition.md)<!-- -->, [HasOneDefinition](./repository.hasonedefinition.md)<!-- -->, [ReferencesManyDefinition](./repository.referencesmanydefinition.md)<!-- -->, [RelationDefinitionBase](./repository.relationdefinitionbase.md)
24
24
 
@@ -18,6 +18,6 @@ Type definition for decorators returned by `@repository` decorator factory
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type RepositoryDecorator = (target: Object, key?: string, descriptorOrIndex?: TypedPropertyDescriptor<any> | number) => void;
21
+ export type RepositoryDecorator = (target: Object, key?: string, descriptorOrIndex?: TypedPropertyDescriptor<any> | number) => void;
22
22
  ```
23
23
 
@@ -18,14 +18,14 @@ Resolve a type value that may have been provided via TypeResolver.
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare function resolveType<T extends object>(fn: TypeResolver<T> | Class<T>): Class<T>;
21
+ export declare function resolveType<T extends object>(fn: TypeResolver<T, {}> | Class<T> | Function): Class<T>;
22
22
  ```
23
23
 
24
24
  ## Parameters
25
25
 
26
26
  | Parameter | Type | Description |
27
27
  | --- | --- | --- |
28
- | fn | [TypeResolver](./repository.typeresolver.md)<!-- -->&lt;T&gt; \| [Class](./repository.class.md)<!-- -->&lt;T&gt; | A type class or a type provider. |
28
+ | fn | [TypeResolver](./repository.typeresolver.md)<!-- -->&lt;T, {}&gt; \| [Class](./repository.class.md)<!-- -->&lt;T&gt; \| Function | A type class or a type provider. |
29
29
 
30
30
  <b>Returns:</b>
31
31
 
@@ -16,14 +16,14 @@ permalink: /doc/en/lb4/apidocs.repository.resolvetype_1.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare function resolveType<T>(fn: T): T;
19
+ export declare function resolveType<T>(fn: NonFunction<T>): T;
20
20
  ```
21
21
 
22
22
  ## Parameters
23
23
 
24
24
  | Parameter | Type | Description |
25
25
  | --- | --- | --- |
26
- | fn | T | |
26
+ | fn | [NonFunction](./repository.nonfunction.md)<!-- -->&lt;T&gt; | |
27
27
 
28
28
  <b>Returns:</b>
29
29
 
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.repository.stringkeyof.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type StringKeyOf<T> = Extract<keyof T, string>;
19
+ export type StringKeyOf<T> = Extract<keyof T, string>;
20
20
  ```
21
21
 
@@ -18,7 +18,7 @@ A type for CRUD repositories that are backed by IDs and support Transactions
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type TransactionalEntityRepository<T extends Entity, ID, Relations extends object = {}> = TransactionalRepository<T> & EntityCrudRepository<T, ID>;
21
+ export type TransactionalEntityRepository<T extends Entity, ID, Relations extends object = {}> = TransactionalRepository<T> & EntityCrudRepository<T, ID>;
22
22
  ```
23
23
  <b>References:</b> [Entity](./repository.entity.md)<!-- -->, [TransactionalRepository](./repository.transactionalrepository.md)<!-- -->, [EntityCrudRepository](./repository.entitycrudrepository.md)
24
24
 
@@ -20,7 +20,7 @@ We use type resolvers to break require() loops when defining relations. The targ
20
20
  <b>Signature:</b>
21
21
 
22
22
  ```typescript
23
- export declare type TypeResolver<Type extends Object, StaticMembers = Function> = () => Class<Type> & StaticMembers;
23
+ export type TypeResolver<Type extends Object, StaticMembers = Function> = () => Class<Type> & StaticMembers;
24
24
  ```
25
25
  <b>References:</b> [Class](./repository.class.md)
26
26
 
@@ -18,7 +18,7 @@ Options to configure API Explorer UI
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type RestExplorerConfig = {
21
+ export type RestExplorerConfig = {
22
22
  path?: string;
23
23
  useSelfHostedSpec?: false;
24
24
  swaggerThemeFile?: string;
@@ -18,6 +18,6 @@ Options for AJV errors
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type AjvErrorOptions = ErrorMessageOptions;
21
+ export type AjvErrorOptions = ErrorMessageOptions;
22
22
  ```
23
23
 
@@ -18,6 +18,6 @@ Factory function for Ajv instances
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type AjvFactory = (options?: AjvOptions) => Ajv;
21
+ export type AjvFactory = (options?: AjvOptions) => Ajv;
22
22
  ```
23
23
 
@@ -18,7 +18,7 @@ Ajv format definition with a name
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type AjvFormat<T extends string | number = string> = FormatDefinition<T> & {
21
+ export type AjvFormat<T extends string | number = string> = FormatDefinition<T> & {
22
22
  name: string;
23
23
  };
24
24
  ```
@@ -18,6 +18,6 @@ Ajv keyword definition with a name
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type AjvKeyword = KeywordDefinition;
21
+ export type AjvKeyword = KeywordDefinition;
22
22
  ```
23
23
 
@@ -18,7 +18,7 @@ Plain function for body parsing
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type BodyParserFunction = (request: Request) => Promise<RequestBody>;
21
+ export type BodyParserFunction = (request: Request) => Promise<RequestBody>;
22
22
  ```
23
23
  <b>References:</b> [RequestBody](./rest.requestbody.md)
24
24
 
@@ -18,6 +18,6 @@ Express body parser function type
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type BodyParserMiddleware = (request: Request, response: Response, next: (err: HttpError) => void) => void;
21
+ export type BodyParserMiddleware = (request: Request, response: Response, next: (err: HttpError) => void) => void;
22
22
  ```
23
23
 
@@ -18,7 +18,7 @@ Controller class
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type ControllerClass<T extends ControllerInstance> = Constructor<T>;
21
+ export type ControllerClass<T extends ControllerInstance> = Constructor<T>;
22
22
  ```
23
23
  <b>References:</b> [ControllerInstance](./rest.controllerinstance.md)<!-- -->, [Constructor](./context.constructor.md)
24
24
 
@@ -18,7 +18,7 @@ A factory function to create controller instances synchronously or asynchronousl
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type ControllerFactory<T extends ControllerInstance> = (ctx: Context) => ValueOrPromise<T>;
21
+ export type ControllerFactory<T extends ControllerInstance> = (ctx: Context) => ValueOrPromise<T>;
22
22
  ```
23
23
  <b>References:</b> [ControllerInstance](./rest.controllerinstance.md)<!-- -->, [Context](./context.context.md)<!-- -->, [ValueOrPromise](./context.valueorpromise.md)
24
24
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.rest.controllerinstance.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type ControllerInstance = {
19
+ export type ControllerInstance = {
20
20
  [name: string]: any;
21
21
  } & object;
22
22
  ```
@@ -18,7 +18,7 @@ Find a route matching the incoming request. Throw an error when no route was fou
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type FindRoute = (request: Request) => ResolvedRoute;
21
+ export type FindRoute = (request: Request) => ResolvedRoute;
22
22
  ```
23
23
  <b>References:</b> [ResolvedRoute](./rest.resolvedroute.md)
24
24
 
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.rest.httprequestlistener.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type HttpRequestListener = (req: IncomingMessage, res: ServerResponse) => void;
19
+ export type HttpRequestListener = (req: IncomingMessage, res: ServerResponse) => void;
20
20
  ```
21
21
 
@@ -18,7 +18,7 @@ Invokes a method defined in the Application Controller
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type InvokeMethod = (route: RouteEntry, args: OperationArgs) => Promise<OperationRetval>;
21
+ export type InvokeMethod = (route: RouteEntry, args: OperationArgs) => Promise<OperationRetval>;
22
22
  ```
23
23
  <b>References:</b> [RouteEntry](./rest.routeentry.md)<!-- -->, [OperationArgs](./rest.operationargs.md)<!-- -->, [OperationRetval](./rest.operationretval.md)
24
24
 
@@ -18,6 +18,6 @@ Log information about a failed request.
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type LogError = (err: Error, statusCode: number, request: Request) => void;
21
+ export type LogError = (err: Error, statusCode: number, request: Request) => void;
22
22
  ```
23
23
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.rest.nodewithvalue.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type NodeWithValue<T> = Node<T> & {
19
+ export type NodeWithValue<T> = Node<T> & {
20
20
  value: T;
21
21
  };
22
22
  ```
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.rest.operationargs.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type OperationArgs = any[];
19
+ export type OperationArgs = any[];
20
20
  ```
21
21
 
@@ -18,6 +18,6 @@ Return value of a controller method (a function implementing an operation). This
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type OperationRetval = any;
21
+ export type OperationRetval = any;
22
22
  ```
23
23
 
@@ -18,7 +18,7 @@ A function to parse OpenAPI operation parameters for a given route
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type ParseParams = (request: Request, route: ResolvedRoute) => Promise<OperationArgs>;
21
+ export type ParseParams = (request: Request, route: ResolvedRoute) => Promise<OperationArgs>;
22
22
  ```
23
23
  <b>References:</b> [ResolvedRoute](./rest.resolvedroute.md)<!-- -->, [OperationArgs](./rest.operationargs.md)
24
24
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.rest.pathparametervalues.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type PathParameterValues = {
19
+ export type PathParameterValues = {
20
20
  [key: string]: any;
21
21
  };
22
22
  ```
@@ -18,7 +18,7 @@ Reject the request with an error.
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type Reject = (handlerContext: HandlerContext, err: Error) => void;
21
+ export type Reject = (handlerContext: HandlerContext, err: Error) => void;
22
22
  ```
23
23
  <b>References:</b> [HandlerContext](./express.handlercontext.md)
24
24
 
@@ -18,7 +18,7 @@ Request body with metadata
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type RequestBody = {
21
+ export type RequestBody = {
22
22
  value: any | undefined;
23
23
  coercionRequired?: boolean;
24
24
  mediaType?: string;
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.rest.requestbodyvalidationoptions.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type RequestBodyValidationOptions = ValidationOptions;
19
+ export type RequestBodyValidationOptions = ValidationOptions;
20
20
  ```
21
21
  <b>References:</b> [ValidationOptions](./rest.validationoptions.md)
22
22
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.rest.restcomponentconfig.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type RestComponentConfig = RestServerConfig;
19
+ export type RestComponentConfig = RestServerConfig;
20
20
  ```
21
21
  <b>References:</b> [RestServerConfig](./rest.restserverconfig.md)
22
22
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.rest.restrouteroptions.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type RestRouterOptions = {
19
+ export type RestRouterOptions = {
20
20
  strict?: boolean;
21
21
  };
22
22
  ```
@@ -18,7 +18,7 @@ Valid configuration for the RestServer constructor.
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type RestServerConfig = RestServerOptions & HttpServerOptions;
21
+ export type RestServerConfig = RestServerOptions & HttpServerOptions;
22
22
  ```
23
23
  <b>References:</b> [RestServerOptions](./rest.restserveroptions.md)<!-- -->, [HttpServerOptions](./http-server.httpserveroptions.md)
24
24
 
@@ -18,7 +18,7 @@ RestServer options
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type RestServerOptions = Partial<RestServerResolvedOptions>;
21
+ export type RestServerOptions = Partial<RestServerResolvedOptions>;
22
22
  ```
23
23
  <b>References:</b> [RestServerResolvedOptions](./rest.restserverresolvedoptions.md)
24
24
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.rest.restserverresolvedconfig.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type RestServerResolvedConfig = RestServerResolvedOptions & HttpServerOptions;
19
+ export type RestServerResolvedConfig = RestServerResolvedOptions & HttpServerOptions;
20
20
  ```
21
21
  <b>References:</b> [RestServerResolvedOptions](./rest.restserverresolvedoptions.md)<!-- -->, [HttpServerOptions](./http-server.httpserveroptions.md)
22
22
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.rest.routerspec.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type RouterSpec = Pick<OpenApiSpec, 'paths' | 'components' | 'tags'>;
19
+ export type RouterSpec = Pick<OpenApiSpec, 'paths' | 'components' | 'tags'>;
20
20
  ```
21
21
  <b>References:</b> [OpenApiSpec](./openapi-v3.openapispec.md)
22
22
 
@@ -18,7 +18,7 @@ Cache for AJV schema validators
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type SchemaValidatorCache = WeakMap<SchemaObject | ReferenceObject, // First keyed by schema object
21
+ export type SchemaValidatorCache = WeakMap<SchemaObject | ReferenceObject, // First keyed by schema object
22
22
  Map<string, ValidateFunction>>;
23
23
  ```
24
24
 
@@ -18,7 +18,7 @@ Send the operation response back to the client.
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type Send = (response: Response, result: OperationRetval) => void;
21
+ export type Send = (response: Response, result: OperationRetval) => void;
22
22
  ```
23
23
  <b>References:</b> [OperationRetval](./rest.operationretval.md)
24
24
 
@@ -18,7 +18,7 @@ A sequence function is a function implementing a custom sequence of actions to h
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type SequenceFunction = (context: RequestContext, sequence: DefaultSequence) => ValueOrPromise<void>;
21
+ export type SequenceFunction = (context: RequestContext, sequence: DefaultSequence) => ValueOrPromise<void>;
22
22
  ```
23
23
  <b>References:</b> [RequestContext](./rest.requestcontext.md)<!-- -->, [DefaultSequence](./rest.defaultsequence.md)<!-- -->, [ValueOrPromise](./context.valueorpromise.md)
24
24
 
@@ -18,6 +18,6 @@ Type definition for decorators returned by `@serviceProxy` decorator factory
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type ServiceProxyDecorator = PropertyDecorator | ParameterDecorator;
21
+ export type ServiceProxyDecorator = PropertyDecorator | ParameterDecorator;
22
22
  ```
23
23
 
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.socketio.socketiodonefunction.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type SocketIoDoneFunction = (response: unknown) => Promise<void>;
19
+ export type SocketIoDoneFunction = (response: unknown) => Promise<void>;
20
20
  ```
21
21
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.socketio.socketioinvokemethod.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type SocketIoInvokeMethod = (context: Context, controller: ControllerClass, methodName: string, args: unknown[]) => unknown;
19
+ export type SocketIoInvokeMethod = (context: Context, controller: ControllerClass, methodName: string, args: unknown[]) => unknown;
20
20
  ```
21
21
  <b>References:</b> [Context](./context.context.md)<!-- -->, [ControllerClass](./core.controllerclass.md)
22
22
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.socketio.socketiooptions.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type SocketIoOptions = HttpServerOptions;
19
+ export type SocketIoOptions = HttpServerOptions;
20
20
  ```
21
21
  <b>References:</b> [HttpServerOptions](./http-server.httpserveroptions.md)
22
22
 
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.socketio.socketiorejectmethod.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type SocketIoRejectMethod = (done: Function, error: Error) => unknown;
19
+ export type SocketIoRejectMethod = (done: Function, error: Error) => unknown;
20
20
  ```
21
21
 
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.socketio.socketiosendmethod.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type SocketIoSendMethod = (done: Function, result: unknown) => unknown;
19
+ export type SocketIoSendMethod = (done: Function, result: unknown) => unknown;
20
20
  ```
21
21
 
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.socketio.sockiomiddleware.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type SockIOMiddleware = (socket: Socket, fn: (err?: any) => void) => void;
19
+ export type SockIOMiddleware = (socket: Socket, fn: (err?: any) => void) => void;
20
20
  ```
21
21
 
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.testlab.client.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type Client = supertest.SuperTest<supertest.Test>;
19
+ export type Client = supertest.SuperTest<supertest.Test>;
20
20
  ```
21
21
 
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.testlab.observedresponse.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type ObservedResponse = ResponseObject;
19
+ export type ObservedResponse = ResponseObject;
20
20
  ```
21
21
 
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.testlab.shotcallback.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type ShotCallback = (response: ResponseObject) => void;
19
+ export type ShotCallback = (response: ResponseObject) => void;
20
20
  ```
21
21
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.testlab.shotresponsector.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type ShotResponseCtor = new (request: IncomingMessage, onEnd: ShotCallback) => ServerResponse;
19
+ export type ShotResponseCtor = new (request: IncomingMessage, onEnd: ShotCallback) => ServerResponse;
20
20
  ```
21
21
  <b>References:</b> [ShotCallback](./testlab.shotcallback.md)
22
22
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.testlab.stubbedinstancewithsinonaccessor.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type StubbedInstanceWithSinonAccessor<T> = T & {
19
+ export type StubbedInstanceWithSinonAccessor<T> = T & {
20
20
  stubs: sinon.SinonStubbedInstance<T>;
21
21
  };
22
22
  ```
@@ -18,6 +18,6 @@ A function defining a new test case or a test suite, e.g. `it` or `describe`<!--
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type TestDefinition<ARGS extends unknown[], RETVAL> = (name: string, ...args: ARGS) => RETVAL;
21
+ export type TestDefinition<ARGS extends unknown[], RETVAL> = (name: string, ...args: ARGS) => RETVAL;
22
22
  ```
23
23
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.typeorm.propertytype.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type PropertyType = {
19
+ export type PropertyType = {
20
20
  [propertyName: string]: SchemaObject | ReferenceObject;
21
21
  };
22
22
  ```