@stackoverfloweth/vue-compositions
Version:
A collection of reusable vue compositions.
19 lines (18 loc) • 1 kB
TypeScript
import { Ref, MaybeRef } from 'vue';
import { Action, SubscriptionOptions, UseSubscription } from '../useSubscription/types';
declare const voidAction: () => undefined;
type UseSubscriptionWithDependencies<T extends Action> = [
action: T,
args: Ref<Parameters<T> | null>,
options?: MaybeRef<SubscriptionOptions>
];
/**
* Similar to `useSubscription` but delays executing the action if args is null.
*
* This is useful for when you want to use a subscription but the arguments are not available yet (e.g. the result of a promise).
* A common use case is for chaining subscriptions so that the second subscription is only executed after the first one is done.
*
* @see [`useSubscription`](https://github.com/PrefectHQ/vue-compositions/tree/main/src/useSubscription#readme) for more details.
*/
export declare function useSubscriptionWithDependencies<T extends Action>(...[action, args, options]: UseSubscriptionWithDependencies<T>): UseSubscription<T | typeof voidAction>;
export {};