Skip to content
0

katanakit-js / useVibrate

Function: useVibrate() ​

ts
function useVibrate(pattern): boolean;

Defined in: src/infrastructure/sensors/sensors.service.ts:282

Triggers the device vibration motor with a given pattern.

Parameters ​

ParameterTypeDescription
patternnumber | number[]A single duration (ms) or an array of vibrate/pause durations.

Returns ​

boolean

true if vibration was triggered, false otherwise.

Example ​

ts
useVibrate(200);           // vibrate 200 ms
useVibrate([100, 50, 100]); // vibrate, pause, vibrate

Released under the MIT License.