Skip to content

Commit

Permalink
refactor: enhance documentation for getApps method in Group interface
Browse files Browse the repository at this point in the history
  • Loading branch information
guidomodarelli committed Feb 17, 2025
1 parent a88d3a1 commit f44aec7
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions plugins/wazuh-core/public/services/application/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,14 @@ export interface Group<GroupId extends string> {

/**
* This method is used to retrieve the list of applications associated with
* the specific group. The `updater$` parameter is a subject that can be used
* to update or notify subscribers about changes to the list of applications.
* By calling this method, you can get the array of `App` objects that belong
* to the group, allowing you to access information about each application,
* such as its title, description, and configuration within the OpenSearch
* Dashboards framework.
* the specific group.
* @param {Subject<AppUpdater>} updater$ This parameter is a subject that can
* be used to update or notify subscribers about changes to the list of
* applications.
* @returns {App[]} By calling this method, you can get the array of `App`
* objects that belong to the group, allowing you to access information about
* each application, such as its title, description, and configuration within
* the OpenSearch Dashboards framework.
*/
getApps: (
applicationService: ApplicationService,
Expand Down

0 comments on commit f44aec7

Please sign in to comment.