docs(react-module-event): add README and @packageDocumentation TSDoc#4618
docs(react-module-event): add README and @packageDocumentation TSDoc#4618odinr wants to merge 1 commit into
Conversation
Add README covering useEventHandler, useEventStream, EventConsumer, and EventProvider with examples. Add @packageDocumentation to src/index.ts. Closes equinor/fusion-core-tasks#877
|
github-actions
Bot
added
👾 React
📚 documentation
There was a problem hiding this comment.
Pull request overview
Adds consumer-facing documentation for the React Event module package (@equinor/fusion-framework-react-module-event) by introducing a package README and a @packageDocumentation block in the entrypoint. This improves discoverability and helps ensure the module is usable via docs/RAG.
Changes:
- Added
@packageDocumentationTSDoc topackages/react/modules/event/src/index.ts. - Added a new
README.mddescribing exports and providing examples foruseEventHandleranduseEventStream.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| packages/react/modules/event/src/index.ts | Adds package-level TSDoc describing the React hooks/context exports. |
| packages/react/modules/event/README.md | New package README with exports table, hook usage examples, and related-link reference. |
|
|
||
| ## Related | ||
|
|
||
| - [`@equinor/fusion-framework-module-event`](../../modules/event/README.md) — the underlying event module with full API documentation |
| **Signature:** | ||
|
|
||
| ```ts | ||
| function useEventStream<TKey>(key: TKey, operator?: OperatorFunction): Observable; |
| **Signature:** | ||
|
|
||
| ```ts | ||
| function useEventHandler(key: string, cb: FrameworkEventHandler): void; |
Coverage Report
File CoverageNo changed files found. |
Description
Add README and
@packageDocumentationTSDoc topackages/react/modules/event.What's included
useEventHandleranduseEventStreamwith examples@packageDocumentationblock insrc/index.tsCloses equinor/fusion-core-tasks#877