vue-hooks-plus
Version:
Vue hooks library
27 lines (26 loc) • 599 B
TypeScript
import type { Ref } from "vue";
export interface UseBooleanActions {
/**
* Set state to `true`
* @returns void
*/
setTrue: () => void;
/**
* Set state to `false`
* @returns void
*/
setFalse: () => void;
/**
* Set state
* @param value boolean
* @returns void
*/
set: (value: boolean) => void;
/**
* Toggle state
* @returns void
*/
toggle: () => void;
}
export type UseBooleanResult = [Readonly<Ref<boolean>>, UseBooleanActions];
export default function useBoolean(defaultValue?: boolean): UseBooleanResult;