@loopback/docs 5.1.4 → 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 (247) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/package.json +3 -3
  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.dynamicmodelctor.md +1 -1
  114. package/site/apidocs/repository.entitydata.md +1 -1
  115. package/site/apidocs/repository.entityresolver.md +1 -1
  116. package/site/apidocs/repository.hasmanythroughrepositoryfactory.md +1 -1
  117. package/site/apidocs/repository.inclusionresolver.md +1 -1
  118. package/site/apidocs/repository.keyvaluefilter.md +1 -1
  119. package/site/apidocs/repository.md +1 -0
  120. package/site/apidocs/repository.namedparameters.md +1 -1
  121. package/site/apidocs/repository.nonfunction.md +21 -0
  122. package/site/apidocs/repository.options.md +1 -1
  123. package/site/apidocs/repository.positionalparameters.md +1 -1
  124. package/site/apidocs/repository.propertymap.md +1 -1
  125. package/site/apidocs/repository.propertytype.md +1 -1
  126. package/site/apidocs/repository.prototypeof.md +1 -1
  127. package/site/apidocs/repository.relationdefinitionmap.md +1 -1
  128. package/site/apidocs/repository.relationmetadata.md +1 -1
  129. package/site/apidocs/repository.repositorydecorator.md +1 -1
  130. package/site/apidocs/repository.resolvetype.md +2 -2
  131. package/site/apidocs/repository.resolvetype_1.md +2 -2
  132. package/site/apidocs/repository.stringkeyof.md +1 -1
  133. package/site/apidocs/repository.transactionalentityrepository.md +1 -1
  134. package/site/apidocs/repository.typeresolver.md +1 -1
  135. package/site/apidocs/rest-explorer.restexplorerconfig.md +1 -1
  136. package/site/apidocs/rest.ajverroroptions.md +1 -1
  137. package/site/apidocs/rest.ajvfactory.md +1 -1
  138. package/site/apidocs/rest.ajvformat.md +1 -1
  139. package/site/apidocs/rest.ajvkeyword.md +1 -1
  140. package/site/apidocs/rest.bodyparserfunction.md +1 -1
  141. package/site/apidocs/rest.bodyparsermiddleware.md +1 -1
  142. package/site/apidocs/rest.controllerclass.md +1 -1
  143. package/site/apidocs/rest.controllerfactory.md +1 -1
  144. package/site/apidocs/rest.controllerinstance.md +1 -1
  145. package/site/apidocs/rest.findroute.md +1 -1
  146. package/site/apidocs/rest.httprequestlistener.md +1 -1
  147. package/site/apidocs/rest.invokemethod.md +1 -1
  148. package/site/apidocs/rest.logerror.md +1 -1
  149. package/site/apidocs/rest.nodewithvalue.md +1 -1
  150. package/site/apidocs/rest.operationargs.md +1 -1
  151. package/site/apidocs/rest.operationretval.md +1 -1
  152. package/site/apidocs/rest.parseparams.md +1 -1
  153. package/site/apidocs/rest.pathparametervalues.md +1 -1
  154. package/site/apidocs/rest.reject.md +1 -1
  155. package/site/apidocs/rest.requestbody.md +1 -1
  156. package/site/apidocs/rest.requestbodyvalidationoptions.md +1 -1
  157. package/site/apidocs/rest.restcomponentconfig.md +1 -1
  158. package/site/apidocs/rest.restrouteroptions.md +1 -1
  159. package/site/apidocs/rest.restserverconfig.md +1 -1
  160. package/site/apidocs/rest.restserveroptions.md +1 -1
  161. package/site/apidocs/rest.restserverresolvedconfig.md +1 -1
  162. package/site/apidocs/rest.routerspec.md +1 -1
  163. package/site/apidocs/rest.schemavalidatorcache.md +1 -1
  164. package/site/apidocs/rest.send.md +1 -1
  165. package/site/apidocs/rest.sequencefunction.md +1 -1
  166. package/site/apidocs/service-proxy.serviceproxydecorator.md +1 -1
  167. package/site/apidocs/socketio.socketiodonefunction.md +1 -1
  168. package/site/apidocs/socketio.socketioinvokemethod.md +1 -1
  169. package/site/apidocs/socketio.socketiooptions.md +1 -1
  170. package/site/apidocs/socketio.socketiorejectmethod.md +1 -1
  171. package/site/apidocs/socketio.socketiosendmethod.md +1 -1
  172. package/site/apidocs/socketio.sockiomiddleware.md +1 -1
  173. package/site/apidocs/testlab.client.md +1 -1
  174. package/site/apidocs/testlab.observedresponse.md +1 -1
  175. package/site/apidocs/testlab.shotcallback.md +1 -1
  176. package/site/apidocs/testlab.shotresponsector.md +1 -1
  177. package/site/apidocs/testlab.stubbedinstancewithsinonaccessor.md +1 -1
  178. package/site/apidocs/testlab.testdefinition.md +1 -1
  179. package/site/apidocs/typeorm.propertytype.md +1 -1
  180. package/site/apidocs/typeorm.stringifiedtypeoptions.md +1 -1
  181. package/site/apidocs/typeorm.typeormcomponentoptions.md +1 -1
  182. package/site/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +9 -0
  183. package/site/changelogs/examples/access-control-migration/CHANGELOG.md +4 -0
  184. package/site/changelogs/examples/binding-resolution/CHANGELOG.md +9 -0
  185. package/site/changelogs/examples/context/CHANGELOG.md +4 -0
  186. package/site/changelogs/examples/express-composition/CHANGELOG.md +4 -0
  187. package/site/changelogs/examples/file-transfer/CHANGELOG.md +4 -0
  188. package/site/changelogs/examples/graphql/CHANGELOG.md +9 -0
  189. package/site/changelogs/examples/greeter-extension/CHANGELOG.md +4 -0
  190. package/site/changelogs/examples/greeting-app/CHANGELOG.md +4 -0
  191. package/site/changelogs/examples/hello-world/CHANGELOG.md +4 -0
  192. package/site/changelogs/examples/lb3-application/CHANGELOG.md +4 -0
  193. package/site/changelogs/examples/log-extension/CHANGELOG.md +4 -0
  194. package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +4 -0
  195. package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +4 -0
  196. package/site/changelogs/examples/passport-login/CHANGELOG.md +4 -0
  197. package/site/changelogs/examples/references-many/CHANGELOG.md +4 -0
  198. package/site/changelogs/examples/rest-crud/CHANGELOG.md +4 -0
  199. package/site/changelogs/examples/rpc-server/CHANGELOG.md +4 -0
  200. package/site/changelogs/examples/soap-calculator/CHANGELOG.md +4 -0
  201. package/site/changelogs/examples/socketio/CHANGELOG.md +4 -0
  202. package/site/changelogs/examples/todo/CHANGELOG.md +4 -0
  203. package/site/changelogs/examples/todo-jwt/CHANGELOG.md +4 -0
  204. package/site/changelogs/examples/todo-list/CHANGELOG.md +4 -0
  205. package/site/changelogs/examples/validation-app/CHANGELOG.md +4 -0
  206. package/site/changelogs/examples/webpack/CHANGELOG.md +9 -0
  207. package/site/changelogs/extensions/apiconnect/CHANGELOG.md +9 -0
  208. package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +9 -0
  209. package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +9 -0
  210. package/site/changelogs/extensions/context-explorer/CHANGELOG.md +9 -0
  211. package/site/changelogs/extensions/cron/CHANGELOG.md +9 -0
  212. package/site/changelogs/extensions/graphql/CHANGELOG.md +9 -0
  213. package/site/changelogs/extensions/health/CHANGELOG.md +9 -0
  214. package/site/changelogs/extensions/logging/CHANGELOG.md +9 -0
  215. package/site/changelogs/extensions/metrics/CHANGELOG.md +9 -0
  216. package/site/changelogs/extensions/pooling/CHANGELOG.md +9 -0
  217. package/site/changelogs/extensions/socketio/CHANGELOG.md +9 -0
  218. package/site/changelogs/extensions/typeorm/CHANGELOG.md +9 -0
  219. package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +9 -0
  220. package/site/changelogs/packages/authentication/CHANGELOG.md +9 -0
  221. package/site/changelogs/packages/authorization/CHANGELOG.md +9 -0
  222. package/site/changelogs/packages/boot/CHANGELOG.md +9 -0
  223. package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +9 -0
  224. package/site/changelogs/packages/build/CHANGELOG.md +10 -1
  225. package/site/changelogs/packages/cli/CHANGELOG.md +14 -0
  226. package/site/changelogs/packages/context/CHANGELOG.md +9 -0
  227. package/site/changelogs/packages/core/CHANGELOG.md +9 -0
  228. package/site/changelogs/packages/eslint-config/CHANGELOG.md +10 -1
  229. package/site/changelogs/packages/express/CHANGELOG.md +9 -0
  230. package/site/changelogs/packages/filter/CHANGELOG.md +9 -0
  231. package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +9 -0
  232. package/site/changelogs/packages/http-server/CHANGELOG.md +9 -0
  233. package/site/changelogs/packages/metadata/CHANGELOG.md +9 -0
  234. package/site/changelogs/packages/model-api-builder/CHANGELOG.md +9 -0
  235. package/site/changelogs/packages/monorepo/CHANGELOG.md +10 -1
  236. package/site/changelogs/packages/openapi-spec-builder/CHANGELOG.md +9 -0
  237. package/site/changelogs/packages/openapi-v3/CHANGELOG.md +9 -0
  238. package/site/changelogs/packages/repository/CHANGELOG.md +19 -0
  239. package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +9 -0
  240. package/site/changelogs/packages/repository-tests/CHANGELOG.md +9 -0
  241. package/site/changelogs/packages/rest/CHANGELOG.md +9 -0
  242. package/site/changelogs/packages/rest-crud/CHANGELOG.md +9 -0
  243. package/site/changelogs/packages/rest-explorer/CHANGELOG.md +9 -0
  244. package/site/changelogs/packages/security/CHANGELOG.md +9 -0
  245. package/site/changelogs/packages/service-proxy/CHANGELOG.md +9 -0
  246. package/site/changelogs/packages/testlab/CHANGELOG.md +10 -1
  247. package/site/changelogs/packages/tsdocs/CHANGELOG.md +9 -0
@@ -18,7 +18,7 @@ A factory function for `toDynamicValue`
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type ValueFactory<T = unknown> = (resolutionCtx: ResolutionContext) => ValueOrPromise<T | undefined>;
21
+ export type ValueFactory<T = unknown> = (resolutionCtx: ResolutionContext) => ValueOrPromise<T | undefined>;
22
22
  ```
23
23
  <b>References:</b> [ResolutionContext](./context.resolutioncontext.md)<!-- -->, [ValueOrPromise](./context.valueorpromise.md)
24
24
 
@@ -20,6 +20,6 @@ Note that we are using PromiseLike instead of native Promise to describe the asy
20
20
  <b>Signature:</b>
21
21
 
22
22
  ```typescript
23
- export declare type ValueOrPromise<T> = T | PromiseLike<T>;
23
+ export type ValueOrPromise<T> = T | PromiseLike<T>;
24
24
  ```
25
25
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.core.controllerclass.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type ControllerClass<T = any> = Constructor<T>;
19
+ export type ControllerClass<T = any> = Constructor<T>;
20
20
  ```
21
21
  <b>References:</b> [Constructor](./context.constructor.md)
22
22
 
@@ -18,7 +18,7 @@ A group of life cycle observers
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type LifeCycleObserverGroup = {
21
+ export type LifeCycleObserverGroup = {
22
22
  group: string;
23
23
  bindings: Readonly<Binding<LifeCycleObserver>>[];
24
24
  };
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.core.lifecycleobserveroptions.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type LifeCycleObserverOptions = {
19
+ export type LifeCycleObserverOptions = {
20
20
  orderedGroups: string[];
21
21
  disabledGroups?: string[];
22
22
  parallel?: boolean;
@@ -18,7 +18,7 @@ A replacement for `typeof Target` to be used in mixin class definitions. This is
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type MixinTarget<T extends object> = Constructor<{
21
+ export type MixinTarget<T extends object> = Constructor<{
22
22
  [P in keyof T]: T[P];
23
23
  }>;
24
24
  ```
@@ -18,6 +18,6 @@ Representing an interface for services. In TypeScript, the `interface` does not
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type ServiceInterface = string | symbol | Function;
21
+ export type ServiceInterface = string | symbol | Function;
22
22
  ```
23
23
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.core.serviceorproviderclass.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type ServiceOrProviderClass<T = any> = Constructor<T | Provider<T>> | DynamicValueProviderClass<T>;
19
+ export type ServiceOrProviderClass<T = any> = Constructor<T | Provider<T>> | DynamicValueProviderClass<T>;
20
20
  ```
21
21
  <b>References:</b> [Constructor](./context.constructor.md)<!-- -->, [Provider](./context.provider.md)<!-- -->, [DynamicValueProviderClass](./context.dynamicvalueproviderclass.md)
22
22
 
@@ -18,7 +18,7 @@ Options to set up application shutdown
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type ShutdownOptions = {
21
+ export type ShutdownOptions = {
22
22
  signals?: NodeJS.Signals[];
23
23
  gracePeriod?: number;
24
24
  };
@@ -18,7 +18,7 @@ Configuration for a cron job.
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type CronJobConfig = Partial<CronJobOptions>;
21
+ export type CronJobConfig = Partial<CronJobOptions>;
22
22
  ```
23
23
  <b>References:</b> [CronJobOptions](./cron.cronjoboptions.md)
24
24
 
@@ -20,7 +20,7 @@ Options for a cron job. It adds an optional `name` to cron parameters.
20
20
  <b>Signature:</b>
21
21
 
22
22
  ```typescript
23
- export declare type CronJobOptions = CronJobParameters & {
23
+ export type CronJobOptions = CronJobParameters & {
24
24
  name?: string;
25
25
  };
26
26
  ```
@@ -18,6 +18,6 @@ Type alias for Express RequestHandler
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type ExpressRequestHandler = RequestHandler;
21
+ export type ExpressRequestHandler = RequestHandler;
22
22
  ```
23
23
 
@@ -18,7 +18,7 @@ Configuration for a LoopBack based Express server
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type ExpressServerConfig = (HttpOptions | HttpsOptions) & {
21
+ export type ExpressServerConfig = (HttpOptions | HttpsOptions) & {
22
22
  basePath?: string;
23
23
  settings?: Record<string, unknown>;
24
24
  };
@@ -18,7 +18,7 @@ A middleware function or binding key
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type MiddlewareOrKey = GenericInterceptorOrKey<MiddlewareContext>;
21
+ export type MiddlewareOrKey = GenericInterceptorOrKey<MiddlewareContext>;
22
22
  ```
23
23
  <b>References:</b> [GenericInterceptorOrKey](./context.genericinterceptororkey.md)<!-- -->, [MiddlewareContext](./express.middlewarecontext.md)
24
24
 
@@ -18,7 +18,7 @@ Condition clause
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type Condition<MT extends object> = {
21
+ export type Condition<MT extends object> = {
22
22
  [P in KeyOf<MT>]?: PredicateComparison<MT[P]> | (MT[P] & ShortHandEqualType);
23
23
  };
24
24
  ```
@@ -18,6 +18,6 @@ Order by direction
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type Direction = 'ASC' | 'DESC';
21
+ export type Direction = 'ASC' | 'DESC';
22
22
  ```
23
23
 
@@ -20,7 +20,7 @@ Example: `{afieldname: true}`
20
20
  <b>Signature:</b>
21
21
 
22
22
  ```typescript
23
- export declare type Fields<MT = AnyObject> = {
23
+ export type Fields<MT = AnyObject> = {
24
24
  [P in keyof MT]?: boolean;
25
25
  } | Extract<keyof MT, string>[];
26
26
  ```
@@ -18,7 +18,7 @@ Filter without `where` property
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type FilterExcludingWhere<MT extends object = AnyObject> = Omit<Filter<MT>, 'where'>;
21
+ export type FilterExcludingWhere<MT extends object = AnyObject> = Omit<Filter<MT>, 'where'>;
22
22
  ```
23
23
  <b>References:</b> [Filter](./filter.filter.md)
24
24
 
@@ -18,7 +18,7 @@ Inclusion filter type e.g. 'property', {<!-- -->relation: 'property'<!-- -->}
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type InclusionFilter = string | Inclusion;
21
+ export type InclusionFilter = string | Inclusion;
22
22
  ```
23
23
  <b>References:</b> [Inclusion](./filter.inclusion.md)
24
24
 
@@ -18,7 +18,7 @@ Key types of a given model, excluding operators
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type KeyOf<MT extends object> = Exclude<Extract<keyof MT, string>, Operators>;
21
+ export type KeyOf<MT extends object> = Exclude<Extract<keyof MT, string>, Operators>;
22
22
  ```
23
23
  <b>References:</b> [Operators](./filter.operators.md)
24
24
 
@@ -18,6 +18,6 @@ Operators for where clauses
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type Operators = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'inq' | 'nin' | 'between' | 'exists' | 'and' | 'or' | 'like' | 'nlike' | 'ilike' | 'nilike' | 'regexp';
21
+ export type Operators = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'inq' | 'nin' | 'between' | 'exists' | 'and' | 'or' | 'like' | 'nlike' | 'ilike' | 'nilike' | 'regexp';
22
22
  ```
23
23
 
@@ -20,7 +20,7 @@ Example: `{afieldname: 'ASC'}`
20
20
  <b>Signature:</b>
21
21
 
22
22
  ```typescript
23
- export declare type Order<MT = AnyObject> = {
23
+ export type Order<MT = AnyObject> = {
24
24
  [P in keyof MT]: Direction;
25
25
  };
26
26
  ```
@@ -18,7 +18,7 @@ Matching predicate comparison
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type PredicateComparison<PT> = {
21
+ export type PredicateComparison<PT> = {
22
22
  eq?: PT;
23
23
  neq?: PT;
24
24
  gt?: PT;
@@ -18,6 +18,6 @@ Value types for `{propertyName: value}`
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type ShortHandEqualType = string | number | boolean | Date;
21
+ export type ShortHandEqualType = string | number | boolean | Date;
22
22
  ```
23
23
 
@@ -18,7 +18,7 @@ Where clause
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type Where<MT extends object = AnyObject> = Condition<MT> | AndClause<MT> | OrClause<MT>;
21
+ export type Where<MT extends object = AnyObject> = Condition<MT> | AndClause<MT> | OrClause<MT>;
22
22
  ```
23
23
  <b>References:</b> [Condition](./filter.condition.md)<!-- -->, [AndClause](./filter.andclause.md)<!-- -->, [OrClause](./filter.orclause.md)
24
24
 
@@ -16,7 +16,10 @@ permalink: /doc/en/lb4/apidocs.graphql.graphqlserver.exportgraphqlschema.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- exportGraphQLSchema(outFile?: string, log?: (message?: any, ...optionalParams: any[]) => void): Promise<void>;
19
+ exportGraphQLSchema(outFile?: string, log?: {
20
+ (...data: any[]): void;
21
+ (message?: any, ...optionalParams: any[]): void;
22
+ }): Promise<void>;
20
23
  ```
21
24
 
22
25
  ## Parameters
@@ -24,7 +27,7 @@ exportGraphQLSchema(outFile?: string, log?: (message?: any, ...optionalParams: a
24
27
  | Parameter | Type | Description |
25
28
  | --- | --- | --- |
26
29
  | outFile | string | <i>(Optional)</i> |
27
- | log | (message?: any, ...optionalParams: any\[\]) =&gt; void | <i>(Optional)</i> |
30
+ | log | { (...data: any\[\]): void; (message?: any, ...optionalParams: any\[\]): void; } | <i>(Optional)</i> |
28
31
 
29
32
  <b>Returns:</b>
30
33
 
@@ -18,7 +18,7 @@ Configuration for health component with optional properties
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type HealthConfig = Partial<HealthOptions>;
21
+ export type HealthConfig = Partial<HealthOptions>;
22
22
  ```
23
23
  <b>References:</b> [HealthOptions](./health.healthoptions.md)
24
24
 
@@ -18,7 +18,7 @@ Options for health component
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type HealthOptions = {
21
+ export type HealthOptions = {
22
22
  disabled?: boolean;
23
23
  healthPath: string;
24
24
  readyPath: string;
@@ -18,6 +18,6 @@ Functions for liveness check
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type LiveCheck = () => Promise<void>;
21
+ export type LiveCheck = () => Promise<void>;
22
22
  ```
23
23
 
@@ -18,6 +18,6 @@ Functions for readiness check
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type ReadyCheck = () => Promise<void>;
21
+ export type ReadyCheck = () => Promise<void>;
22
22
  ```
23
23
 
@@ -18,6 +18,6 @@ Supported protocols
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type HttpProtocol = 'http' | 'https';
21
+ export type HttpProtocol = 'http' | 'https';
22
22
  ```
23
23
 
@@ -18,7 +18,7 @@ Possible server options
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type HttpServerOptions = HttpOptions | HttpsOptions;
21
+ export type HttpServerOptions = HttpOptions | HttpsOptions;
22
22
  ```
23
23
  <b>References:</b> [HttpOptions](./http-server.httpoptions.md)<!-- -->, [HttpsOptions](./http-server.httpsoptions.md)
24
24
 
@@ -18,6 +18,6 @@ The following are for configuring properties which are directly set on https://n
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type HttpServerProperties = Pick<Server, 'keepAliveTimeout' | 'headersTimeout' | 'maxConnections' | 'maxHeadersCount' | 'timeout'>;
21
+ export type HttpServerProperties = Pick<Server, 'keepAliveTimeout' | 'headersTimeout' | 'maxConnections' | 'maxHeadersCount' | 'timeout'>;
22
22
  ```
23
23
 
@@ -18,6 +18,6 @@ Request listener function for http/https requests
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type RequestListener = (req: IncomingMessage, res: ServerResponse) => void;
21
+ export type RequestListener = (req: IncomingMessage, res: ServerResponse) => void;
22
22
  ```
23
23
 
@@ -18,7 +18,7 @@ Configuration for LoggingComponent
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type LoggingComponentConfig = {
21
+ export type LoggingComponentConfig = {
22
22
  enableFluent?: boolean;
23
23
  enableHttpAccessLog?: boolean;
24
24
  };
@@ -18,6 +18,6 @@ Decorator function types
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type DecoratorType = ClassDecorator | PropertyDecorator | MethodDecorator | ParameterDecorator;
21
+ export type DecoratorType = ClassDecorator | PropertyDecorator | MethodDecorator | ParameterDecorator;
22
22
  ```
23
23
 
@@ -18,7 +18,7 @@ Key for metadata access via reflection
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type MetadataKey<T, D extends DecoratorType> = MetadataAccessor<T, D> | string;
21
+ export type MetadataKey<T, D extends DecoratorType> = MetadataAccessor<T, D> | string;
22
22
  ```
23
23
  <b>References:</b> [DecoratorType](./metadata.decoratortype.md)<!-- -->, [MetadataAccessor](./metadata.metadataaccessor.md)
24
24
 
@@ -18,7 +18,7 @@ Configuration for metrics component with optional properties
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type MetricsConfig = Partial<MetricsOptions>;
21
+ export type MetricsConfig = Partial<MetricsOptions>;
22
22
  ```
23
23
  <b>References:</b> [MetricsOptions](./metrics.metricsoptions.md)
24
24
 
@@ -18,7 +18,7 @@ Configuration settings for individual model files. This type describes content o
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type ModelApiConfig = {
21
+ export type ModelApiConfig = {
22
22
  model: typeof Model & {
23
23
  prototype: Model;
24
24
  };
@@ -16,6 +16,6 @@ permalink: /doc/en/lb4/apidocs.openapi-v3.openapispec.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type OpenApiSpec = OpenAPIObject;
19
+ export type OpenApiSpec = OpenAPIObject;
20
20
  ```
21
21
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.openapi-v3.responsedecoratormetadata.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type ResponseDecoratorMetadata = ResponseDecoratorMetadataItem[];
19
+ export type ResponseDecoratorMetadata = ResponseDecoratorMetadataItem[];
20
20
  ```
21
21
  <b>References:</b> [ResponseDecoratorMetadataItem](./openapi-v3.responsedecoratormetadataitem.md)
22
22
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.openapi-v3.responsemodelorspec.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type ResponseModelOrSpec = typeof Model | SchemaObject | ResponseObject | ReferenceObject;
19
+ export type ResponseModelOrSpec = typeof Model | SchemaObject | ResponseObject | ReferenceObject;
20
20
  ```
21
21
  <b>References:</b> [Model](./repository.model.md)
22
22
 
@@ -18,7 +18,7 @@ Custom LoopBack extension: a reference to Schema object that's bundled inside `d
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type SchemaRef = ReferenceObject & {
21
+ export type SchemaRef = ReferenceObject & {
22
22
  definitions: SchemasObject;
23
23
  };
24
24
  ```
@@ -18,7 +18,7 @@ Optional: From `T` make a set of properties by key `K` become optional
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type Optional<T extends object, K extends keyof T = keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
21
+ export type Optional<T extends object, K extends keyof T = keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
22
22
  ```
23
23
 
24
24
  ## Example
@@ -18,7 +18,7 @@ A constructor of a class implementing CrudRepository interface, accepting the En
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type CrudRepositoryCtor = new <T extends Entity, ID, Relations extends object>(entityClass: typeof Entity & {
21
+ export type CrudRepositoryCtor = new <T extends Entity, ID, Relations extends object>(entityClass: typeof Entity & {
22
22
  prototype: T;
23
23
  }, dataSource: juggler.DataSource) => EntityCrudRepository<T, ID, Relations>;
24
24
  ```
@@ -18,7 +18,7 @@ DataSource configuration (connector name, connection string, etc.).
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type DataSourceOptions = Options;
21
+ export type DataSourceOptions = Options;
22
22
  ```
23
23
  <b>References:</b> [Options](./repository.options.md)
24
24
 
@@ -18,7 +18,7 @@ A constructor of a class implementing TransactionalRepository interface, accepti
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type TransactionalRepositoryCtor = new <T extends Entity, ID, Relations extends object>(entityClass: typeof Entity & {
21
+ export type TransactionalRepositoryCtor = new <T extends Entity, ID, Relations extends object>(entityClass: typeof Entity & {
22
22
  prototype: T;
23
23
  }, dataSource: juggler.DataSource) => TransactionalEntityRepository<T, ID, Relations>;
24
24
  ```
@@ -18,6 +18,6 @@ Type alias for Node.js callback functions
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type Callback<T> = (err: Error | string | null | undefined, result?: T) => void;
21
+ export type Callback<T> = (err: Error | string | null | undefined, result?: T) => void;
22
22
  ```
23
23
 
@@ -18,7 +18,7 @@ Type for a command
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type Command = string | AnyObject;
21
+ export type Command = string | AnyObject;
22
22
  ```
23
23
  <b>References:</b> [AnyObject](./repository.anyobject.md)
24
24
 
@@ -18,7 +18,7 @@ Constructor type - class or function
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type Constructor<T> = Class<T> | ConstructorFunction<T>;
21
+ export type Constructor<T> = Class<T> | ConstructorFunction<T>;
22
22
  ```
23
23
  <b>References:</b> [Class](./repository.class.md)<!-- -->, [ConstructorFunction](./repository.constructorfunction.md)
24
24
 
@@ -18,7 +18,7 @@ Type alias for strongly or weakly typed objects of T
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type DataObject<T extends object> = T | DeepPartial<T>;
21
+ export type DataObject<T extends object> = T | DeepPartial<T>;
22
22
  ```
23
23
  <b>References:</b> [DeepPartial](./repository.deeppartial.md)
24
24
 
@@ -18,7 +18,7 @@ An extension of the built-in Partial<T> type which allows partial values in deep
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type DeepPartial<T> = Partial<T> | {
21
+ export type DeepPartial<T> = Partial<T> | {
22
22
  [P in keyof T]?: DeepPartial<T[P]>;
23
23
  };
24
24
  ```
@@ -20,7 +20,7 @@ Assuming template arguments `BaseCtor` and `Props`<!-- -->, this type describes
20
20
  <b>Signature:</b>
21
21
 
22
22
  ```typescript
23
- export declare type DynamicModelCtor<BaseCtor extends typeof Model, Props extends object> = {
23
+ export type DynamicModelCtor<BaseCtor extends typeof Model, Props extends object> = {
24
24
  new (data?: DataObject<PrototypeOf<BaseCtor> & Props>): PrototypeOf<BaseCtor> & Props;
25
25
  } & BaseCtor;
26
26
  ```
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.repository.entitydata.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type EntityData = DataObject<Entity>;
19
+ export type EntityData = DataObject<Entity>;
20
20
  ```
21
21
  <b>References:</b> [DataObject](./repository.dataobject.md)<!-- -->, [Entity](./repository.entity.md)
22
22
 
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.repository.entityresolver.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type EntityResolver<T extends Entity> = TypeResolver<T, typeof Entity>;
19
+ export type EntityResolver<T extends Entity> = TypeResolver<T, typeof Entity>;
20
20
  ```
21
21
  <b>References:</b> [Entity](./repository.entity.md)<!-- -->, [TypeResolver](./repository.typeresolver.md)
22
22
 
@@ -20,7 +20,7 @@ Warning: The hasManyThrough interface is experimental and is subject to change.
20
20
  <b>Signature:</b>
21
21
 
22
22
  ```typescript
23
- export declare type HasManyThroughRepositoryFactory<TargetEntity extends Entity, TargetID, ThroughEntity extends Entity, SourceID> = {
23
+ export type HasManyThroughRepositoryFactory<TargetEntity extends Entity, TargetID, ThroughEntity extends Entity, SourceID> = {
24
24
  (fkValue: SourceID): HasManyThroughRepository<TargetEntity, TargetID, ThroughEntity>;
25
25
  inclusionResolver: InclusionResolver<Entity, TargetEntity>;
26
26
  };
@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.repository.inclusionresolver.html
16
16
  <b>Signature:</b>
17
17
 
18
18
  ```typescript
19
- export declare type InclusionResolver<S extends Entity, T extends Entity> = (
19
+ export type InclusionResolver<S extends Entity, T extends Entity> = (
20
20
  sourceEntities: S[],
21
21
  inclusion: InclusionFilter,
22
22
  options?: Options) => Promise<(T | undefined)[] | (T[] | undefined)[]>;
@@ -18,7 +18,7 @@ Filter for keys
18
18
  <b>Signature:</b>
19
19
 
20
20
  ```typescript
21
- export declare type KeyValueFilter = {
21
+ export type KeyValueFilter = {
22
22
  match: string;
23
23
  };
24
24
  ```
@@ -213,6 +213,7 @@ This module provides data access facilities to various databases and services as
213
213
  | [InclusionResolver](./repository.inclusionresolver.md) | |
214
214
  | [KeyValueFilter](./repository.keyvaluefilter.md) | Filter for keys |
215
215
  | [NamedParameters](./repository.namedparameters.md) | Named parameters, such as <code>{x: 1, y: 'a'}</code> |
216
+ | [NonFunction](./repository.nonfunction.md) | |
216
217
  | [Options](./repository.options.md) | Type alias for Node.js options object |
217
218
  | [PositionalParameters](./repository.positionalparameters.md) | Positional parameters, such as \[1, 'a'\] |
218
219
  | [PropertyMap](./repository.propertymap.md) | |
@@ -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