Skip to main content

@rtorcato/browser-common / vibrate

vibrate

Functions​

isVibrationApiAvailable()​

isVibrationApiAvailable(): boolean

Defined in: vibrate/index.ts:10

Checks if the Vibration API is available in the browser.

Returns​

boolean

Example​

import { isVibrationApiAvailable } from '@rtorcato/browser-common/vibrate'
if (isVibrationApiAvailable()) buzz()

vibrate()​

vibrate(pattern): boolean

Defined in: vibrate/index.ts:24

Vibrates the device for the given pattern (if supported).

Parameters​

pattern​

number | number[]

A single duration (ms) or an array of durations (vibrate, pause, vibrate, ...).

Returns​

boolean

True if vibration was triggered, false otherwise.

Example​

import { vibrate } from '@rtorcato/browser-common/vibrate'
vibrate([200, 100, 200])

stopVibration()​

stopVibration(): boolean

Defined in: vibrate/index.ts:40

Stops any ongoing vibration (if supported).

Returns​

boolean

True if vibration was stopped, false otherwise.

Example​

import { stopVibration } from '@rtorcato/browser-common/vibrate'
stopVibration()

vibratePulse()​

vibratePulse(duration?): boolean

Defined in: vibrate/index.ts:54

Vibrates the device with a short pulse (default 200ms).

Parameters​

duration?​

number = 200

Duration in ms (default: 200).

Returns​

boolean

Example​

import { vibratePulse } from '@rtorcato/browser-common/vibrate'
vibratePulse(300)

vibrateNotification()​

vibrateNotification(): boolean

Defined in: vibrate/index.ts:67

Vibrates the device with a custom pattern for a notification effect.

Returns​

boolean

Example​

import { vibrateNotification } from '@rtorcato/browser-common/vibrate'
vibrateNotification()