Skip to content

Commit 05b100d

Browse files
authored
fix: updated typedoc config to support monorepos (#447)
## This PR - updated typedoc config to support monorepos ### Notes A recent update the Typedoc changed how `packages` work with the `entryPointStrategy`. The release notes can be found [here](https://github.com/TypeStrong/typedoc/releases/tag/v0.24.0). This is a temporary workaround because legacy support will be removed in 0.25.0, according to [the docs](https://typedoc.org/options/input/#entrypointstrategy). ### Follow-up Tasks Update the configuration to use a non legacy strategy. --------- Signed-off-by: Michael Beemer <[email protected]>
1 parent efa1a0d commit 05b100d

File tree

5 files changed

+15
-13
lines changed

5 files changed

+15
-13
lines changed

package-lock.json

Lines changed: 8 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
"shx": "^0.3.4",
6565
"ts-jest": "^29.0.5",
6666
"ts-node": "^10.8.2",
67-
"typedoc": "^0.24.0",
67+
"typedoc": "^0.24.8",
6868
"typescript": "^4.7.4",
6969
"uuid": "^9.0.0"
7070
},

packages/client/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,8 @@ client.addHandler(ProviderEvents.Error, async (eventDetails) => {
221221
222222
### Shutdown:
223223
224-
The OpenFeature API provides a close function to perform a cleanup of all providers attached to any client.
224+
The OpenFeature API provides a close function to perform a cleanup of all registered providers.
225+
This should only be called when your application is in the process of shutting down.
225226
226227
```typescript
227228
import { OpenFeature, ProviderEvents } from '@openfeature/web-sdk';

packages/server/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,8 @@ client.addHandler(ProviderEvents.Error, async (eventDetails) => {
210210
211211
### Shutdown:
212212
213-
The OpenFeature API provides a close function to perform a cleanup of all providers attached to any client.
213+
The OpenFeature API provides a close function to perform a cleanup of all registered providers.
214+
This should only be called when your application is in the process of shutting down.
214215
215216
```typescript
216217
import { OpenFeature, ProviderEvents } from '@openfeature/web-sdk';

typedoc.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"entryPointStrategy": "packages",
2+
"$schema": "https://typedoc.org/schema.json",
3+
"entryPointStrategy": "legacy-packages",
34
"entryPoints": [
4-
"packages/shared",
55
"packages/server",
66
"packages/client"
77
],

0 commit comments

Comments
 (0)