nativescript-vibrate
Advanced tools
Comparing version 2.0.1 to 2.0.2
| { | ||
| "name": "nativescript-vibrate", | ||
| "version": "2.0.1", | ||
| "version": "2.0.2", | ||
| "description": "A vibrate NativeScript plugin for Android and iOS", | ||
@@ -26,3 +26,4 @@ "main": "vibrate", | ||
| "clean": "cd ../demo && rimraf hooks node_modules platforms && cd ../src && rimraf node_modules && npm run plugin.link", | ||
| "ci.tslint": "npm i && tslint '**/*.ts' --config '../tslint.json' --exclude '**/node_modules/**'" | ||
| "ci.tslint": "npm i && tslint '**/*.ts' --config '../tslint.json' --exclude '**/node_modules/**'", | ||
| "prepare": "node scripts/prepare.js" | ||
| }, | ||
@@ -42,15 +43,17 @@ "keywords": [ | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git://github.com/bazzite/nativescript-vibrate.git" | ||
| }, | ||
| "license": "MIT", | ||
| "homepage": "https://github.com/bazzite/nativescript-vibrate", | ||
| "homepage": "https://www.bazzite.com/docs/nativescript-vibrate", | ||
| "readmeFilename": "README.md", | ||
| "peerDependencies": { | ||
| "tns-core-modules": "^3.0.0" | ||
| }, | ||
| "devDependencies": { | ||
| "tns-core-modules": "^3.1.0", | ||
| "tns-platform-declarations": "^3.1.0", | ||
| "typescript": "~2.3.0", | ||
| "prompt": "^1.0.0", | ||
| "rimraf": "^2.5.0", | ||
| "tslint": "^5.0.0" | ||
| "semver": "^5.5.0", | ||
| "tns-core-modules": "^3.3.0", | ||
| "tns-platform-declarations": "^3.3.0", | ||
| "tslint": "^5.0.0", | ||
| "typescript": "~2.3.0" | ||
| }, | ||
@@ -57,0 +60,0 @@ "dependencies": {}, |
@@ -1,8 +0,6 @@ | ||
| [](https://github.com/bazzite/nativescript-vibrate) | ||
| [](https://www.codacy.com/app/bazzite/nativescript-vibrate?utm_source=github.com&utm_medium=referral&utm_content=bazzite/nativescript-vibrate&utm_campaign=badger) | ||
| [](https://ci.appveyor.com/project/juliomrqz/nativescript-vibrate) | ||
| [](https://travis-ci.org/bazzite/nativescript-vibrate) | ||
| [](https://david-dm.org/bazzite/nativescript-vibrate) | ||
| [](https://david-dm.org/bazzite/nativescript-vibrate) | ||
| [](https://raw.githubusercontent.com/bazzite/nativescript-vibrate/develop/LICENSE) | ||
| [](https://www.bazzite.com/docs/nativescript-vibrate?utm_source=github&utm_medium=readme&utm_campaign=nativescript-vibrate) | ||
| [](https://www.codacy.com/app/bazzite/nativescript-vibrate?utm_source=github.com&utm_medium=referral&utm_content=bazzite/nativescript-vibrate&utm_campaign=badger) | ||
| [](https://travis-ci.org/bazzite/nativescript-vibrate) | ||
| [](https://www.npmjs.com/package/nativescript-vibrate) | ||
| [](https://www.bazzite.com/docs/nativescript-vibrate/license?utm_source=github&utm_medium=readme&utm_campaign=nativescript-vibrate) | ||
@@ -13,2 +11,4 @@ # NativeScript Vibrate | ||
| *Read this in other languages: [English](README.md), [Español](README.es.md)* | ||
| ## Installation | ||
@@ -18,10 +18,8 @@ | ||
| ``` | ||
| ```bash | ||
| $ tns plugin add nativescript-vibrate | ||
| ``` | ||
| This command automatically installs the necessary files, as well as stores nativescript-texttospeech as a dependency in your project's package.json file. | ||
| This command automatically installs the necessary files, as well as stores **nativescript-vibrate** as a dependency in your project's **package.json** file. | ||
| Due to a current open issue with NativeScript, [#669](https://github.com/NativeScript/nativescript-cli/issues/669), the plugin needs to be added before adding any platforms with the `tns add platform` command. | ||
| ## Permissions | ||
@@ -37,3 +35,3 @@ | ||
| ## Usage | ||
| ## Example of use | ||
@@ -47,3 +45,3 @@ To use the vibrate module you must first `require()` it: | ||
| If you use Typescript, you can require it this way: | ||
| If you use Typescript, you can import it this way: | ||
@@ -62,2 +60,9 @@ ```typescript | ||
| If you prefer to use a vibration pattern, you could try: | ||
| ```js | ||
| // my-page.js | ||
| vibrator.vibrate([1000, 300, 500, 2000]); | ||
| ``` | ||
| ### Notes | ||
@@ -67,30 +72,45 @@ | ||
| There is no API to vibrate for a specific amount of time, so it will vibrate for the default no matter what (the duration is ignored). | ||
| There is no API to vibrate for a specific **amount of time** or **vibration pattern**, so it will vibrate for the default period of time no matter what. | ||
| ## API | ||
| ## Development setup | ||
| For easier development and debugging purposes continue with the following steps: | ||
| Only one method is available: `vibrate().` Below are all the supported properties you can play around. | ||
| 1. Open a command prompt/terminal, navigate to `src` folder and run `npm run demo.ios` or `npm run demo.android` to run the demo. | ||
| 2. Open another command prompt/terminal, navigate to `src` folder and run `npm run plugin.tscwatch` to watch for file changes in the plugin. | ||
| | Property | Default | Description | Android | iOS | | ||
| | :-: | :-: | :-: | :-: | :-: | | ||
| | time | 300 | The number of milliseconds to vibrate. It can be also an array of longs of times for which to turn the vibrator on or off. | ✔︎ | ✘ | | ||
| | repeat | -1 | The index into pattern at which to repeat, or -1 if you don't want to repeat. | ✔︎ | ✘ | | ||
| Now go and make a change to the plugin. It will be automatically applied to the demo project. | ||
| ## Documentation & Support | ||
| If you want extra details of how to configure and use this plugin, the full documentation is available at [https://www.bazzite.com/docs/nativescript-vibrate][documentation]. | ||
| ### Unittesting | ||
| Open `demo/app/tests/tests.js` and adjust its contents so the tests become meaningful in the context of the plugin and its features. | ||
| For questions and support, use the [Issues section][issues]. | ||
| You can read more about this topic [here](https://docs.nativescript.org/tooling/testing). | ||
| You may also want to [follow the company supporting this project on Twitter][twitter]. | ||
| Once you're ready to test the plugin's API go to `src` folder and execute one of these commands: | ||
| ### Commercial Support | ||
| ``` | ||
| npm run test.ios | ||
| npm run test.android | ||
| ``` | ||
| This project is sponsored by [Bazzite][bazzite-website]. If you require assistance on your project(s), please contact us at [https://www.bazzite.com/contact][contact-page]. | ||
| ### Clean plugin and demo files | ||
| ## Contributing | ||
| Sometimes you may need to wipe away the `node_modules` and `demo/platforms` folders to reinstall them fresh. | ||
| Please make sure to read the [Contributing Guide][contributing] before making a pull request. | ||
| 1. Run `npm run clean` to wipe those clean then you can can run `npm i` to install fresh dependencies. | ||
| ## Code of Conduct | ||
| Everyone participating in this project is expected to agree to abide by the [Code of Conduct][code-of-conduct]. | ||
| ## License | ||
| Code released under the [MIT License][license-page]. | ||
| [documentation]: https://www.bazzite.com/docs/nativescript-vibrate?utm_source=github&utm_medium=readme&utm_campaign=nativescript-vibrate | ||
| [contributing]: https://www.bazzite.com/docs/nativescript-vibrate/contributing?utm_source=github&utm_medium=readme&utm_campaign=nativescript-vibrate | ||
| [code-of-conduct]: https://www.bazzite.com/open-source/code-of-conduct?utm_source=github&utm_medium=readme&utm_campaign=nativescript-vibrate | ||
| [issues]: https://github.com/bazzite/nativescript-vibrate/issues | ||
| [twitter]: https://twitter.com/BazziteTech | ||
| [bazzite-website]: https://www.bazzite.com?utm_source=github&utm_medium=readme&utm_campaign=nativescript-vibrate | ||
| [contact-page]: https://www.bazzite.com/contact?utm_source=github&utm_medium=readme&utm_campaign=nativescript-vibrate | ||
| [license-page]: https://www.bazzite.com/docs/nativescript-vibrate/license?utm_source=github&utm_medium=readme&utm_campaign=nativescript-vibrate |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No website
QualityPackage does not have a website.
Found 1 instance in 1 package
Fixed alerts
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by15.76%
48377
- Dependency count
- decreased by-100%
0
- Number of lines in readme file
- increased by20.88%
110
- Number of low supply chain risk alerts
- decreased by-100%
0
Worsened metrics
- Dev dependency count
- increased by16.67%
7
- Lines of code
- decreased by-81.31%
100
- Number of low quality alerts
- increased byInfinity%
1
No dependency changes