docs(vibrate): modify docs

This commit is contained in:
Ibrahim Hadeed 2016-06-11 10:38:55 -04:00
parent c620e18491
commit f91cb04585

View File

@ -25,17 +25,18 @@ import {Plugin, Cordova} from './plugin';
@Plugin({
plugin: 'cordova-plugin-vibration',
pluginRef: 'navigator',
repo: 'https://github.com/apache/cordova-plugin-vibration'
repo: 'https://github.com/apache/cordova-plugin-vibration',
platforms: ['Android', 'iOS', 'Windows 8.1 Phone', 'Windows 8.1', 'Windows 10']
})
export class Vibration {
/**
* Vibrates the device for given amount of time.
* @param time {Number|Array<Number>} Milliseconds to vibrate the device. If passed an array of numbers, it will define a vibration pattern. Pass 0 to stop any vibration immediately.
* @param time {number|Array<number>} Milliseconds to vibrate the device. If passed an array of numbers, it will define a vibration pattern. Pass 0 to stop any vibration immediately.
*/
@Cordova({
sync: true
})
static vibrate(time: any) {}
static vibrate(time: number|Array<number>) {}
}