@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
498 lines (259 loc) • 19.9 kB
Markdown
---
lang: en
title: 'CHANGELOG - @loopback/tsdocs'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI, Node.js, TypeScript, OpenAPI, CHANGELOG
sidebar: lb4_sidebar
toc_level: 0
editurl: https://github.com/loopbackio/loopback-next/blob/master/packages/tsdocs/CHANGELOG.md
permalink: /doc/en/lb4/changelog.tsdocs.html
---
# Change Log
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
# [5.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@5.0.0...@loopback/tsdocs@5.1.0) (2023-06-28)
### Bug Fixes
* migrate Lerna to NPM Workspaces ([d5c4994](https://github.com/loopbackio/loopback-next/commit/d5c4994d28f1741427b427d99ca4df03936547e6))
### Features
* update dependency @types/node to ^16 ([2af42b7](https://github.com/loopbackio/loopback-next/commit/2af42b721c6dfc2df49bfcac1cbea478aba417ab))
# [5.0.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.10...@loopback/tsdocs@5.0.0) (2023-05-15)
### Features
* add support for node v20 ([e23cefa](https://github.com/loopbackio/loopback-next/commit/e23cefaf5cce3fb990cb09f4c94239d1979615b1))
* remove support for node v14 ([5425762](https://github.com/loopbackio/loopback-next/commit/5425762f1353869994acf081bcda4816e6a9c3b0))
* remove support for node v19 ([e26a2ac](https://github.com/loopbackio/loopback-next/commit/e26a2ac2e43245d09dfc9721ccfa41d830daccb8))
### BREAKING CHANGES
* End of life of Node v14
Signed-off-by: Francisco Buceta <frbuceta@gmail.com>
## [4.0.10](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.9...@loopback/tsdocs@4.0.10) (2023-04-13)
### Bug Fixes
* refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
## [4.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.8...@loopback/tsdocs@4.0.9) (2023-03-09)
**Note:** Version bump only for package @loopback/tsdocs
## [4.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.7...@loopback/tsdocs@4.0.8) (2023-02-07)
**Note:** Version bump only for package @loopback/tsdocs
## [4.0.7](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.6...@loopback/tsdocs@4.0.7) (2023-01-09)
**Note:** Version bump only for package @loopback/tsdocs
# Change Log
All notable changes to this project will be documented in this file. See
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
## [4.0.6](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.5...@loopback/tsdocs@4.0.6) (2022-12-14)
**Note:** Version bump only for package @loopback/tsdocs
# Change Log
All notable changes to this project will be documented in this file. See
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
## [4.0.5](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.4...@loopback/tsdocs@4.0.5) (2022-11-24)
**Note:** Version bump only for package @loopback/tsdocs
# Change Log
All notable changes to this project will be documented in this file. See
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
## [4.0.4](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.3...@loopback/tsdocs@4.0.4) (2022-10-13)
**Note:** Version bump only for package @loopback/tsdocs
## [4.0.3](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.2...@loopback/tsdocs@4.0.3) (2022-08-25)
**Note:** Version bump only for package @loopback/tsdocs
## [4.0.2](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.1...@loopback/tsdocs@4.0.2) (2022-07-14)
**Note:** Version bump only for package @loopback/tsdocs
## [4.0.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@4.0.0...@loopback/tsdocs@4.0.1) (2022-06-13)
**Note:** Version bump only for package @loopback/tsdocs
## [4.0.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@3.1.2...@loopback/tsdocs@4.0.0) (2022-05-05)
### ⚠ BREAKING CHANGES
- remove node v12 support
### Features
- add support for node v18
([ccb4c61](https://github.com/loopbackio/loopback-next/commit/ccb4c61307d94ab7bb07a19c547dfc4fa7d388a8))
- remove node v12 support
([5f66e5b](https://github.com/loopbackio/loopback-next/commit/5f66e5bd288ba806b3aa6550fc29c5009de8b60d))
## [3.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@3.1.1...@loopback/tsdocs@3.1.2) (2022-03-29)
**Note:** Version bump only for package @loopback/tsdocs
## [3.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@3.1.0...@loopback/tsdocs@3.1.1) (2022-02-28)
**Note:** Version bump only for package @loopback/tsdocs
# [3.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@3.0.1...@loopback/tsdocs@3.1.0) (2022-02-14)
### Features
- update @types/node to v12
([65a09a4](https://github.com/loopbackio/loopback-next/commit/65a09a406e4865f774f97b58af9e616733b8b255))
## [3.0.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@3.0.0...@loopback/tsdocs@3.0.1) (2022-01-11)
**Note:** Version bump only for package @loopback/tsdocs
# [3.0.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.6.4...@loopback/tsdocs@3.0.0) (2021-11-18)
### Features
- drop support for Node.js v10
([9bcbbb3](https://github.com/loopbackio/loopback-next/commit/9bcbbb358ec3eabc3033d4e7e1c22b524a7069b3))
- support Node.js v17
([8d86c03](https://github.com/loopbackio/loopback-next/commit/8d86c03cb7047e2b1f18d05870628ef5783e71b2))
- upgrade to TypeScript 4.5.2
([72ece91](https://github.com/loopbackio/loopback-next/commit/72ece91289ecfdfd8747bb9888ad75db73e8ff4b))
### BREAKING CHANGES
- drop support for Node.js v10
Co-authored-by: Francisco Buceta <frbuceta@gmail.com> Signed-off-by: Rifa
Achrinza <25147899+achrinza@users.noreply.github.com>
## [2.6.4](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.6.3...@loopback/tsdocs@2.6.4) (2021-10-18)
### Bug Fixes
- add missing dependency for tsdocs
([5c74926](https://github.com/loopbackio/loopback-next/commit/5c74926f7aa85835853d4db383c6170c237ed3ce))
## [2.6.3](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.6.2...@loopback/tsdocs@2.6.3) (2021-09-16)
**Note:** Version bump only for package @loopback/tsdocs
## [2.6.2](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.6.1...@loopback/tsdocs@2.6.2) (2021-07-15)
### Bug Fixes
- **tsdocs:** fix tests after repo move
([0899440](https://github.com/loopbackio/loopback-next/commit/08994403aa9a227a821427f91fcd52188b72cd2a))
## [2.6.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.6.0...@loopback/tsdocs@2.6.1) (2021-06-10)
**Note:** Version bump only for package @loopback/tsdocs
# [2.6.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.5.1...@loopback/tsdocs@2.6.0) (2021-05-03)
### Features
- support node v16
([ac99415](https://github.com/loopbackio/loopback-next/commit/ac994154543bde22b4482ba98813351656db1b55))
## [2.5.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.5.0...@loopback/tsdocs@2.5.1) (2021-04-06)
**Note:** Version bump only for package @loopback/tsdocs
# [2.5.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.4.1...@loopback/tsdocs@2.5.0) (2021-03-18)
### Bug Fixes
- use a named export with @lerna/\*
([d0f6a7d](https://github.com/loopbackio/loopback-next/commit/d0f6a7dac49a32d27ba3971ccb893da5396b36ee))
### Features
- update package-lock.json to v2 consistently
([dfc3fbd](https://github.com/loopbackio/loopback-next/commit/dfc3fbdae0c9ca9f34c64154a471bef22d5ac6b7))
- upgrade to TypeScript 4.2.x
([05930bc](https://github.com/loopbackio/loopback-next/commit/05930bc0cece3909dd66f75ad91eeaa2d365a480))
## [2.4.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.4.0...@loopback/tsdocs@2.4.1) (2021-02-09)
**Note:** Version bump only for package @loopback/tsdocs
# [2.4.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.3.6...@loopback/tsdocs@2.4.0) (2021-01-21)
### Features
- make @loopback/tsdocs public so that it can be used by other projects
([90d157f](https://github.com/loopbackio/loopback-next/commit/90d157f2762f8c61199ade35014bebc45e7a3d2f))
## [2.3.6](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.3.5...@loopback/tsdocs@2.3.6) (2020-12-07)
**Note:** Version bump only for package @loopback/tsdocs
## [2.3.5](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.3.4...@loopback/tsdocs@2.3.5) (2020-11-18)
**Note:** Version bump only for package @loopback/tsdocs
## [2.3.4](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.3.3...@loopback/tsdocs@2.3.4) (2020-11-05)
**Note:** Version bump only for package @loopback/tsdocs
## [2.3.3](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.3.2...@loopback/tsdocs@2.3.3) (2020-10-07)
**Note:** Version bump only for package @loopback/tsdocs
## [2.3.2](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.3.1...@loopback/tsdocs@2.3.2) (2020-09-17)
**Note:** Version bump only for package @loopback/tsdocs
## [2.3.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.3.0...@loopback/tsdocs@2.3.1) (2020-09-15)
**Note:** Version bump only for package @loopback/tsdocs
# [2.3.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.2.7...@loopback/tsdocs@2.3.0) (2020-08-27)
### Features
- **tsdocs:** suppress warnings from api-extractor
([2e91b26](https://github.com/loopbackio/loopback-next/commit/2e91b260df87ce1a3c87ac42f9c861ceb58153d6))
## [2.2.7](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.2.6...@loopback/tsdocs@2.2.7) (2020-08-19)
**Note:** Version bump only for package @loopback/tsdocs
## [2.2.6](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.2.5...@loopback/tsdocs@2.2.6) (2020-08-05)
**Note:** Version bump only for package @loopback/tsdocs
## [2.2.5](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.2.4...@loopback/tsdocs@2.2.5) (2020-07-20)
**Note:** Version bump only for package @loopback/tsdocs
## [2.2.4](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.2.3...@loopback/tsdocs@2.2.4) (2020-06-30)
**Note:** Version bump only for package @loopback/tsdocs
## [2.2.3](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.2.2...@loopback/tsdocs@2.2.3) (2020-06-23)
### Bug Fixes
- set node version to >=10.16 to support events.once
([e39da1c](https://github.com/loopbackio/loopback-next/commit/e39da1ca47728eafaf83c10ce35b09b03b6a4edc))
## [2.2.2](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.2.1...@loopback/tsdocs@2.2.2) (2020-06-11)
### Bug Fixes
- **docs:** improve keywords in frontmatter
([8852827](https://github.com/loopbackio/loopback-next/commit/8852827639c7edc694741cfc3bd1535333d59a05))
## [2.2.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.2.0...@loopback/tsdocs@2.2.1) (2020-05-28)
**Note:** Version bump only for package @loopback/tsdocs
# [2.2.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.1.4...@loopback/tsdocs@2.2.0) (2020-05-20)
### Features
- **tsdocs:** add ignoreErrors option for tsdocs extraction
([eca6322](https://github.com/loopbackio/loopback-next/commit/eca632257a0e754a939403345bcfa5ee604fb746))
## [2.1.4](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.1.2...@loopback/tsdocs@2.1.4) (2020-05-19)
**Note:** Version bump only for package @loopback/tsdocs
## [2.1.3](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.1.2...@loopback/tsdocs@2.1.3) (2020-05-07)
**Note:** Version bump only for package @loopback/tsdocs
## [2.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.1.1...@loopback/tsdocs@2.1.2) (2020-04-29)
**Note:** Version bump only for package @loopback/tsdocs
## [2.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.1.0...@loopback/tsdocs@2.1.1) (2020-04-23)
**Note:** Version bump only for package @loopback/tsdocs
# [2.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.0.4...@loopback/tsdocs@2.1.0) (2020-04-22)
### Features
- update package.json and .travis.yml for builds
([cb2b8e6](https://github.com/loopbackio/loopback-next/commit/cb2b8e6a18616dda7783c0193091039d4e608131))
## [2.0.4](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.0.3...@loopback/tsdocs@2.0.4) (2020-04-11)
**Note:** Version bump only for package @loopback/tsdocs
## [2.0.3](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.0.2...@loopback/tsdocs@2.0.3) (2020-04-08)
**Note:** Version bump only for package @loopback/tsdocs
## [2.0.2](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.0.1...@loopback/tsdocs@2.0.2) (2020-03-24)
**Note:** Version bump only for package @loopback/tsdocs
## [2.0.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@2.0.0...@loopback/tsdocs@2.0.1) (2020-03-17)
**Note:** Version bump only for package @loopback/tsdocs
# [2.0.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.4.1...@loopback/tsdocs@2.0.0) (2020-03-05)
### chore
- remove support for Node.js v8.x
([4281d9d](https://github.com/loopbackio/loopback-next/commit/4281d9df50f0715d32879e1442a90b643ec8f542))
### Features
- add `tslib` as dependency
([a6e0b4c](https://github.com/loopbackio/loopback-next/commit/a6e0b4ce7b862764167cefedee14c1115b25e0a4)),
closes [#4676](https://github.com/loopbackio/loopback-next/issues/4676)
### BREAKING CHANGES
- Node.js v8.x is now end of life. Please upgrade to version 10 and above. See
https://nodejs.org/en/about/releases.
## [1.4.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.4.0...@loopback/tsdocs@1.4.1) (2020-02-05)
**Note:** Version bump only for package @loopback/tsdocs
# [1.4.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.3.9...@loopback/tsdocs@1.4.0) (2020-01-27)
### Bug Fixes
- **tsdocs:** use unscoped package name as the key to locate the url
([9de1133](https://github.com/loopbackio/loopback-next/commit/9de1133ecdaaf7625ba3cf740567dc6190fa9a52))
### Features
- **tsdocs:** fix package url and add editurl to page metadata
([d69a068](https://github.com/loopbackio/loopback-next/commit/d69a0686097fdc8d5120686a4aa9c6fc21f10948))
## [1.3.9](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.3.8...@loopback/tsdocs@1.3.9) (2020-01-07)
**Note:** Version bump only for package @loopback/tsdocs
## [1.3.8](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.3.7...@loopback/tsdocs@1.3.8) (2019-12-09)
**Note:** Version bump only for package @loopback/tsdocs
## [1.3.7](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.3.6...@loopback/tsdocs@1.3.7) (2019-11-25)
**Note:** Version bump only for package @loopback/tsdocs
## [1.3.6](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.3.5...@loopback/tsdocs@1.3.6) (2019-11-12)
**Note:** Version bump only for package @loopback/tsdocs
## [1.3.5](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.3.4...@loopback/tsdocs@1.3.5) (2019-10-24)
**Note:** Version bump only for package @loopback/tsdocs
## [1.3.4](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.3.3...@loopback/tsdocs@1.3.4) (2019-10-07)
**Note:** Version bump only for package @loopback/tsdocs
## [1.3.3](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.3.2...@loopback/tsdocs@1.3.3) (2019-09-28)
**Note:** Version bump only for package @loopback/tsdocs
## [1.3.2](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.3.1...@loopback/tsdocs@1.3.2) (2019-09-27)
**Note:** Version bump only for package @loopback/tsdocs
## [1.3.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.3.0...@loopback/tsdocs@1.3.1) (2019-09-17)
**Note:** Version bump only for package @loopback/tsdocs
# [1.3.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.2.9...@loopback/tsdocs@1.3.0) (2019-09-06)
### Features
- **tsdocs:** use index.md generated by api-documenter@7.4.0
([4af4db1](https://github.com/loopbackio/loopback-next/commit/4af4db1))
## [1.2.9](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.2.8...@loopback/tsdocs@1.2.9) (2019-09-03)
**Note:** Version bump only for package @loopback/tsdocs
## [1.2.8](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.2.7...@loopback/tsdocs@1.2.8) (2019-08-19)
**Note:** Version bump only for package @loopback/tsdocs
## [1.2.7](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.2.6...@loopback/tsdocs@1.2.7) (2019-08-15)
**Note:** Version bump only for package @loopback/tsdocs
## [1.2.6](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.2.5...@loopback/tsdocs@1.2.6) (2019-07-31)
**Note:** Version bump only for package @loopback/tsdocs
## [1.2.5](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.2.4...@loopback/tsdocs@1.2.5) (2019-07-26)
### Bug Fixes
- **tsdocs:** use model.name as canonicalReference is removed
([43b346e](https://github.com/loopbackio/loopback-next/commit/43b346e))
## [1.2.4](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.2.3...@loopback/tsdocs@1.2.4) (2019-07-17)
**Note:** Version bump only for package @loopback/tsdocs
## [1.2.3](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.2.2...@loopback/tsdocs@1.2.3) (2019-06-28)
### Bug Fixes
- address violations of "no-floating-promises" rule
([0947531](https://github.com/loopbackio/loopback-next/commit/0947531))
## [1.2.2](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.2.1...@loopback/tsdocs@1.2.2) (2019-06-21)
**Note:** Version bump only for package @loopback/tsdocs
## [1.2.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.2.0...@loopback/tsdocs@1.2.1) (2019-06-20)
**Note:** Version bump only for package @loopback/tsdocs
# [1.2.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.1.1...@loopback/tsdocs@1.2.0) (2019-06-17)
### Bug Fixes
- **tsdocs:** escape constructor name to avoid Jekyll site generation issue
([d15c744](https://github.com/loopbackio/loopback-next/commit/d15c744))
### Features
- **tsdocs:** make it possible to run api-extractor on a package
([6eb5773](https://github.com/loopbackio/loopback-next/commit/6eb5773))
## [1.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.1.0...@loopback/tsdocs@1.1.1) (2019-06-06)
**Note:** Version bump only for package @loopback/tsdocs
# [1.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.0.1...@loopback/tsdocs@1.1.0) (2019-06-03)
### Features
- replace tslint with eslint
([44185a7](https://github.com/loopbackio/loopback-next/commit/44185a7))
## [1.0.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@1.0.0-2...@loopback/tsdocs@1.0.1) (2019-05-31)
**Note:** Version bump only for package @loopback/tsdocs
# 1.0.0-2 (2019-05-30)
### Features
- **tsdocs:** add integration with api-extractor/documenter
([c8d9572](https://github.com/loopbackio/loopback-next/commit/c8d9572))