@sv-use/core
Version:
A collection of Svelte 5 utilities.
26 lines (25 loc) • 1.01 kB
TypeScript
import { type ConfigurableNavigator } from '../__internal__/configurable.js';
import type { MaybeGetter } from '../__internal__/types.js';
interface CreateVibrationOptions extends ConfigurableNavigator {
/**
* An array of values describes alternating periods in which the device is
* vibrating and not vibrating. Each value in the array is converted to an
* integer, then interpreted alternately as the number of milliseconds the
* device should vibrate and the number of milliseconds it should not be
* vibrating.
* @default []
*/
pattern?: MaybeGetter<VibratePattern>;
}
type CreateVibrationReturn = {
readonly isSupported: boolean;
vibrate: () => void;
stop: () => void;
};
/**
* Reactive vibrate.
* @param options Additional options to customize the behavior.
* @see https://svelte-librarian.github.io/sv-use/docs/core/create-vibration
*/
export declare function createVibration(options?: CreateVibrationOptions): CreateVibrationReturn;
export {};