Skip to content

Commit

Permalink
test(components): update jsdoc for installNewXPlugin()
Browse files Browse the repository at this point in the history
  • Loading branch information
victorcg88 committed Aug 7, 2024
1 parent a8998ba commit 5a5d2c5
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions packages/x-components/src/__tests__/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -181,15 +181,14 @@ function mergeStates<State extends Dictionary>(
}

/**
* Makes a clean installation of the {@link XPlugin} into the passed Vue object.
* This also resets the bus, and all the hardcoded dependencies of the XPlugin.
* Creates a new instance of the {@link XPlugin}. This also resets the bus.
*
* @param options - The options for installing the {@link XPlugin}. The
* {@link XComponentsAdapterDummy} is added by default.
* @param localVue - A clone of the Vue constructor to isolate tests.
* @param bus - The event bus to use.
* If not provided, one will be created.
* @returns An array containing the `xPlugin` singleton and the `localVue` and objects.
* @returns An array containing the `xPlugin` singleton and an object with
* the plugin install options.
*/
export function installNewXPlugin(
options: Partial<XPluginOptions> = {},
Expand Down

0 comments on commit 5a5d2c5

Please sign in to comment.