This is an automated email from the ASF dual-hosted git repository.
janpio pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cordova-plugin-vibration.git
The following commit(s) were added to refs/heads/master by this push:
new 73b96e4 feat: update typings (#78)
73b96e4 is described below
commit 73b96e482e7adb2e819ca45e4d384f379173ac96
Author: Tim Brust <[email protected]>
AuthorDate: Tue Feb 19 11:33:51 2019 +0100
feat: update typings (#78)
This is part of
[apache/cordova#39](https://github.com/apache/cordova/issues/39)
<!--
Please make sure the checklist boxes are all checked before submitting the
PR. The checklist is intended as a quick reference, for complete details please
see our Contributor Guidelines:
http://cordova.apache.org/contribute/contribute_guidelines.html
Thanks!
-->
### Platforms affected
n/a - development with TypeScript
### Motivation and Context
updates typings as discussed in
[apache/cordova#39](https://github.com/apache/cordova/issues/39)
### Description
Updates types to correctly use TSDoc format
### Testing
Manual testing via development in VSCode.
### Checklist
- [ ] I've run the tests to see all new and existing tests pass
- [ ] I added automated test coverage as appropriate for this change
- [ ] Commit is prefixed with `(platform)` if this change only applies to
one platform (e.g. `(android)`)
- [ ] If this Pull Request resolves an issue, I linked to the issue in the
text above (and used the correct [keyword to close issues using
keywords](https://help.github.com/articles/closing-issues-using-keywords/))
- [ ] I've updated the documentation if necessary
---
types/index.d.ts | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/types/index.d.ts b/types/index.d.ts
index 234224b..eadb6fc 100644
--- a/types/index.d.ts
+++ b/types/index.d.ts
@@ -8,13 +8,15 @@
interface Navigator {
/**
* Vibrates the device for the specified amount of time.
- * @param time Milliseconds to vibrate the device. 0 cancels the
vibration. Ignored on iOS.
+ *
+ * @param time - Milliseconds to vibrate the device. 0 cancels the
vibration. Ignored on iOS.
*/
vibrate(time: number): void;
/**
* Vibrates the device with a given pattern.
- * @param time Sequence of durations (in milliseconds) for which to turn
on or off the vibrator. Ignored on iOS.
+ *
+ * @param time - Sequence of durations (in milliseconds) for which to turn
on or off the vibrator. Ignored on iOS.
*/
vibrate(time: number[]): void;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
