Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improves jsdocs for events #4019

Merged
merged 16 commits into from
Nov 8, 2024
Merged

Conversation

JohannesDoberer
Copy link
Contributor

No description provided.

Copy link
Contributor

@walmazacn walmazacn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix reported typos

@JohannesDoberer
Copy link
Contributor Author

omg! Thx 👍

Copy link
Contributor

@walmazacn walmazacn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍

container/src/constants/communication.ts Outdated Show resolved Hide resolved
container/src/constants/communication.ts Outdated Show resolved Hide resolved
container/src/constants/communication.ts Outdated Show resolved Hide resolved
container/src/constants/communication.ts Outdated Show resolved Hide resolved
container/src/constants/communication.ts Outdated Show resolved Hide resolved
*/
export const GET_CURRENT_ROUTE_REQUEST = 'get-current-route-request';

/**
* A message emitted from the micro frontend to report that the navigation is completed is sent
* Event fired when the micro frontend requests to report that the navigation is completed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Event fired when the micro frontend requests to report that the navigation is completed.
* Event fired to report that the micro frontend's navigation has completed.

*/
export const UPDATE_MODAL_PATH_DATA_REQUEST = 'update-modal-path-data-request';

/**
* A message emitted from the micro frontend when a request to check on the validity of a path is sent
* Event fired when the micro frontend requests to check on the validity of a path.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Event fired when the micro frontend requests to check on the validity of a path.
* Event fired to report that the micro frontend's navigation has completed.

*/
export const CHECK_PATH_EXISTS_REQUEST = 'check-path-exists-request';

/**
* A message emitted from the micro frontend when a request to set the 'dirty status' (eg: avoid closing if unsaved changes) is sent
* Event fired when the micro frontend requests to set the 'dirty status' (e.g. avoid closing if unsaved changes).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Event fired when the micro frontend requests to set the 'dirty status' (e.g. avoid closing if unsaved changes).
* Event fired when the micro frontend requests to set the 'dirty status' which, for example, avoids closing when there are any unsaved changes.

container/typings/constants/events.d.ts Show resolved Hide resolved
container/typings/constants/events.d.ts Outdated Show resolved Hide resolved
@JohannesDoberer JohannesDoberer merged commit 19768c5 into main Nov 8, 2024
12 checks passed
@JohannesDoberer JohannesDoberer deleted the fix-jsdocs-communication-ts branch November 8, 2024 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
container documentation documentation tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants