@loopback/docs 5.1.7 → 5.2.1

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 (140) hide show
  1. package/CHANGELOG.md +29 -0
  2. package/package.json +5 -4
  3. package/site/Application-generator.md +1 -1
  4. package/site/CHANGELOG.md +1 -0
  5. package/site/Discovering-models.md +8 -0
  6. package/site/MONOREPO.md +1 -0
  7. package/site/apidocs/index.md +1 -0
  8. package/site/apidocs/sequelize.default_loopback_sequelize_options.md +23 -0
  9. package/site/apidocs/sequelize.loopbacksequelizecomponent._constructor_.md +31 -0
  10. package/site/apidocs/sequelize.loopbacksequelizecomponent.md +29 -0
  11. package/site/apidocs/sequelize.loopbacksequelizecomponentbindings.component.md +21 -0
  12. package/site/apidocs/sequelize.loopbacksequelizecomponentbindings.md +30 -0
  13. package/site/apidocs/sequelize.loopbacksequelizecomponentoptions.md +23 -0
  14. package/site/apidocs/sequelize.md +50 -0
  15. package/site/apidocs/sequelize.sequelizecrudrepository._constructor_.md +33 -0
  16. package/site/apidocs/sequelize.sequelizecrudrepository.begintransaction.md +32 -0
  17. package/site/apidocs/sequelize.sequelizecrudrepository.buildsequelizeattributefilter.md +36 -0
  18. package/site/apidocs/sequelize.sequelizecrudrepository.buildsequelizeincludefilter.md +39 -0
  19. package/site/apidocs/sequelize.sequelizecrudrepository.buildsequelizeorder.md +36 -0
  20. package/site/apidocs/sequelize.sequelizecrudrepository.buildsequelizewhere.md +36 -0
  21. package/site/apidocs/sequelize.sequelizecrudrepository.count.md +33 -0
  22. package/site/apidocs/sequelize.sequelizecrudrepository.create.md +33 -0
  23. package/site/apidocs/sequelize.sequelizecrudrepository.createall.md +33 -0
  24. package/site/apidocs/sequelize.sequelizecrudrepository.createbelongstoaccessorfor.md +37 -0
  25. package/site/apidocs/sequelize.sequelizecrudrepository.createhasmanyrepositoryfactoryfor.md +59 -0
  26. package/site/apidocs/sequelize.sequelizecrudrepository.createhasmanythroughrepositoryfactoryfor.md +63 -0
  27. package/site/apidocs/sequelize.sequelizecrudrepository.createhasonerepositoryfactoryfor.md +37 -0
  28. package/site/apidocs/sequelize.sequelizecrudrepository.createreferencesmanyaccessorfor.md +35 -0
  29. package/site/apidocs/sequelize.sequelizecrudrepository.datasource.md +21 -0
  30. package/site/apidocs/sequelize.sequelizecrudrepository.db_specific_settings_keys.md +25 -0
  31. package/site/apidocs/sequelize.sequelizecrudrepository.default_order_style.md +23 -0
  32. package/site/apidocs/sequelize.sequelizecrudrepository.delete.md +33 -0
  33. package/site/apidocs/sequelize.sequelizecrudrepository.deleteall.md +33 -0
  34. package/site/apidocs/sequelize.sequelizecrudrepository.deletebyid.md +33 -0
  35. package/site/apidocs/sequelize.sequelizecrudrepository.entityclass.md +23 -0
  36. package/site/apidocs/sequelize.sequelizecrudrepository.excludehiddenprops.md +36 -0
  37. package/site/apidocs/sequelize.sequelizecrudrepository.execute.md +32 -0
  38. package/site/apidocs/sequelize.sequelizecrudrepository.exists.md +33 -0
  39. package/site/apidocs/sequelize.sequelizecrudrepository.find.md +33 -0
  40. package/site/apidocs/sequelize.sequelizecrudrepository.findbyid.md +34 -0
  41. package/site/apidocs/sequelize.sequelizecrudrepository.findone.md +33 -0
  42. package/site/apidocs/sequelize.sequelizecrudrepository.getsequelizemodel.md +38 -0
  43. package/site/apidocs/sequelize.sequelizecrudrepository.getsequelizemodelattributes.md +40 -0
  44. package/site/apidocs/sequelize.sequelizecrudrepository.getsequelizeoperator.md +36 -0
  45. package/site/apidocs/sequelize.sequelizecrudrepository.includereferencesifrequested.md +40 -0
  46. package/site/apidocs/sequelize.sequelizecrudrepository.inclusionresolvers.md +21 -0
  47. package/site/apidocs/sequelize.sequelizecrudrepository.md +82 -0
  48. package/site/apidocs/sequelize.sequelizecrudrepository.registerinclusionresolver.md +35 -0
  49. package/site/apidocs/sequelize.sequelizecrudrepository.replacebyid.md +34 -0
  50. package/site/apidocs/sequelize.sequelizecrudrepository.save.md +33 -0
  51. package/site/apidocs/sequelize.sequelizecrudrepository.sequelizemodel.md +23 -0
  52. package/site/apidocs/sequelize.sequelizecrudrepository.syncloadedsequelizemodels.md +34 -0
  53. package/site/apidocs/sequelize.sequelizecrudrepository.syncsequelizemodel.md +34 -0
  54. package/site/apidocs/sequelize.sequelizecrudrepository.toentities.md +32 -0
  55. package/site/apidocs/sequelize.sequelizecrudrepository.update.md +33 -0
  56. package/site/apidocs/sequelize.sequelizecrudrepository.updateall.md +34 -0
  57. package/site/apidocs/sequelize.sequelizecrudrepository.updatebyid.md +34 -0
  58. package/site/apidocs/sequelize.sequelizedatasource._constructor_.md +30 -0
  59. package/site/apidocs/sequelize.sequelizedatasource.automigrate.md +25 -0
  60. package/site/apidocs/sequelize.sequelizedatasource.autoupdate.md +25 -0
  61. package/site/apidocs/sequelize.sequelizedatasource.begintransaction.md +36 -0
  62. package/site/apidocs/sequelize.sequelizedatasource.config.md +21 -0
  63. package/site/apidocs/sequelize.sequelizedatasource.getpooloptions.md +25 -0
  64. package/site/apidocs/sequelize.sequelizedatasource.init.md +25 -0
  65. package/site/apidocs/sequelize.sequelizedatasource.md +53 -0
  66. package/site/apidocs/sequelize.sequelizedatasource.name.md +21 -0
  67. package/site/apidocs/sequelize.sequelizedatasource.sequelize.md +21 -0
  68. package/site/apidocs/sequelize.sequelizedatasource.sequelizeconfig.md +21 -0
  69. package/site/apidocs/sequelize.sequelizedatasource.settings.md +21 -0
  70. package/site/apidocs/sequelize.sequelizedatasource.start.md +32 -0
  71. package/site/apidocs/sequelize.sequelizedatasource.stop.md +25 -0
  72. package/site/apidocs/sequelize.sequelizedatasourceconfig.md +28 -0
  73. package/site/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +19 -0
  74. package/site/changelogs/examples/access-control-migration/CHANGELOG.md +16 -0
  75. package/site/changelogs/examples/binding-resolution/CHANGELOG.md +16 -0
  76. package/site/changelogs/examples/context/CHANGELOG.md +16 -0
  77. package/site/changelogs/examples/express-composition/CHANGELOG.md +16 -0
  78. package/site/changelogs/examples/file-transfer/CHANGELOG.md +16 -0
  79. package/site/changelogs/examples/graphql/CHANGELOG.md +19 -0
  80. package/site/changelogs/examples/greeter-extension/CHANGELOG.md +16 -0
  81. package/site/changelogs/examples/greeting-app/CHANGELOG.md +16 -0
  82. package/site/changelogs/examples/hello-world/CHANGELOG.md +16 -0
  83. package/site/changelogs/examples/lb3-application/CHANGELOG.md +16 -0
  84. package/site/changelogs/examples/log-extension/CHANGELOG.md +16 -0
  85. package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +16 -0
  86. package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +16 -0
  87. package/site/changelogs/examples/passport-login/CHANGELOG.md +16 -0
  88. package/site/changelogs/examples/references-many/CHANGELOG.md +16 -0
  89. package/site/changelogs/examples/rest-crud/CHANGELOG.md +16 -0
  90. package/site/changelogs/examples/rpc-server/CHANGELOG.md +16 -0
  91. package/site/changelogs/examples/soap-calculator/CHANGELOG.md +16 -0
  92. package/site/changelogs/examples/socketio/CHANGELOG.md +16 -0
  93. package/site/changelogs/examples/todo/CHANGELOG.md +16 -0
  94. package/site/changelogs/examples/todo-jwt/CHANGELOG.md +16 -0
  95. package/site/changelogs/examples/todo-list/CHANGELOG.md +16 -0
  96. package/site/changelogs/examples/validation-app/CHANGELOG.md +16 -0
  97. package/site/changelogs/examples/webpack/CHANGELOG.md +16 -0
  98. package/site/changelogs/extensions/apiconnect/CHANGELOG.md +19 -0
  99. package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +19 -0
  100. package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +19 -0
  101. package/site/changelogs/extensions/context-explorer/CHANGELOG.md +19 -0
  102. package/site/changelogs/extensions/cron/CHANGELOG.md +19 -0
  103. package/site/changelogs/extensions/graphql/CHANGELOG.md +19 -0
  104. package/site/changelogs/extensions/health/CHANGELOG.md +19 -0
  105. package/site/changelogs/extensions/logging/CHANGELOG.md +19 -0
  106. package/site/changelogs/extensions/metrics/CHANGELOG.md +19 -0
  107. package/site/changelogs/extensions/pooling/CHANGELOG.md +19 -0
  108. package/site/changelogs/extensions/sequelize/CHANGELOG.md +22 -0
  109. package/site/changelogs/extensions/socketio/CHANGELOG.md +19 -0
  110. package/site/changelogs/extensions/typeorm/CHANGELOG.md +19 -0
  111. package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +27 -0
  112. package/site/changelogs/packages/authentication/CHANGELOG.md +19 -0
  113. package/site/changelogs/packages/authorization/CHANGELOG.md +19 -0
  114. package/site/changelogs/packages/boot/CHANGELOG.md +16 -0
  115. package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +19 -0
  116. package/site/changelogs/packages/build/CHANGELOG.md +22 -0
  117. package/site/changelogs/packages/cli/CHANGELOG.md +46 -0
  118. package/site/changelogs/packages/context/CHANGELOG.md +16 -0
  119. package/site/changelogs/packages/core/CHANGELOG.md +16 -0
  120. package/site/changelogs/packages/eslint-config/CHANGELOG.md +19 -0
  121. package/site/changelogs/packages/express/CHANGELOG.md +19 -0
  122. package/site/changelogs/packages/filter/CHANGELOG.md +27 -0
  123. package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +31 -0
  124. package/site/changelogs/packages/http-server/CHANGELOG.md +16 -0
  125. package/site/changelogs/packages/metadata/CHANGELOG.md +27 -0
  126. package/site/changelogs/packages/model-api-builder/CHANGELOG.md +19 -0
  127. package/site/changelogs/packages/monorepo/CHANGELOG.md +19 -0
  128. package/site/changelogs/packages/openapi-spec-builder/CHANGELOG.md +27 -0
  129. package/site/changelogs/packages/openapi-v3/CHANGELOG.md +19 -0
  130. package/site/changelogs/packages/repository/CHANGELOG.md +19 -0
  131. package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +19 -0
  132. package/site/changelogs/packages/repository-tests/CHANGELOG.md +19 -0
  133. package/site/changelogs/packages/rest/CHANGELOG.md +19 -0
  134. package/site/changelogs/packages/rest-crud/CHANGELOG.md +19 -0
  135. package/site/changelogs/packages/rest-explorer/CHANGELOG.md +19 -0
  136. package/site/changelogs/packages/security/CHANGELOG.md +19 -0
  137. package/site/changelogs/packages/service-proxy/CHANGELOG.md +19 -0
  138. package/site/changelogs/packages/testlab/CHANGELOG.md +19 -0
  139. package/site/changelogs/packages/tsdocs/CHANGELOG.md +27 -0
  140. package/site/readmes/loopback-next/extensions/sequelize/README.md +270 -0
package/CHANGELOG.md CHANGED
@@ -3,6 +3,35 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [5.2.1](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@5.2.0...@loopback/docs@5.2.1) (2023-04-13)
7
+
8
+
9
+ ### Bug Fixes
10
+
11
+ * **cli:** pass flags to mysql-connector while lb4 discover ([357d0c3](https://github.com/loopbackio/loopback-next/commit/357d0c3c1b0dae27b1b2fafa4a04c9e170d4cff2))
12
+ * refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
13
+
14
+
15
+
16
+
17
+
18
+ # [5.2.0](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@5.1.7...@loopback/docs@5.2.0) (2023-03-09)
19
+
20
+
21
+ ### Bug Fixes
22
+
23
+ * add @lerna/project to docs module ([edeab88](https://github.com/loopbackio/loopback-next/commit/edeab88d3562f367643504b8fbd4ba175c08ff33))
24
+
25
+
26
+ ### Features
27
+
28
+ * **cli:** specify models with --models in lb4 discover ([4f5f9cc](https://github.com/loopbackio/loopback-next/commit/4f5f9cc17ac0acfab17abfceaaaf3b9171d8066f))
29
+ * **sequelize:** add an extension for sequelize orm ([6256ed9](https://github.com/loopbackio/loopback-next/commit/6256ed903eb04af2fd78995d58eb623d878df845))
30
+
31
+
32
+
33
+
34
+
6
35
  ## [5.1.7](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@5.1.6...@loopback/docs@5.1.7) (2023-02-07)
7
36
 
8
37
  **Note:** Version bump only for package @loopback/docs
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@loopback/docs",
3
3
  "description": "Documentation files rendered at [https://loopback.io](https://loopback.io)",
4
- "version": "5.1.7",
4
+ "version": "5.2.1",
5
5
  "keywords": [
6
6
  "LoopBack",
7
7
  "docs"
@@ -32,11 +32,12 @@
32
32
  "site/"
33
33
  ],
34
34
  "dependencies": {
35
- "fs-extra": "^10.1.0",
35
+ "fs-extra": "^11.1.1",
36
36
  "tslib": "^2.5.0"
37
37
  },
38
38
  "devDependencies": {
39
- "@loopback/build": "^9.0.8"
39
+ "@lerna/project": "^6.4.1",
40
+ "@loopback/build": "^9.0.10"
40
41
  },
41
- "gitHead": "3025b353fa04f6918cd7b435ae7c5864ba2eb9f9"
42
+ "gitHead": "3a98ded2622420d0f09dbc3c0fe961c0234b097f"
42
43
  }
@@ -20,7 +20,7 @@ lb4 [app] [options] [<name>]
20
20
 
21
21
  `--description` : Description of the application.
22
22
 
23
- `--outDir` : Project root directory for the application.
23
+ `--outdir` : Project root directory for the application.
24
24
 
25
25
  `--eslint` : Add ESLint to LoopBack4 application project.
26
26
 
package/site/CHANGELOG.md CHANGED
@@ -55,6 +55,7 @@ permalink: /doc/en/lb4/changelog.index.html
55
55
  - [@loopback/logging](changelogs/extensions/logging/CHANGELOG.md)
56
56
  - [@loopback/metrics](changelogs/extensions/metrics/CHANGELOG.md)
57
57
  - [@loopback/pooling](changelogs/extensions/pooling/CHANGELOG.md)
58
+ - [@loopback/sequelize](changelogs/extensions/sequelize/CHANGELOG.md)
58
59
  - [@loopback/socketio](changelogs/extensions/socketio/CHANGELOG.md)
59
60
  - [@loopback/typeorm](changelogs/extensions/typeorm/CHANGELOG.md)
60
61
 
@@ -49,9 +49,17 @@ placed. Default is `src/models`
49
49
  `--schema`: Specify the schema which the datasource will find the models to
50
50
  discover
51
51
 
52
+ **`--models`**: Specify the models to be generated e.g:--models=table1,table2
53
+
52
54
  `--optionalId`: Specify if the Id property of generated models will be marked as
55
+
53
56
  not required
54
57
 
58
+ `--connectorDiscoveryOptions`: Pass the options to the connectors. For example:
59
+ Passing `--connectorDiscoveryOptions = '{"treatTINYINT1AsTinyInt":false}'` to
60
+ `loopback-mysql-connector` would make the connector treat `tinyint `as a
61
+ `boolean`.
62
+
55
63
  ### Interactive Prompts
56
64
 
57
65
  Based on the option, the tool may prompt you for:
package/site/MONOREPO.md CHANGED
@@ -54,6 +54,7 @@ one in the monorepo: `npm run update-monorepo-file`
54
54
  | [extensions/pooling](https://github.com/loopbackio/loopback-next/tree/master/extensions/pooling) | @loopback/pooling | Resource pooling service for LoopBack 4 |
55
55
  | [extensions/socketio](https://github.com/loopbackio/loopback-next/tree/master/extensions/socketio) | @loopback/socketio | LoopBack's WebSocket server based on socket.io |
56
56
  | [extensions/typeorm](https://github.com/loopbackio/loopback-next/tree/master/extensions/typeorm) | @loopback/typeorm | Adds support for TypeORM in LoopBack |
57
+ | [extensions/sequelize](https://github.com/loopbackio/loopback-next/tree/master/extensions/sequelize) | @loopback/sequelize | An extension that adds support for Sequelize to existing repositories. |
57
58
  | [fixtures/mock-oauth2-provider](https://github.com/loopbackio/loopback-next/tree/master/fixtures/mock-oauth2-provider) | @loopback/mock-oauth2-provider | An internal application to mock the OAuth2 authorization flow login with a social app like facebook, google etc |
58
59
  | [fixtures/tsdocs-monorepo](https://github.com/loopbackio/loopback-next/tree/master/fixtures/tsdocs-monorepo) | _(private)_ | A monorepo for tsdocs testing |
59
60
  | [packages/authentication](https://github.com/loopbackio/loopback-next/tree/master/packages/authentication) | @loopback/authentication | A LoopBack component for authentication support. |
@@ -50,6 +50,7 @@ permalink: /doc/en/lb4/apidocs.index.html
50
50
  | [@loopback/rest-explorer](./rest-explorer.md) | A LoopBack 4 component for adding a self-hosted REST API Explorer. |
51
51
  | [@loopback/rest-msgpack](./rest-msgpack.md) | |
52
52
  | [@loopback/security](./security.md) | Common types/interfaces for LoopBack 4 security including authentication and authorization. |
53
+ | [@loopback/sequelize](./sequelize.md) | |
53
54
  | [@loopback/service-proxy](./service-proxy.md) | A common set of interfaces for interacting with service oriented backends such as REST APIs, SOAP Web Services, and gRPC microservices. |
54
55
  | [@loopback/socketio](./socketio.md) | |
55
56
  | [@loopback/testlab](./testlab.md) | A collection of test utilities we use to write LoopBack tests. |
@@ -0,0 +1,23 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.default_loopback_sequelize_options'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.default_loopback_sequelize_options.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [DEFAULT\_LOOPBACK\_SEQUELIZE\_OPTIONS](./sequelize.default_loopback_sequelize_options.md)
13
+
14
+ ## DEFAULT\_LOOPBACK\_SEQUELIZE\_OPTIONS variable
15
+
16
+ Default options for the component
17
+
18
+ **Signature:**
19
+
20
+ ```typescript
21
+ DEFAULT_LOOPBACK_SEQUELIZE_OPTIONS: LoopbackSequelizeComponentOptions
22
+ ```
23
+
@@ -0,0 +1,31 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.loopbacksequelizecomponent._constructor_'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.loopbacksequelizecomponent._constructor_.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [LoopbackSequelizeComponent](./sequelize.loopbacksequelizecomponent.md) &gt; [(constructor)](./sequelize.loopbacksequelizecomponent._constructor_.md)
13
+
14
+ ## LoopbackSequelizeComponent.(constructor)
15
+
16
+ Constructs a new instance of the `LoopbackSequelizeComponent` class
17
+
18
+ **Signature:**
19
+
20
+ ```typescript
21
+ constructor(application: Application, options?: LoopbackSequelizeComponentOptions);
22
+ ```
23
+
24
+ ## Parameters
25
+
26
+ | Parameter | Type | Description |
27
+ | --- | --- | --- |
28
+ | application | [Application](./core.application.md) | |
29
+ | options | [LoopbackSequelizeComponentOptions](./sequelize.loopbacksequelizecomponentoptions.md) | _(Optional)_ |
30
+
31
+
@@ -0,0 +1,29 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.loopbacksequelizecomponent'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.loopbacksequelizecomponent.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [LoopbackSequelizeComponent](./sequelize.loopbacksequelizecomponent.md)
13
+
14
+ ## LoopbackSequelizeComponent class
15
+
16
+ **Signature:**
17
+
18
+ ```typescript
19
+ export declare class LoopbackSequelizeComponent implements Component
20
+ ```
21
+ **Implements:** [Component](./core.component.md)
22
+
23
+ ## Constructors
24
+
25
+ | Constructor | Modifiers | Description |
26
+ | --- | --- | --- |
27
+ | [(constructor)(application, options)](./sequelize.loopbacksequelizecomponent._constructor_.md) | | Constructs a new instance of the <code>LoopbackSequelizeComponent</code> class |
28
+
29
+
@@ -0,0 +1,21 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.loopbacksequelizecomponentbindings.component'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.loopbacksequelizecomponentbindings.component.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [LoopbackSequelizeComponentBindings](./sequelize.loopbacksequelizecomponentbindings.md) &gt; [COMPONENT](./sequelize.loopbacksequelizecomponentbindings.component.md)
13
+
14
+ ## LoopbackSequelizeComponentBindings.COMPONENT variable
15
+
16
+ **Signature:**
17
+
18
+ ```typescript
19
+ COMPONENT: BindingKey<LoopbackSequelizeComponent>
20
+ ```
21
+
@@ -0,0 +1,30 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.loopbacksequelizecomponentbindings'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.loopbacksequelizecomponentbindings.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [LoopbackSequelizeComponentBindings](./sequelize.loopbacksequelizecomponentbindings.md)
13
+
14
+ ## LoopbackSequelizeComponentBindings namespace
15
+
16
+ Binding keys used by this component.
17
+
18
+ **Signature:**
19
+
20
+ ```typescript
21
+ export declare namespace LoopbackSequelizeComponentBindings
22
+ ```
23
+
24
+ ## Variables
25
+
26
+ | Variable | Description |
27
+ | --- | --- |
28
+ | [COMPONENT](./sequelize.loopbacksequelizecomponentbindings.component.md) | |
29
+
30
+
@@ -0,0 +1,23 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.loopbacksequelizecomponentoptions'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.loopbacksequelizecomponentoptions.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [LoopbackSequelizeComponentOptions](./sequelize.loopbacksequelizecomponentoptions.md)
13
+
14
+ ## LoopbackSequelizeComponentOptions interface
15
+
16
+ Interface defining the component's options object
17
+
18
+ **Signature:**
19
+
20
+ ```typescript
21
+ export interface LoopbackSequelizeComponentOptions
22
+ ```
23
+
@@ -0,0 +1,50 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md)
13
+
14
+ ## sequelize package
15
+
16
+ [@loopback/sequelize](https://github.com/loopbackio/loopback-next/tree/master/extensions/sequelize)
17
+
18
+ ## Classes
19
+
20
+ | Class | Description |
21
+ | --- | --- |
22
+ | [LoopbackSequelizeComponent](./sequelize.loopbacksequelizecomponent.md) | |
23
+ | [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) | Sequelize implementation of CRUD repository to be used with default loopback entities and SequelizeDataSource for SQL Databases |
24
+ | [SequelizeDataSource](./sequelize.sequelizedatasource.md) | Sequelize DataSource Class |
25
+
26
+ ## Interfaces
27
+
28
+ | Interface | Description |
29
+ | --- | --- |
30
+ | [LoopbackSequelizeComponentOptions](./sequelize.loopbacksequelizecomponentoptions.md) | Interface defining the component's options object |
31
+
32
+ ## Namespaces
33
+
34
+ | Namespace | Description |
35
+ | --- | --- |
36
+ | [LoopbackSequelizeComponentBindings](./sequelize.loopbacksequelizecomponentbindings.md) | Binding keys used by this component. |
37
+
38
+ ## Variables
39
+
40
+ | Variable | Description |
41
+ | --- | --- |
42
+ | [DEFAULT\_LOOPBACK\_SEQUELIZE\_OPTIONS](./sequelize.default_loopback_sequelize_options.md) | Default options for the component |
43
+
44
+ ## Type Aliases
45
+
46
+ | Type Alias | Description |
47
+ | --- | --- |
48
+ | [SequelizeDataSourceConfig](./sequelize.sequelizedatasourceconfig.md) | |
49
+
50
+
@@ -0,0 +1,33 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.sequelizecrudrepository._constructor_'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.sequelizecrudrepository._constructor_.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [(constructor)](./sequelize.sequelizecrudrepository._constructor_.md)
13
+
14
+ ## SequelizeCrudRepository.(constructor)
15
+
16
+ Constructs a new instance of the `SequelizeCrudRepository` class
17
+
18
+ **Signature:**
19
+
20
+ ```typescript
21
+ constructor(entityClass: typeof Entity & {
22
+ prototype: T;
23
+ }, dataSource: SequelizeDataSource);
24
+ ```
25
+
26
+ ## Parameters
27
+
28
+ | Parameter | Type | Description |
29
+ | --- | --- | --- |
30
+ | entityClass | typeof [Entity](./repository.entity.md) &amp; { prototype: T; } | |
31
+ | dataSource | [SequelizeDataSource](./sequelize.sequelizedatasource.md) | |
32
+
33
+
@@ -0,0 +1,32 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.sequelizecrudrepository.begintransaction'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.sequelizecrudrepository.begintransaction.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [beginTransaction](./sequelize.sequelizecrudrepository.begintransaction.md)
13
+
14
+ ## SequelizeCrudRepository.beginTransaction() method
15
+
16
+ **Signature:**
17
+
18
+ ```typescript
19
+ beginTransaction(options?: TransactionOptions | TransactionOptions['isolationLevel']): Promise<Transaction>;
20
+ ```
21
+
22
+ ## Parameters
23
+
24
+ | Parameter | Type | Description |
25
+ | --- | --- | --- |
26
+ | options | TransactionOptions \| TransactionOptions\['isolationLevel'\] | _(Optional)_ |
27
+
28
+ **Returns:**
29
+
30
+ Promise&lt;Transaction&gt;
31
+
32
+
@@ -0,0 +1,36 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.sequelizecrudrepository.buildsequelizeattributefilter'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.sequelizecrudrepository.buildsequelizeattributefilter.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [buildSequelizeAttributeFilter](./sequelize.sequelizecrudrepository.buildsequelizeattributefilter.md)
13
+
14
+ ## SequelizeCrudRepository.buildSequelizeAttributeFilter() method
15
+
16
+ Get Sequelize `attributes` filter value from `fields` of loopback.
17
+
18
+ **Signature:**
19
+
20
+ ```typescript
21
+ protected buildSequelizeAttributeFilter(fields?: Fields): FindAttributeOptions | undefined;
22
+ ```
23
+
24
+ ## Parameters
25
+
26
+ | Parameter | Type | Description |
27
+ | --- | --- | --- |
28
+ | fields | [Fields](./filter.fields.md) | _(Optional)_ Loopback styles <code>fields</code> options. eg. <code>[&quot;name&quot;, &quot;age&quot;]</code>, <code>{ id: false }</code> |
29
+
30
+ **Returns:**
31
+
32
+ FindAttributeOptions \| undefined
33
+
34
+ Sequelize Compatible Object/Array based on the fields provided. eg. `{ "exclude": ["id"] }`
35
+
36
+
@@ -0,0 +1,39 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.sequelizecrudrepository.buildsequelizeincludefilter'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.sequelizecrudrepository.buildsequelizeincludefilter.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [buildSequelizeIncludeFilter](./sequelize.sequelizecrudrepository.buildsequelizeincludefilter.md)
13
+
14
+ ## SequelizeCrudRepository.buildSequelizeIncludeFilter() method
15
+
16
+ Build Sequelize compatible `include` filter
17
+
18
+ **Signature:**
19
+
20
+ ```typescript
21
+ protected buildSequelizeIncludeFilter(inclusionFilters?: Array<InclusionFilter & {
22
+ required?: boolean;
23
+ }>, sourceModel?: ModelStatic<Model<T>>): Includeable[];
24
+ ```
25
+
26
+ ## Parameters
27
+
28
+ | Parameter | Type | Description |
29
+ | --- | --- | --- |
30
+ | inclusionFilters | Array&lt;[InclusionFilter](./filter.inclusionfilter.md) &amp; { required?: boolean; }&gt; | _(Optional)_ loopback style <code>where</code> condition |
31
+ | sourceModel | ModelStatic&lt;Model&lt;T&gt;&gt; | _(Optional)_ sequelize model instance |
32
+
33
+ **Returns:**
34
+
35
+ Includeable\[\]
36
+
37
+ Sequelize compatible `Includeable` array
38
+
39
+
@@ -0,0 +1,36 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.sequelizecrudrepository.buildsequelizeorder'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.sequelizecrudrepository.buildsequelizeorder.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [buildSequelizeOrder](./sequelize.sequelizecrudrepository.buildsequelizeorder.md)
13
+
14
+ ## SequelizeCrudRepository.buildSequelizeOrder() method
15
+
16
+ Get Sequelize Order filter value from loopback style order value
17
+
18
+ **Signature:**
19
+
20
+ ```typescript
21
+ protected buildSequelizeOrder(order?: string[] | string): Order | undefined;
22
+ ```
23
+
24
+ ## Parameters
25
+
26
+ | Parameter | Type | Description |
27
+ | --- | --- | --- |
28
+ | order | string\[\] \| string | _(Optional)_ Sorting order in loopback style filter. eg. <code>title ASC</code>, <code>[&quot;id DESC&quot;, &quot;age ASC&quot;]</code> |
29
+
30
+ **Returns:**
31
+
32
+ Order \| undefined
33
+
34
+ Sequelize compatible order filter value
35
+
36
+
@@ -0,0 +1,36 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.sequelizecrudrepository.buildsequelizewhere'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.sequelizecrudrepository.buildsequelizewhere.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [buildSequelizeWhere](./sequelize.sequelizecrudrepository.buildsequelizewhere.md)
13
+
14
+ ## SequelizeCrudRepository.buildSequelizeWhere() method
15
+
16
+ Build Sequelize compatible where condition object
17
+
18
+ **Signature:**
19
+
20
+ ```typescript
21
+ protected buildSequelizeWhere<MT extends T>(where?: Where<MT>): WhereOptions<MT>;
22
+ ```
23
+
24
+ ## Parameters
25
+
26
+ | Parameter | Type | Description |
27
+ | --- | --- | --- |
28
+ | where | [Where](./filter.where.md)<!-- -->&lt;MT&gt; | _(Optional)_ loopback style <code>where</code> condition |
29
+
30
+ **Returns:**
31
+
32
+ WhereOptions&lt;MT&gt;
33
+
34
+ Sequelize compatible where options to be used in queries
35
+
36
+
@@ -0,0 +1,33 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.sequelizecrudrepository.count'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.sequelizecrudrepository.count.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [count](./sequelize.sequelizecrudrepository.count.md)
13
+
14
+ ## SequelizeCrudRepository.count() method
15
+
16
+ **Signature:**
17
+
18
+ ```typescript
19
+ count(where?: Where<T>, options?: AnyObject): Promise<Count>;
20
+ ```
21
+
22
+ ## Parameters
23
+
24
+ | Parameter | Type | Description |
25
+ | --- | --- | --- |
26
+ | where | [Where](./filter.where.md)<!-- -->&lt;T&gt; | _(Optional)_ |
27
+ | options | [AnyObject](./repository.anyobject.md) | _(Optional)_ |
28
+
29
+ **Returns:**
30
+
31
+ Promise&lt;[Count](./repository.count.md)<!-- -->&gt;
32
+
33
+
@@ -0,0 +1,33 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.sequelizecrudrepository.create'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.sequelizecrudrepository.create.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [create](./sequelize.sequelizecrudrepository.create.md)
13
+
14
+ ## SequelizeCrudRepository.create() method
15
+
16
+ **Signature:**
17
+
18
+ ```typescript
19
+ create(entity: DataObject<T>, options?: AnyObject): Promise<T>;
20
+ ```
21
+
22
+ ## Parameters
23
+
24
+ | Parameter | Type | Description |
25
+ | --- | --- | --- |
26
+ | entity | [DataObject](./repository.dataobject.md)<!-- -->&lt;T&gt; | |
27
+ | options | [AnyObject](./repository.anyobject.md) | _(Optional)_ |
28
+
29
+ **Returns:**
30
+
31
+ Promise&lt;T&gt;
32
+
33
+
@@ -0,0 +1,33 @@
1
+ ---
2
+ lang: en
3
+ title: 'API docs: sequelize.sequelizecrudrepository.createall'
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/extensions/sequelize
7
+ permalink: /doc/en/lb4/apidocs.sequelize.sequelizecrudrepository.createall.html
8
+ ---
9
+
10
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
11
+
12
+ [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [createAll](./sequelize.sequelizecrudrepository.createall.md)
13
+
14
+ ## SequelizeCrudRepository.createAll() method
15
+
16
+ **Signature:**
17
+
18
+ ```typescript
19
+ createAll(entities: DataObject<T>[], options?: AnyObject): Promise<T[]>;
20
+ ```
21
+
22
+ ## Parameters
23
+
24
+ | Parameter | Type | Description |
25
+ | --- | --- | --- |
26
+ | entities | [DataObject](./repository.dataobject.md)<!-- -->&lt;T&gt;\[\] | |
27
+ | options | [AnyObject](./repository.anyobject.md) | _(Optional)_ |
28
+
29
+ **Returns:**
30
+
31
+ Promise&lt;T\[\]&gt;
32
+
33
+