Skip to content

Commit

Permalink
fix(use-debounce): missing release tag doc
Browse files Browse the repository at this point in the history
  • Loading branch information
joseacabaneros committed May 20, 2024
1 parent 8416b58 commit e35f3dc
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 1 deletion.
1 change: 1 addition & 0 deletions packages/x-components/src/composables/use-debounce.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { DebounceOptions } from '../utils/types';
* @param debounceTimeInMs - Time of debounce in ms.
* @param debounceOptions - The options for the debounce strategy.
* @returns Debounced function obtained from `fn` parameter.
* @public
*/
export function useDebounce<Params extends any[]>(
fn: (...args: Params) => void,
Expand Down
1 change: 0 additions & 1 deletion packages/x-components/src/composables/use-getter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import { useStore } from './use-store';
* @param module - The {@link XModuleName} of the getter.
* @param getters - List of getters names.
* @returns The requested getters from the module.
*
* @public
*/
export function useGetter<
Expand Down
6 changes: 6 additions & 0 deletions packages/x-components/src/composables/use-x-bus.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import { bus as xBus } from '../plugins/x-bus';
* by the `XPlugin` if it was not instantiated and uses the default `xBus` as fallback.
*
* @returns An object with the `on` and `emit` functions.
* @public
*/
export function useXBus(): UseXBusAPI {
const injectedLocation = inject<Ref<FeatureLocation> | FeatureLocation>('location', 'none');
Expand Down Expand Up @@ -87,6 +88,11 @@ interface PrivateExtendedVueComponent extends Vue {
xComponent?: Vue | undefined;
}

/**.
* UseXBus API interface
*
* @public
*/
export interface UseXBusAPI {
/* eslint-disable jsdoc/require-description-complete-sentence */
/** {@inheritDoc XBus.(on:1)} */
Expand Down

0 comments on commit e35f3dc

Please sign in to comment.