diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 00000000..11cf83f6 --- /dev/null +++ b/.eslintrc @@ -0,0 +1,13 @@ +{ + "parser": "@typescript-eslint/parser", + "plugins": ["@typescript-eslint", "jsdoc"], + "extends": ["plugin:@typescript-eslint/recommended", "prettier", "plugin:jsdoc/recommended"], + "rules": { + "@typescript-eslint/no-unused-vars": ["off"], + "@typescript-eslint/no-explicit-any": ["warn"], + "@typescript-eslint/no-empty-function": ["off"], + "@typescript-eslint/ban-types": ["warn"], + "@typescript-eslint/no-empty-interface": ["warn"], + "@typescript-eslint/no-namespace": ["off"] + } +} diff --git a/gulpfile.js b/gulpfile.js index 654d5c01..d5e4ab29 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -3,7 +3,7 @@ const gulp = require('gulp'), minimist = require('minimist'), rename = require('gulp-rename'), - tslint = require('gulp-tslint'), + eslint = require('gulp-eslint'), replace = require('gulp-replace'), _ = require('lodash'); @@ -18,18 +18,6 @@ const flagConfig = { /* Docs tasks */ require('./scripts/docs/gulp-tasks')(gulp, flags); -gulp.task('lint', () => { - return gulp - .src('src/**/*.ts') - .pipe( - tslint({ - formatter: 'verbose', - configuration: 'tslint.json', - }) - ) - .pipe(tslint.report()); -}); - gulp.task('plugin:create', () => { if (flags.n && flags.n !== '') { const src = flags.m ? './scripts/templates/wrap-min.tmpl' : './scripts/templates/wrap.tmpl', diff --git a/package-lock.json b/package-lock.json index 2bd902f9..5af4ec7c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -23,16 +23,19 @@ "@types/node": "^16.9.1", "@types/rimraf": "^3.0.2", "@types/webpack": "^5.28.0", + "@typescript-eslint/eslint-plugin": "^4.32.0", + "@typescript-eslint/parser": "^4.32.0", "async-promise-queue": "^1.0.5", "conventional-changelog-cli": "^2.1.1", "cz-conventional-changelog": "^3.3.0", "dgeni": "^0.4.14", "dgeni-packages": "0.16.10", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-jsdoc": "^36.1.0", "fs-extra": "^10.0.0", "gulp": "^4.0.2", "gulp-rename": "^2.0.0", "gulp-replace": "^1.1.3", - "gulp-tslint": "^8.1.4", "husky": "^7.0.1", "is-ci": "^3.0.0", "jest": "^27.0.6", @@ -46,12 +49,8 @@ "terser-webpack-plugin": "^5.2.4", "ts-jest": "^27.0.5", "ts-node": "^10.2.1", - "tslint": "~6.1.0", - "tslint-config-prettier": "^1.18.0", - "tslint-ionic-rules": "0.0.21", "typedoc": "^0.22.4", - "typescript": "4.1.6", - "typescript-tslint-plugin": "^1.0.1", + "typescript": "^4.1.6", "unminified-webpack-plugin": "^3.0.0", "webpack": "^5.51.1", "winston": "^3.3.3", @@ -915,6 +914,153 @@ "kuler": "^2.0.0" } }, + "node_modules/@es-joy/jsdoccomment": { + "version": "0.10.8", + "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.10.8.tgz", + "integrity": "sha512-3P1JiGL4xaR9PoTKUHa2N/LKwa2/eUdRqGwijMWWgBqbFEqJUVpmaOi2TcjcemrsRMgFLBzQCK4ToPhrSVDiFQ==", + "dev": true, + "dependencies": { + "comment-parser": "1.2.4", + "esquery": "^1.4.0", + "jsdoc-type-pratt-parser": "1.1.1" + }, + "engines": { + "node": "^12 || ^14 || ^16" + } + }, + "node_modules/@eslint/eslintrc": { + "version": "0.4.3", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.3.tgz", + "integrity": "sha512-J6KFFz5QCYUJq3pf0mjEcCJVERbzv71PUIDczuh9JkwGEzced6CO5ADLHB1rbf/+oPBtoPfMYNOpGDzCANlbXw==", + "dev": true, + "peer": true, + "dependencies": { + "ajv": "^6.12.4", + "debug": "^4.1.1", + "espree": "^7.3.0", + "globals": "^13.9.0", + "ignore": "^4.0.6", + "import-fresh": "^3.2.1", + "js-yaml": "^3.13.1", + "minimatch": "^3.0.4", + "strip-json-comments": "^3.1.1" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/@eslint/eslintrc/node_modules/acorn": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", + "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", + "dev": true, + "peer": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/@eslint/eslintrc/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "peer": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/@eslint/eslintrc/node_modules/espree": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-7.3.1.tgz", + "integrity": "sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g==", + "dev": true, + "peer": true, + "dependencies": { + "acorn": "^7.4.0", + "acorn-jsx": "^5.3.1", + "eslint-visitor-keys": "^1.3.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/@eslint/eslintrc/node_modules/globals": { + "version": "13.11.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.11.0.tgz", + "integrity": "sha512-08/xrJ7wQjK9kkkRoI3OFUBbLx4f+6x3SGwcPvQ0QH6goFDrOU2oyAWrmh3dJezu65buo+HBMzAMQy6rovVC3g==", + "dev": true, + "peer": true, + "dependencies": { + "type-fest": "^0.20.2" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@eslint/eslintrc/node_modules/ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true, + "peer": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/@eslint/eslintrc/node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "peer": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@eslint/eslintrc/node_modules/type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true, + "peer": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/@humanwhocodes/config-array": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.5.0.tgz", + "integrity": "sha512-FagtKFz74XrTl7y6HCzQpwDfXP0yhxe9lHLD1UZxjvZIcbyRz8zTFF/yYNfSfzU414eDwZ1SrO0Qvtyf+wFMQg==", + "dev": true, + "peer": true, + "dependencies": { + "@humanwhocodes/object-schema": "^1.2.0", + "debug": "^4.1.1", + "minimatch": "^3.0.4" + }, + "engines": { + "node": ">=10.10.0" + } + }, + "node_modules/@humanwhocodes/object-schema": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-1.2.0.tgz", + "integrity": "sha512-wdppn25U8z/2yiaT6YGquE6X8sSv7hNMWSXYSSU1jGv/yd6XqjXgTDJ8KP4NgjTXfJ3GbRjeeb8RTV7a/VpM+w==", + "dev": true, + "peer": true + }, "node_modules/@hutson/parse-repository-url": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/@hutson/parse-repository-url/-/parse-repository-url-3.0.2.tgz", @@ -1578,6 +1724,41 @@ "node": ">=8" } }, + "node_modules/@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, + "dependencies": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + }, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, + "node_modules/@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, + "dependencies": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + }, + "engines": { + "node": ">= 8" + } + }, "node_modules/@sinonjs/commons": { "version": "1.8.3", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", @@ -1708,12 +1889,6 @@ "integrity": "sha512-Q5Vn3yjTDyCMV50TB6VRIbQNxSE4OmZR86VSbGaNpfUolm0iePBB4KdEEHmxoY5sT2+2DIvXW0rvMDP2nHZ4Mg==", "dev": true }, - "node_modules/@types/fancy-log": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/@types/fancy-log/-/fancy-log-1.3.0.tgz", - "integrity": "sha512-mQjDxyOM1Cpocd+vm1kZBP7smwKZ4TNokFeds9LV7OZibmPJFEzY3+xZMrKfUdNT71lv8GoCPD6upKwHxubClw==", - "dev": true - }, "node_modules/@types/fs-extra": { "version": "9.0.13", "resolved": "https://registry.npmjs.org/@types/fs-extra/-/fs-extra-9.0.13.tgz", @@ -1876,6 +2051,193 @@ "integrity": "sha512-7tFImggNeNBVMsn0vLrpn1H1uPrUBdnARPTpZoitY37ZrdJREzf7I16tMrlK3hen349gr1NYh8CmZQa7CTG6Aw==", "dev": true }, + "node_modules/@typescript-eslint/eslint-plugin": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.32.0.tgz", + "integrity": "sha512-+OWTuWRSbWI1KDK8iEyG/6uK2rTm3kpS38wuVifGUTDB6kjEuNrzBI1MUtxnkneuWG/23QehABe2zHHrj+4yuA==", + "dev": true, + "dependencies": { + "@typescript-eslint/experimental-utils": "4.32.0", + "@typescript-eslint/scope-manager": "4.32.0", + "debug": "^4.3.1", + "functional-red-black-tree": "^1.0.1", + "ignore": "^5.1.8", + "regexpp": "^3.1.0", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "@typescript-eslint/parser": "^4.0.0", + "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/eslint-plugin/node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@typescript-eslint/experimental-utils": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.32.0.tgz", + "integrity": "sha512-WLoXcc+cQufxRYjTWr4kFt0DyEv6hDgSaFqYhIzQZ05cF+kXfqXdUh+//kgquPJVUBbL3oQGKQxwPbLxHRqm6A==", + "dev": true, + "dependencies": { + "@types/json-schema": "^7.0.7", + "@typescript-eslint/scope-manager": "4.32.0", + "@typescript-eslint/types": "4.32.0", + "@typescript-eslint/typescript-estree": "4.32.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^3.0.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "*" + } + }, + "node_modules/@typescript-eslint/parser": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.32.0.tgz", + "integrity": "sha512-lhtYqQ2iEPV5JqV7K+uOVlPePjClj4dOw7K4/Z1F2yvjIUvyr13yJnDzkK6uon4BjHYuHy3EG0c2Z9jEhFk56w==", + "dev": true, + "dependencies": { + "@typescript-eslint/scope-manager": "4.32.0", + "@typescript-eslint/types": "4.32.0", + "@typescript-eslint/typescript-estree": "4.32.0", + "debug": "^4.3.1" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependencies": { + "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/scope-manager": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.32.0.tgz", + "integrity": "sha512-DK+fMSHdM216C0OM/KR1lHXjP1CNtVIhJ54kQxfOE6x8UGFAjha8cXgDMBEIYS2XCYjjCtvTkjQYwL3uvGOo0w==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "4.32.0", + "@typescript-eslint/visitor-keys": "4.32.0" + }, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/types": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.32.0.tgz", + "integrity": "sha512-LE7Z7BAv0E2UvqzogssGf1x7GPpUalgG07nGCBYb1oK4mFsOiFC/VrSMKbZQzFJdN2JL5XYmsx7C7FX9p9ns0w==", + "dev": true, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, + "node_modules/@typescript-eslint/typescript-estree": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.32.0.tgz", + "integrity": "sha512-tRYCgJ3g1UjMw1cGG8Yn1KzOzNlQ6u1h9AmEtPhb5V5a1TmiHWcRyF/Ic+91M4f43QeChyYlVTcf3DvDTZR9vw==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "4.32.0", + "@typescript-eslint/visitor-keys": "4.32.0", + "debug": "^4.3.1", + "globby": "^11.0.3", + "is-glob": "^4.0.1", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/@typescript-eslint/typescript-estree/node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@typescript-eslint/visitor-keys": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.32.0.tgz", + "integrity": "sha512-e7NE0qz8W+atzv3Cy9qaQ7BTLwWsm084Z0c4nIO2l3Bp6u9WIgdqCgyPyV5oSPDMIW3b20H59OOCmVk3jw3Ptw==", + "dev": true, + "dependencies": { + "@typescript-eslint/types": "4.32.0", + "eslint-visitor-keys": "^2.0.0" + }, + "engines": { + "node": "^8.10.0 || ^10.13.0 || >=11.10.1" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/typescript-eslint" + } + }, "node_modules/@webassemblyjs/ast": { "version": "1.11.1", "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.11.1.tgz", @@ -2083,6 +2445,16 @@ "acorn": "^8" } }, + "node_modules/acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "dev": true, + "peer": true, + "peerDependencies": { + "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" + } + }, "node_modules/acorn-walk": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-7.2.0.tgz", @@ -2389,6 +2761,15 @@ "node": ">=0.10.0" } }, + "node_modules/array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/array-unique": { "version": "0.3.2", "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.3.2.tgz", @@ -2899,15 +3280,6 @@ "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", "dev": true }, - "node_modules/builtin-modules": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-1.1.1.tgz", - "integrity": "sha1-Jw8HbFpywC9bZaR9+Uxf46J4iS8=", - "dev": true, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/cache-base": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/cache-base/-/cache-base-1.0.1.tgz", @@ -3427,6 +3799,15 @@ "node": ">= 10" } }, + "node_modules/comment-parser": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.2.4.tgz", + "integrity": "sha512-pm0b+qv+CkWNriSTMsfnjChF9kH0kxz55y44Wo5le9qLxMj5xDQAaEd9ZN1ovSuk9CsrncWaFwgpOMg7ClJwkw==", + "dev": true, + "engines": { + "node": ">= 12.0.0" + } + }, "node_modules/commitizen": { "version": "4.2.4", "resolved": "https://registry.npmjs.org/commitizen/-/commitizen-4.2.4.tgz", @@ -4289,34 +4670,31 @@ "node": "^10.13.0 || ^12.13.0 || ^14.15.0 || >=15.0.0" } }, - "node_modules/doctrine": { - "version": "0.7.2", - "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-0.7.2.tgz", - "integrity": "sha1-fLhgNZujvpDgQLJrcpzkv6ZUxSM=", + "node_modules/dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", "dev": true, "dependencies": { - "esutils": "^1.1.6", - "isarray": "0.0.1" + "path-type": "^4.0.0" }, "engines": { - "node": ">=0.10.0" + "node": ">=8" } }, - "node_modules/doctrine/node_modules/esutils": { - "version": "1.1.6", - "resolved": "https://registry.npmjs.org/esutils/-/esutils-1.1.6.tgz", - "integrity": "sha1-wBzKqa5LiXxtDD4hCuUvPHqEQ3U=", + "node_modules/doctrine": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", + "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", "dev": true, + "peer": true, + "dependencies": { + "esutils": "^2.0.2" + }, "engines": { - "node": ">=0.10.0" + "node": ">=6.0.0" } }, - "node_modules/doctrine/node_modules/isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", - "dev": true - }, "node_modules/dom-serializer": { "version": "0.2.2", "resolved": "https://registry.npmjs.org/dom-serializer/-/dom-serializer-0.2.2.tgz", @@ -4636,6 +5014,114 @@ "node": ">=4.0" } }, + "node_modules/eslint": { + "version": "7.32.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.32.0.tgz", + "integrity": "sha512-VHZ8gX+EDfz+97jGcgyGCyRia/dPOd6Xh9yPv8Bl1+SoaIwD+a/vlrOmGRUyOYu7MwUhc7CxqeaDZU13S4+EpA==", + "dev": true, + "peer": true, + "dependencies": { + "@babel/code-frame": "7.12.11", + "@eslint/eslintrc": "^0.4.3", + "@humanwhocodes/config-array": "^0.5.0", + "ajv": "^6.10.0", + "chalk": "^4.0.0", + "cross-spawn": "^7.0.2", + "debug": "^4.0.1", + "doctrine": "^3.0.0", + "enquirer": "^2.3.5", + "escape-string-regexp": "^4.0.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^2.1.0", + "eslint-visitor-keys": "^2.0.0", + "espree": "^7.3.1", + "esquery": "^1.4.0", + "esutils": "^2.0.2", + "fast-deep-equal": "^3.1.3", + "file-entry-cache": "^6.0.1", + "functional-red-black-tree": "^1.0.1", + "glob-parent": "^5.1.2", + "globals": "^13.6.0", + "ignore": "^4.0.6", + "import-fresh": "^3.0.0", + "imurmurhash": "^0.1.4", + "is-glob": "^4.0.0", + "js-yaml": "^3.13.1", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.4.1", + "lodash.merge": "^4.6.2", + "minimatch": "^3.0.4", + "natural-compare": "^1.4.0", + "optionator": "^0.9.1", + "progress": "^2.0.0", + "regexpp": "^3.1.0", + "semver": "^7.2.1", + "strip-ansi": "^6.0.0", + "strip-json-comments": "^3.1.0", + "table": "^6.0.9", + "text-table": "^0.2.0", + "v8-compile-cache": "^2.0.3" + }, + "bin": { + "eslint": "bin/eslint.js" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + }, + "funding": { + "url": "https://opencollective.com/eslint" + } + }, + "node_modules/eslint-config-prettier": { + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/eslint-config-prettier/-/eslint-config-prettier-8.3.0.tgz", + "integrity": "sha512-BgZuLUSeKzvlL/VUjx/Yb787VQ26RU3gGjA3iiFvdsp/2bMfVIWUVP7tjxtjS0e+HP409cPlPvNkQloz8C91ew==", + "dev": true, + "bin": { + "eslint-config-prettier": "bin/cli.js" + }, + "peerDependencies": { + "eslint": ">=7.0.0" + } + }, + "node_modules/eslint-plugin-jsdoc": { + "version": "36.1.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-36.1.0.tgz", + "integrity": "sha512-Qpied2AJCQcScxfzTObLKRiP5QgLXjMU/ITjBagEV5p2Q/HpumD1EQtazdRYdjDSwPmXhwOl2yquwOGQ4HOJNw==", + "dev": true, + "dependencies": { + "@es-joy/jsdoccomment": "0.10.8", + "comment-parser": "1.2.4", + "debug": "^4.3.2", + "esquery": "^1.4.0", + "jsdoc-type-pratt-parser": "^1.1.1", + "lodash": "^4.17.21", + "regextras": "^0.8.0", + "semver": "^7.3.5", + "spdx-expression-parse": "^3.0.1" + }, + "engines": { + "node": "^12 || ^14 || ^16" + }, + "peerDependencies": { + "eslint": "^6.0.0 || ^7.0.0" + } + }, + "node_modules/eslint-plugin-jsdoc/node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/eslint-scope": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", @@ -4649,6 +5135,332 @@ "node": ">=8.0.0" } }, + "node_modules/eslint-utils": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", + "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", + "dev": true, + "dependencies": { + "eslint-visitor-keys": "^2.0.0" + }, + "engines": { + "node": "^10.0.0 || ^12.0.0 || >= 14.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + }, + "peerDependencies": { + "eslint": ">=5" + } + }, + "node_modules/eslint-visitor-keys": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", + "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/eslint/node_modules/@babel/code-frame": { + "version": "7.12.11", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.12.11.tgz", + "integrity": "sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw==", + "dev": true, + "peer": true, + "dependencies": { + "@babel/highlight": "^7.10.4" + } + }, + "node_modules/eslint/node_modules/acorn": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", + "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", + "dev": true, + "peer": true, + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/eslint/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "peer": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/eslint/node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "peer": true, + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/eslint/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "peer": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/eslint/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "peer": true + }, + "node_modules/eslint/node_modules/escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "dev": true, + "peer": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint/node_modules/eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "peer": true, + "dependencies": { + "eslint-visitor-keys": "^1.1.0" + }, + "engines": { + "node": ">=6" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/eslint/node_modules/eslint-utils/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "peer": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint/node_modules/espree": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-7.3.1.tgz", + "integrity": "sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g==", + "dev": true, + "peer": true, + "dependencies": { + "acorn": "^7.4.0", + "acorn-jsx": "^5.3.1", + "eslint-visitor-keys": "^1.3.0" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/eslint/node_modules/espree/node_modules/eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "peer": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/eslint/node_modules/globals": { + "version": "13.11.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.11.0.tgz", + "integrity": "sha512-08/xrJ7wQjK9kkkRoI3OFUBbLx4f+6x3SGwcPvQ0QH6goFDrOU2oyAWrmh3dJezu65buo+HBMzAMQy6rovVC3g==", + "dev": true, + "peer": true, + "dependencies": { + "type-fest": "^0.20.2" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "peer": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/eslint/node_modules/ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true, + "peer": true, + "engines": { + "node": ">= 4" + } + }, + "node_modules/eslint/node_modules/levn": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "dev": true, + "peer": true, + "dependencies": { + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/eslint/node_modules/optionator": { + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", + "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==", + "dev": true, + "peer": true, + "dependencies": { + "deep-is": "^0.1.3", + "fast-levenshtein": "^2.0.6", + "levn": "^0.4.1", + "prelude-ls": "^1.2.1", + "type-check": "^0.4.0", + "word-wrap": "^1.2.3" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/eslint/node_modules/prelude-ls": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", + "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", + "dev": true, + "peer": true, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/eslint/node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "peer": true, + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/eslint/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "peer": true, + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/eslint/node_modules/strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "peer": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, + "node_modules/eslint/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "peer": true, + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/eslint/node_modules/type-check": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", + "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", + "dev": true, + "peer": true, + "dependencies": { + "prelude-ls": "^1.2.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/eslint/node_modules/type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true, + "peer": true, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/espree": { "version": "2.2.5", "resolved": "https://registry.npmjs.org/espree/-/espree-2.2.5.tgz", @@ -4675,6 +5487,27 @@ "node": ">=4" } }, + "node_modules/esquery": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz", + "integrity": "sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w==", + "dev": true, + "dependencies": { + "estraverse": "^5.1.0" + }, + "engines": { + "node": ">=0.10" + } + }, + "node_modules/esquery/node_modules/estraverse": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", + "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, "node_modules/esrecurse": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", @@ -5091,6 +5924,22 @@ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", "dev": true }, + "node_modules/fast-glob": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.7.tgz", + "integrity": "sha512-rYGMRwip6lUMvYD3BTScMwT1HtAs2d71SMv66Vrxs0IekGZEjhM0pcMfjQPnknBt2zeCwQMEupiN02ZP4DiT1Q==", + "dev": true, + "dependencies": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.4" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/fast-json-stable-stringify": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", @@ -5103,6 +5952,15 @@ "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", "dev": true }, + "node_modules/fastq": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.13.0.tgz", + "integrity": "sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw==", + "dev": true, + "dependencies": { + "reusify": "^1.0.4" + } + }, "node_modules/fb-watchman": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/fb-watchman/-/fb-watchman-2.0.1.tgz", @@ -5130,6 +5988,19 @@ "node": ">=4" } }, + "node_modules/file-entry-cache": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", + "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", + "dev": true, + "peer": true, + "dependencies": { + "flat-cache": "^3.0.4" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, "node_modules/file-uri-to-path": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz", @@ -5239,6 +6110,27 @@ "node": ">= 0.10" } }, + "node_modules/flat-cache": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz", + "integrity": "sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==", + "dev": true, + "peer": true, + "dependencies": { + "flatted": "^3.1.0", + "rimraf": "^3.0.2" + }, + "engines": { + "node": "^10.12.0 || >=12.0.0" + } + }, + "node_modules/flatted": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.2.2.tgz", + "integrity": "sha512-JaTY/wtrcSyvXJl4IMFHPKyFur1sE9AUqc0QnhOaJ0CxHtAoIV8pYDzeEfAaNEtGkOfq4gr3LBFmdXW5mOQFnA==", + "dev": true, + "peer": true + }, "node_modules/flush-write-stream": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/flush-write-stream/-/flush-write-stream-1.1.1.tgz", @@ -5365,6 +6257,12 @@ "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", "dev": true }, + "node_modules/functional-red-black-tree": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", + "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", + "dev": true + }, "node_modules/gensync": { "version": "1.0.0-beta.2", "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", @@ -6056,6 +6954,26 @@ "node": ">=4" } }, + "node_modules/globby": { + "version": "11.0.4", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.0.4.tgz", + "integrity": "sha512-9O4MVG9ioZJ08ffbcyVYyLOJLk5JQ688pJ4eMGLpdWLHq/Wr1D9BlriLQyL0E+jbkuePVZXYFj47QM/v093wHg==", + "dev": true, + "dependencies": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.1.1", + "ignore": "^5.1.4", + "merge2": "^1.3.0", + "slash": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/glogg": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/glogg/-/glogg-1.0.2.tgz", @@ -6405,26 +7323,6 @@ "integrity": "sha512-jjYI6NkyfXykucU6ELEoT64QyKOdvaA6enOqKtP4xUsGY0X0ZUZz29fUmrTRo+7v7c6TgDu82q3GHHaCEkqZwA==", "dev": true }, - "node_modules/gulp-tslint": { - "version": "8.1.4", - "resolved": "https://registry.npmjs.org/gulp-tslint/-/gulp-tslint-8.1.4.tgz", - "integrity": "sha512-wBoZIEMJRz9urHwolsvQpngA9l931p6g/Liwz1b/KrsVP6jEBFZv/o0NS1TFCQZi/l8mXxz8+v3twhf4HOXxPQ==", - "dev": true, - "dependencies": { - "@types/fancy-log": "1.3.0", - "ansi-colors": "^1.0.1", - "fancy-log": "1.3.3", - "map-stream": "~0.0.7", - "plugin-error": "1.0.1", - "through": "~2.3.8" - }, - "engines": { - "node": ">= 4" - }, - "peerDependencies": { - "tslint": ">=5.0.0-dev" - } - }, "node_modules/gulplog": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/gulplog/-/gulplog-1.0.0.tgz", @@ -6706,6 +7604,15 @@ "node": ">=0.10.0" } }, + "node_modules/ignore": { + "version": "5.1.8", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.1.8.tgz", + "integrity": "sha512-BMpfD7PpiETpBl/A6S498BaIJ6Y/ABT93ETbby2fP00v4EbvPBXWEoaR1UBPKs3iR53pJY7EtZk5KACI57i1Uw==", + "dev": true, + "engines": { + "node": ">= 4" + } + }, "node_modules/import-fresh": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", @@ -9090,6 +9997,15 @@ "js-yaml": "bin/js-yaml.js" } }, + "node_modules/jsdoc-type-pratt-parser": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-1.1.1.tgz", + "integrity": "sha512-uelRmpghNwPBuZScwgBG/OzodaFk5RbO5xaivBdsAY70icWfShwZ7PCMO0x1zSkOa8T1FzHThmrdoyg/0AwV5g==", + "dev": true, + "engines": { + "node": ">=12.0.0" + } + }, "node_modules/jsdom": { "version": "16.7.0", "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-16.7.0.tgz", @@ -9771,6 +10687,13 @@ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", "dev": true }, + "node_modules/lodash.clonedeep": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz", + "integrity": "sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8=", + "dev": true, + "peer": true + }, "node_modules/lodash.ismatch": { "version": "4.4.0", "resolved": "https://registry.npmjs.org/lodash.ismatch/-/lodash.ismatch-4.4.0.tgz", @@ -9783,6 +10706,20 @@ "integrity": "sha1-dx7Hg540c9nEzeKLGTlMNWL09tM=", "dev": true }, + "node_modules/lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true, + "peer": true + }, + "node_modules/lodash.truncate": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz", + "integrity": "sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM=", + "dev": true, + "peer": true + }, "node_modules/log-symbols": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz", @@ -10165,12 +11102,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/map-stream": { - "version": "0.0.7", - "resolved": "https://registry.npmjs.org/map-stream/-/map-stream-0.0.7.tgz", - "integrity": "sha1-ih8HiW2CsQkmvTdEokIACfiJdKg=", - "dev": true - }, "node_modules/map-visit": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/map-visit/-/map-visit-1.0.0.tgz", @@ -10547,6 +11478,15 @@ "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", "dev": true }, + "node_modules/merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true, + "engines": { + "node": ">= 8" + } + }, "node_modules/micromatch": { "version": "4.0.4", "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz", @@ -10678,31 +11618,6 @@ "node": ">=4" } }, - "node_modules/mock-require": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/mock-require/-/mock-require-3.0.3.tgz", - "integrity": "sha512-lLzfLHcyc10MKQnNUCv7dMcoY/2Qxd6wJfbqCcVk3LDb8An4hF6ohk5AztrvgKhJCqj36uyzi/p5se+tvyD+Wg==", - "dev": true, - "dependencies": { - "get-caller-file": "^1.0.2", - "normalize-path": "^2.1.1" - }, - "engines": { - "node": ">=4.3.0" - } - }, - "node_modules/mock-require/node_modules/normalize-path": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-2.1.1.tgz", - "integrity": "sha1-GrKLVW4Zg2Oowab35vogE3/mrtk=", - "dev": true, - "dependencies": { - "remove-trailing-separator": "^1.0.1" - }, - "engines": { - "node": ">=0.10.0" - } - }, "node_modules/modify-values": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/modify-values/-/modify-values-1.0.1.tgz", @@ -12318,21 +13233,6 @@ "semver-compare": "^1.0.0" } }, - "node_modules/plugin-error": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/plugin-error/-/plugin-error-1.0.1.tgz", - "integrity": "sha512-L1zP0dk7vGweZME2i+EeakvUNqSrdiI3F91TwEoYiGrAfUXmVv6fJIq4g82PAXxNsWOp0J7ZqQy/3Szz0ajTxA==", - "dev": true, - "dependencies": { - "ansi-colors": "^1.0.1", - "arr-diff": "^4.0.0", - "arr-union": "^3.1.0", - "extend-shallow": "^3.0.2" - }, - "engines": { - "node": ">= 0.10" - } - }, "node_modules/posix-character-classes": { "version": "0.1.1", "resolved": "https://registry.npmjs.org/posix-character-classes/-/posix-character-classes-0.1.1.tgz", @@ -12414,6 +13314,16 @@ "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==", "dev": true }, + "node_modules/progress": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", + "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", + "dev": true, + "peer": true, + "engines": { + "node": ">=0.4.0" + } + }, "node_modules/prompts": { "version": "2.4.1", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.1.tgz", @@ -12473,6 +13383,26 @@ "teleport": ">=0.2.0" } }, + "node_modules/queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, "node_modules/quick-lru": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-4.0.1.tgz", @@ -12754,6 +13684,27 @@ "node": ">=0.10.0" } }, + "node_modules/regexpp": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.2.0.tgz", + "integrity": "sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/mysticatea" + } + }, + "node_modules/regextras": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/regextras/-/regextras-0.8.0.tgz", + "integrity": "sha512-k519uI04Z3SaY0fLX843MRXnDeG2+vHOFsyhiPZvNLe7r8rD2YNRjq4BQLZZ0oAr2NrtvZlICsXysGNFPGa3CQ==", + "dev": true, + "engines": { + "node": ">=0.1.14" + } + }, "node_modules/remove-bom-buffer": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/remove-bom-buffer/-/remove-bom-buffer-3.0.0.tgz", @@ -12858,6 +13809,16 @@ "node": ">=0.10.0" } }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true, + "peer": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/require-main-filename": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-1.0.1.tgz", @@ -12986,6 +13947,16 @@ "node": ">=0.12" } }, + "node_modules/reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true, + "engines": { + "iojs": ">=1.0.0", + "node": ">=0.10.0" + } + }, "node_modules/rimraf": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", @@ -13025,6 +13996,29 @@ "node": ">=0.12.0" } }, + "node_modules/run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ], + "dependencies": { + "queue-microtask": "^1.2.2" + } + }, "node_modules/rxjs": { "version": "6.6.7", "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-6.6.7.tgz", @@ -13925,6 +14919,130 @@ "integrity": "sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw==", "dev": true }, + "node_modules/table": { + "version": "6.7.1", + "resolved": "https://registry.npmjs.org/table/-/table-6.7.1.tgz", + "integrity": "sha512-ZGum47Yi6KOOFDE8m223td53ath2enHcYLgOCjGr5ngu8bdIARQk6mN/wRMv4yMRcHnCSnHbCEha4sobQx5yWg==", + "dev": true, + "peer": true, + "dependencies": { + "ajv": "^8.0.1", + "lodash.clonedeep": "^4.5.0", + "lodash.truncate": "^4.4.2", + "slice-ansi": "^4.0.0", + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0" + }, + "engines": { + "node": ">=10.0.0" + } + }, + "node_modules/table/node_modules/ajv": { + "version": "8.6.3", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.6.3.tgz", + "integrity": "sha512-SMJOdDP6LqTkD0Uq8qLi+gMwSt0imXLSV080qFVwJCpH9U6Mb+SUGHAXM0KNbcBPguytWyvFxcHgMLe2D2XSpw==", + "dev": true, + "peer": true, + "dependencies": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/table/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "peer": true, + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/table/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "peer": true, + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/table/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "peer": true + }, + "node_modules/table/node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true, + "peer": true + }, + "node_modules/table/node_modules/slice-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", + "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", + "dev": true, + "peer": true, + "dependencies": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/slice-ansi?sponsor=1" + } + }, + "node_modules/table/node_modules/string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "peer": true, + "dependencies": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/table/node_modules/strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "peer": true, + "dependencies": { + "ansi-regex": "^5.0.1" + }, + "engines": { + "node": ">=8" + } + }, "node_modules/tapable": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.2.1.tgz", @@ -14137,6 +15255,13 @@ "integrity": "sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg==", "dev": true }, + "node_modules/text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", + "dev": true, + "peer": true + }, "node_modules/textextensions": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/textextensions/-/textextensions-3.3.0.tgz", @@ -14559,71 +15684,7 @@ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==" }, - "node_modules/tslint": { - "version": "6.1.3", - "resolved": "https://registry.npmjs.org/tslint/-/tslint-6.1.3.tgz", - "integrity": "sha512-IbR4nkT96EQOvKE2PW/djGz8iGNeJ4rF2mBfiYaR/nvUWYKJhLwimoJKgjIFEIDibBtOevj7BqCRL4oHeWWUCg==", - "deprecated": "TSLint has been deprecated in favor of ESLint. Please see https://github.com/palantir/tslint/issues/4534 for more information.", - "dev": true, - "dependencies": { - "@babel/code-frame": "^7.0.0", - "builtin-modules": "^1.1.1", - "chalk": "^2.3.0", - "commander": "^2.12.1", - "diff": "^4.0.1", - "glob": "^7.1.1", - "js-yaml": "^3.13.1", - "minimatch": "^3.0.4", - "mkdirp": "^0.5.3", - "resolve": "^1.3.2", - "semver": "^5.3.0", - "tslib": "^1.13.0", - "tsutils": "^2.29.0" - }, - "bin": { - "tslint": "bin/tslint" - }, - "engines": { - "node": ">=4.8.0" - }, - "peerDependencies": { - "typescript": ">=2.3.0-dev || >=2.4.0-dev || >=2.5.0-dev || >=2.6.0-dev || >=2.7.0-dev || >=2.8.0-dev || >=2.9.0-dev || >=3.0.0-dev || >= 3.1.0-dev || >= 3.2.0-dev || >= 4.0.0-dev" - } - }, - "node_modules/tslint-config-prettier": { - "version": "1.18.0", - "resolved": "https://registry.npmjs.org/tslint-config-prettier/-/tslint-config-prettier-1.18.0.tgz", - "integrity": "sha512-xPw9PgNPLG3iKRxmK7DWr+Ea/SzrvfHtjFt5LBl61gk2UBG/DB9kCXRjv+xyIU1rUtnayLeMUVJBcMX8Z17nDg==", - "dev": true, - "bin": { - "tslint-config-prettier-check": "bin/check.js" - }, - "engines": { - "node": ">=4.0.0" - } - }, - "node_modules/tslint-eslint-rules": { - "version": "5.4.0", - "resolved": "https://registry.npmjs.org/tslint-eslint-rules/-/tslint-eslint-rules-5.4.0.tgz", - "integrity": "sha512-WlSXE+J2vY/VPgIcqQuijMQiel+UtmXS+4nvK4ZzlDiqBfXse8FAvkNnTcYhnQyOTW5KFM+uRRGXxYhFpuBc6w==", - "dev": true, - "dependencies": { - "doctrine": "0.7.2", - "tslib": "1.9.0", - "tsutils": "^3.0.0" - }, - "peerDependencies": { - "tslint": "^5.0.0", - "typescript": "^2.2.0 || ^3.0.0" - } - }, - "node_modules/tslint-eslint-rules/node_modules/tslib": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.9.0.tgz", - "integrity": "sha512-f/qGG2tUkrISBlQZEjEqoZ3B2+npJjIf04H1wuAv9iA8i04Icp+61KRXxFdha22670NJopsZCIjhC3SnjPRKrQ==", - "dev": true - }, - "node_modules/tslint-eslint-rules/node_modules/tsutils": { + "node_modules/tsutils": { "version": "3.21.0", "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", @@ -14638,59 +15699,6 @@ "typescript": ">=2.8.0 || >= 3.2.0-dev || >= 3.3.0-dev || >= 3.4.0-dev || >= 3.5.0-dev || >= 3.6.0-dev || >= 3.6.0-beta || >= 3.7.0-dev || >= 3.7.0-beta" } }, - "node_modules/tslint-ionic-rules": { - "version": "0.0.21", - "resolved": "https://registry.npmjs.org/tslint-ionic-rules/-/tslint-ionic-rules-0.0.21.tgz", - "integrity": "sha512-F3iio3oYcy5LTH9cA6Xz6yrSOX/H8Twz00bWXZo9hyfmE7ZQgmNb6IHh1pK6cRtiToec+S99PDJlLvxlmr+hSw==", - "dev": true, - "dependencies": { - "@types/node": "^10.9.4", - "tslint-eslint-rules": "^5.3.1" - }, - "peerDependencies": { - "tslint": "^5.1.0", - "typescript": "^2.1.0 || ^3.0.0" - } - }, - "node_modules/tslint-ionic-rules/node_modules/@types/node": { - "version": "10.17.60", - "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.60.tgz", - "integrity": "sha512-F0KIgDJfy2nA3zMLmWGKxcH2ZVEtCZXHHdOQs2gSaQ27+lNeEfGxzkIw90aXswATX7AZ33tahPbzy6KAfUreVw==", - "dev": true - }, - "node_modules/tslint/node_modules/commander": { - "version": "2.20.3", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "dev": true - }, - "node_modules/tslint/node_modules/semver": { - "version": "5.7.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", - "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", - "dev": true, - "bin": { - "semver": "bin/semver" - } - }, - "node_modules/tslint/node_modules/tslib": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", - "dev": true - }, - "node_modules/tsutils": { - "version": "2.29.0", - "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-2.29.0.tgz", - "integrity": "sha512-g5JVHCIJwzfISaXpXE1qvNalca5Jwob6FjI4AoPlqMusJ6ftFE7IkkFoMhVLRgK+4Kx3gkzb8UZK5t5yTTvEmA==", - "dev": true, - "dependencies": { - "tslib": "^1.8.1" - }, - "peerDependencies": { - "typescript": ">=2.1.0 || >=2.1.0-dev || >=2.2.0-dev || >=2.3.0-dev || >=2.4.0-dev || >=2.5.0-dev || >=2.6.0-dev || >=2.7.0-dev || >=2.8.0-dev || >=2.9.0-dev || >= 3.0.0-dev || >= 3.1.0-dev" - } - }, "node_modules/tsutils/node_modules/tslib": { "version": "1.14.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", @@ -14818,17 +15826,6 @@ "node": ">=4.2.0" } }, - "node_modules/typescript-tslint-plugin": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/typescript-tslint-plugin/-/typescript-tslint-plugin-1.0.1.tgz", - "integrity": "sha512-akj+J1FDoEv8y5uSs6f6SfkY3ywnhnTifDvOmwejSs4U+a18p73YoetrllKCDf14iq0VMNwIgCxNY/v88K6QYg==", - "dev": true, - "dependencies": { - "minimatch": "^3.0.4", - "mock-require": "^3.0.3", - "vscode-languageserver": "^5.2.1" - } - }, "node_modules/uglify-js": { "version": "3.14.2", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.14.2.tgz", @@ -15056,6 +16053,13 @@ "uuid": "bin/uuid" } }, + "node_modules/v8-compile-cache": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", + "integrity": "sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA==", + "dev": true, + "peer": true + }, "node_modules/v8-to-istanbul": { "version": "8.1.0", "resolved": "https://registry.npmjs.org/v8-to-istanbul/-/v8-to-istanbul-8.1.0.tgz", @@ -15201,56 +16205,12 @@ "node": ">=0.10.0" } }, - "node_modules/vscode-jsonrpc": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-4.0.0.tgz", - "integrity": "sha512-perEnXQdQOJMTDFNv+UF3h1Y0z4iSiaN9jIlb0OqIYgosPCZGYh/MCUlkFtV2668PL69lRDO32hmvL2yiidUYg==", - "dev": true, - "engines": { - "node": ">=8.0.0 || >=10.0.0" - } - }, - "node_modules/vscode-languageserver": { - "version": "5.2.1", - "resolved": "https://registry.npmjs.org/vscode-languageserver/-/vscode-languageserver-5.2.1.tgz", - "integrity": "sha512-GuayqdKZqAwwaCUjDvMTAVRPJOp/SLON3mJ07eGsx/Iq9HjRymhKWztX41rISqDKhHVVyFM+IywICyZDla6U3A==", - "dev": true, - "dependencies": { - "vscode-languageserver-protocol": "3.14.1", - "vscode-uri": "^1.0.6" - }, - "bin": { - "installServerIntoExtension": "bin/installServerIntoExtension" - } - }, - "node_modules/vscode-languageserver-protocol": { - "version": "3.14.1", - "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.14.1.tgz", - "integrity": "sha512-IL66BLb2g20uIKog5Y2dQ0IiigW0XKrvmWiOvc0yXw80z3tMEzEnHjaGAb3ENuU7MnQqgnYJ1Cl2l9RvNgDi4g==", - "dev": true, - "dependencies": { - "vscode-jsonrpc": "^4.0.0", - "vscode-languageserver-types": "3.14.0" - } - }, - "node_modules/vscode-languageserver-types": { - "version": "3.14.0", - "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.14.0.tgz", - "integrity": "sha512-lTmS6AlAlMHOvPQemVwo3CezxBp0sNB95KNPkqp3Nxd5VFEnuG1ByM0zlRWos0zjO3ZWtkvhal0COgiV1xIA4A==", - "dev": true - }, "node_modules/vscode-textmate": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==", "dev": true }, - "node_modules/vscode-uri": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/vscode-uri/-/vscode-uri-1.0.8.tgz", - "integrity": "sha512-obtSWTlbJ+a+TFRYGaUumtVwb+InIUVI0Lu0VBUAPmj2cU5JutEXg3xUE0c2J5Tcy7h2DEKVJBFi+Y9ZSFzzPQ==", - "dev": true - }, "node_modules/w3c-hr-time": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz", @@ -16411,6 +17371,113 @@ "kuler": "^2.0.0" } }, + "@es-joy/jsdoccomment": { + "version": "0.10.8", + "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.10.8.tgz", + "integrity": "sha512-3P1JiGL4xaR9PoTKUHa2N/LKwa2/eUdRqGwijMWWgBqbFEqJUVpmaOi2TcjcemrsRMgFLBzQCK4ToPhrSVDiFQ==", + "dev": true, + "requires": { + "comment-parser": "1.2.4", + "esquery": "^1.4.0", + "jsdoc-type-pratt-parser": "1.1.1" + } + }, + "@eslint/eslintrc": { + "version": "0.4.3", + "resolved": "https://registry.npmjs.org/@eslint/eslintrc/-/eslintrc-0.4.3.tgz", + "integrity": "sha512-J6KFFz5QCYUJq3pf0mjEcCJVERbzv71PUIDczuh9JkwGEzced6CO5ADLHB1rbf/+oPBtoPfMYNOpGDzCANlbXw==", + "dev": true, + "peer": true, + "requires": { + "ajv": "^6.12.4", + "debug": "^4.1.1", + "espree": "^7.3.0", + "globals": "^13.9.0", + "ignore": "^4.0.6", + "import-fresh": "^3.2.1", + "js-yaml": "^3.13.1", + "minimatch": "^3.0.4", + "strip-json-comments": "^3.1.1" + }, + "dependencies": { + "acorn": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", + "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", + "dev": true, + "peer": true + }, + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "peer": true + }, + "espree": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-7.3.1.tgz", + "integrity": "sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g==", + "dev": true, + "peer": true, + "requires": { + "acorn": "^7.4.0", + "acorn-jsx": "^5.3.1", + "eslint-visitor-keys": "^1.3.0" + } + }, + "globals": { + "version": "13.11.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.11.0.tgz", + "integrity": "sha512-08/xrJ7wQjK9kkkRoI3OFUBbLx4f+6x3SGwcPvQ0QH6goFDrOU2oyAWrmh3dJezu65buo+HBMzAMQy6rovVC3g==", + "dev": true, + "peer": true, + "requires": { + "type-fest": "^0.20.2" + } + }, + "ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true, + "peer": true + }, + "strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "peer": true + }, + "type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true, + "peer": true + } + } + }, + "@humanwhocodes/config-array": { + "version": "0.5.0", + "resolved": "https://registry.npmjs.org/@humanwhocodes/config-array/-/config-array-0.5.0.tgz", + "integrity": "sha512-FagtKFz74XrTl7y6HCzQpwDfXP0yhxe9lHLD1UZxjvZIcbyRz8zTFF/yYNfSfzU414eDwZ1SrO0Qvtyf+wFMQg==", + "dev": true, + "peer": true, + "requires": { + "@humanwhocodes/object-schema": "^1.2.0", + "debug": "^4.1.1", + "minimatch": "^3.0.4" + } + }, + "@humanwhocodes/object-schema": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-1.2.0.tgz", + "integrity": "sha512-wdppn25U8z/2yiaT6YGquE6X8sSv7hNMWSXYSSU1jGv/yd6XqjXgTDJ8KP4NgjTXfJ3GbRjeeb8RTV7a/VpM+w==", + "dev": true, + "peer": true + }, "@hutson/parse-repository-url": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/@hutson/parse-repository-url/-/parse-repository-url-3.0.2.tgz", @@ -16906,6 +17973,32 @@ } } }, + "@nodelib/fs.scandir": { + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, + "requires": { + "@nodelib/fs.stat": "2.0.5", + "run-parallel": "^1.1.9" + } + }, + "@nodelib/fs.stat": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true + }, + "@nodelib/fs.walk": { + "version": "1.2.8", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", + "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, + "requires": { + "@nodelib/fs.scandir": "2.1.5", + "fastq": "^1.6.0" + } + }, "@sinonjs/commons": { "version": "1.8.3", "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.8.3.tgz", @@ -17033,12 +18126,6 @@ "integrity": "sha512-Q5Vn3yjTDyCMV50TB6VRIbQNxSE4OmZR86VSbGaNpfUolm0iePBB4KdEEHmxoY5sT2+2DIvXW0rvMDP2nHZ4Mg==", "dev": true }, - "@types/fancy-log": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/@types/fancy-log/-/fancy-log-1.3.0.tgz", - "integrity": "sha512-mQjDxyOM1Cpocd+vm1kZBP7smwKZ4TNokFeds9LV7OZibmPJFEzY3+xZMrKfUdNT71lv8GoCPD6upKwHxubClw==", - "dev": true - }, "@types/fs-extra": { "version": "9.0.13", "resolved": "https://registry.npmjs.org/@types/fs-extra/-/fs-extra-9.0.13.tgz", @@ -17201,6 +18288,111 @@ "integrity": "sha512-7tFImggNeNBVMsn0vLrpn1H1uPrUBdnARPTpZoitY37ZrdJREzf7I16tMrlK3hen349gr1NYh8CmZQa7CTG6Aw==", "dev": true }, + "@typescript-eslint/eslint-plugin": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-4.32.0.tgz", + "integrity": "sha512-+OWTuWRSbWI1KDK8iEyG/6uK2rTm3kpS38wuVifGUTDB6kjEuNrzBI1MUtxnkneuWG/23QehABe2zHHrj+4yuA==", + "dev": true, + "requires": { + "@typescript-eslint/experimental-utils": "4.32.0", + "@typescript-eslint/scope-manager": "4.32.0", + "debug": "^4.3.1", + "functional-red-black-tree": "^1.0.1", + "ignore": "^5.1.8", + "regexpp": "^3.1.0", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + }, + "dependencies": { + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + } + } + }, + "@typescript-eslint/experimental-utils": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.32.0.tgz", + "integrity": "sha512-WLoXcc+cQufxRYjTWr4kFt0DyEv6hDgSaFqYhIzQZ05cF+kXfqXdUh+//kgquPJVUBbL3oQGKQxwPbLxHRqm6A==", + "dev": true, + "requires": { + "@types/json-schema": "^7.0.7", + "@typescript-eslint/scope-manager": "4.32.0", + "@typescript-eslint/types": "4.32.0", + "@typescript-eslint/typescript-estree": "4.32.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^3.0.0" + } + }, + "@typescript-eslint/parser": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-4.32.0.tgz", + "integrity": "sha512-lhtYqQ2iEPV5JqV7K+uOVlPePjClj4dOw7K4/Z1F2yvjIUvyr13yJnDzkK6uon4BjHYuHy3EG0c2Z9jEhFk56w==", + "dev": true, + "requires": { + "@typescript-eslint/scope-manager": "4.32.0", + "@typescript-eslint/types": "4.32.0", + "@typescript-eslint/typescript-estree": "4.32.0", + "debug": "^4.3.1" + } + }, + "@typescript-eslint/scope-manager": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-4.32.0.tgz", + "integrity": "sha512-DK+fMSHdM216C0OM/KR1lHXjP1CNtVIhJ54kQxfOE6x8UGFAjha8cXgDMBEIYS2XCYjjCtvTkjQYwL3uvGOo0w==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.32.0", + "@typescript-eslint/visitor-keys": "4.32.0" + } + }, + "@typescript-eslint/types": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-4.32.0.tgz", + "integrity": "sha512-LE7Z7BAv0E2UvqzogssGf1x7GPpUalgG07nGCBYb1oK4mFsOiFC/VrSMKbZQzFJdN2JL5XYmsx7C7FX9p9ns0w==", + "dev": true + }, + "@typescript-eslint/typescript-estree": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-4.32.0.tgz", + "integrity": "sha512-tRYCgJ3g1UjMw1cGG8Yn1KzOzNlQ6u1h9AmEtPhb5V5a1TmiHWcRyF/Ic+91M4f43QeChyYlVTcf3DvDTZR9vw==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.32.0", + "@typescript-eslint/visitor-keys": "4.32.0", + "debug": "^4.3.1", + "globby": "^11.0.3", + "is-glob": "^4.0.1", + "semver": "^7.3.5", + "tsutils": "^3.21.0" + }, + "dependencies": { + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + } + } + }, + "@typescript-eslint/visitor-keys": { + "version": "4.32.0", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.32.0.tgz", + "integrity": "sha512-e7NE0qz8W+atzv3Cy9qaQ7BTLwWsm084Z0c4nIO2l3Bp6u9WIgdqCgyPyV5oSPDMIW3b20H59OOCmVk3jw3Ptw==", + "dev": true, + "requires": { + "@typescript-eslint/types": "4.32.0", + "eslint-visitor-keys": "^2.0.0" + } + }, "@webassemblyjs/ast": { "version": "1.11.1", "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.11.1.tgz", @@ -17396,6 +18588,14 @@ "dev": true, "requires": {} }, + "acorn-jsx": { + "version": "5.3.2", + "resolved": "https://registry.npmjs.org/acorn-jsx/-/acorn-jsx-5.3.2.tgz", + "integrity": "sha512-rq9s+JNhf0IChjtDXxllJ7g41oZk5SlXtp0LHwyA5cejwn7vKmKp4pPri6YEePv2PU65sAsegbXtIinmDFDXgQ==", + "dev": true, + "peer": true, + "requires": {} + }, "acorn-walk": { "version": "7.2.0", "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-7.2.0.tgz", @@ -17631,6 +18831,12 @@ "kind-of": "^5.0.2" } }, + "array-union": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/array-union/-/array-union-2.1.0.tgz", + "integrity": "sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==", + "dev": true + }, "array-unique": { "version": "0.3.2", "resolved": "https://registry.npmjs.org/array-unique/-/array-unique-0.3.2.tgz", @@ -18032,12 +19238,6 @@ "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", "dev": true }, - "builtin-modules": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/builtin-modules/-/builtin-modules-1.1.1.tgz", - "integrity": "sha1-Jw8HbFpywC9bZaR9+Uxf46J4iS8=", - "dev": true - }, "cache-base": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/cache-base/-/cache-base-1.0.1.tgz", @@ -18461,6 +19661,12 @@ "integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==", "dev": true }, + "comment-parser": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/comment-parser/-/comment-parser-1.2.4.tgz", + "integrity": "sha512-pm0b+qv+CkWNriSTMsfnjChF9kH0kxz55y44Wo5le9qLxMj5xDQAaEd9ZN1ovSuk9CsrncWaFwgpOMg7ClJwkw==", + "dev": true + }, "commitizen": { "version": "4.2.4", "resolved": "https://registry.npmjs.org/commitizen/-/commitizen-4.2.4.tgz", @@ -19143,28 +20349,23 @@ "integrity": "sha512-ag6wfpBFyNXZ0p8pcuIDS//D8H062ZQJ3fzYxjpmeKjnz8W4pekL3AI8VohmyZmsWW2PWaHgjsmqR6L13101VQ==", "dev": true }, - "doctrine": { - "version": "0.7.2", - "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-0.7.2.tgz", - "integrity": "sha1-fLhgNZujvpDgQLJrcpzkv6ZUxSM=", + "dir-glob": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", + "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", "dev": true, "requires": { - "esutils": "^1.1.6", - "isarray": "0.0.1" - }, - "dependencies": { - "esutils": { - "version": "1.1.6", - "resolved": "https://registry.npmjs.org/esutils/-/esutils-1.1.6.tgz", - "integrity": "sha1-wBzKqa5LiXxtDD4hCuUvPHqEQ3U=", - "dev": true - }, - "isarray": { - "version": "0.0.1", - "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz", - "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8=", - "dev": true - } + "path-type": "^4.0.0" + } + }, + "doctrine": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", + "integrity": "sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==", + "dev": true, + "peer": true, + "requires": { + "esutils": "^2.0.2" } }, "dom-serializer": { @@ -19442,6 +20643,305 @@ } } }, + "eslint": { + "version": "7.32.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-7.32.0.tgz", + "integrity": "sha512-VHZ8gX+EDfz+97jGcgyGCyRia/dPOd6Xh9yPv8Bl1+SoaIwD+a/vlrOmGRUyOYu7MwUhc7CxqeaDZU13S4+EpA==", + "dev": true, + "peer": true, + "requires": { + "@babel/code-frame": "7.12.11", + "@eslint/eslintrc": "^0.4.3", + "@humanwhocodes/config-array": "^0.5.0", + "ajv": "^6.10.0", + "chalk": "^4.0.0", + "cross-spawn": "^7.0.2", + "debug": "^4.0.1", + "doctrine": "^3.0.0", + "enquirer": "^2.3.5", + "escape-string-regexp": "^4.0.0", + "eslint-scope": "^5.1.1", + "eslint-utils": "^2.1.0", + "eslint-visitor-keys": "^2.0.0", + "espree": "^7.3.1", + "esquery": "^1.4.0", + "esutils": "^2.0.2", + "fast-deep-equal": "^3.1.3", + "file-entry-cache": "^6.0.1", + "functional-red-black-tree": "^1.0.1", + "glob-parent": "^5.1.2", + "globals": "^13.6.0", + "ignore": "^4.0.6", + "import-fresh": "^3.0.0", + "imurmurhash": "^0.1.4", + "is-glob": "^4.0.0", + "js-yaml": "^3.13.1", + "json-stable-stringify-without-jsonify": "^1.0.1", + "levn": "^0.4.1", + "lodash.merge": "^4.6.2", + "minimatch": "^3.0.4", + "natural-compare": "^1.4.0", + "optionator": "^0.9.1", + "progress": "^2.0.0", + "regexpp": "^3.1.0", + "semver": "^7.2.1", + "strip-ansi": "^6.0.0", + "strip-json-comments": "^3.1.0", + "table": "^6.0.9", + "text-table": "^0.2.0", + "v8-compile-cache": "^2.0.3" + }, + "dependencies": { + "@babel/code-frame": { + "version": "7.12.11", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.12.11.tgz", + "integrity": "sha512-Zt1yodBx1UcyiePMSkWnU4hPqhwq7hGi2nFL1LeA3EUl+q2LQx16MISgJ0+z7dnmgvP9QtIleuETGOiOH1RcIw==", + "dev": true, + "peer": true, + "requires": { + "@babel/highlight": "^7.10.4" + } + }, + "acorn": { + "version": "7.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-7.4.1.tgz", + "integrity": "sha512-nQyp0o1/mNdbTO1PO6kHkwSrmgZ0MT/jCCpNiwbUjGoRN4dlBhqJtoQuCnEOKzgTVwg0ZWiCoQy6SxMebQVh8A==", + "dev": true, + "peer": true + }, + "ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "peer": true, + "requires": { + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "peer": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "peer": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "peer": true + }, + "escape-string-regexp": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", + "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==", + "dev": true, + "peer": true + }, + "eslint-utils": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-2.1.0.tgz", + "integrity": "sha512-w94dQYoauyvlDc43XnGB8lU3Zt713vNChgt4EWwhXAP2XkBvndfxF0AgIqKOOasjPIPzj9JqgwkwbCYD0/V3Zg==", + "dev": true, + "peer": true, + "requires": { + "eslint-visitor-keys": "^1.1.0" + }, + "dependencies": { + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "peer": true + } + } + }, + "espree": { + "version": "7.3.1", + "resolved": "https://registry.npmjs.org/espree/-/espree-7.3.1.tgz", + "integrity": "sha512-v3JCNCE64umkFpmkFGqzVKsOT0tN1Zr+ueqLZfpV1Ob8e+CEgPWa+OxCoGH3tnhimMKIaBm4m/vaRpJ/krRz2g==", + "dev": true, + "peer": true, + "requires": { + "acorn": "^7.4.0", + "acorn-jsx": "^5.3.1", + "eslint-visitor-keys": "^1.3.0" + }, + "dependencies": { + "eslint-visitor-keys": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-1.3.0.tgz", + "integrity": "sha512-6J72N8UNa462wa/KFODt/PJ3IU60SDpC3QXC1Hjc1BXXpfL2C9R5+AU7jhe0F6GREqVMh4Juu+NY7xn+6dipUQ==", + "dev": true, + "peer": true + } + } + }, + "globals": { + "version": "13.11.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.11.0.tgz", + "integrity": "sha512-08/xrJ7wQjK9kkkRoI3OFUBbLx4f+6x3SGwcPvQ0QH6goFDrOU2oyAWrmh3dJezu65buo+HBMzAMQy6rovVC3g==", + "dev": true, + "peer": true, + "requires": { + "type-fest": "^0.20.2" + } + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "peer": true + }, + "ignore": { + "version": "4.0.6", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-4.0.6.tgz", + "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", + "dev": true, + "peer": true + }, + "levn": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", + "integrity": "sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==", + "dev": true, + "peer": true, + "requires": { + "prelude-ls": "^1.2.1", + "type-check": "~0.4.0" + } + }, + "optionator": { + "version": "0.9.1", + "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", + "integrity": "sha512-74RlY5FCnhq4jRxVUPKDaRwrVNXMqsGsiW6AJw4XK8hmtm10wC0ypZBLw5IIp85NZMr91+qd1RvvENwg7jjRFw==", + "dev": true, + "peer": true, + "requires": { + "deep-is": "^0.1.3", + "fast-levenshtein": "^2.0.6", + "levn": "^0.4.1", + "prelude-ls": "^1.2.1", + "type-check": "^0.4.0", + "word-wrap": "^1.2.3" + } + }, + "prelude-ls": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", + "integrity": "sha512-vkcDPrRZo1QZLbn5RLGPpg/WmIQ65qoWWhcGKf/b5eplkkarX0m9z8ppCat4mlOqUsWpyNuYgO3VRyrYHSzX5g==", + "dev": true, + "peer": true + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "peer": true, + "requires": { + "lru-cache": "^6.0.0" + } + }, + "strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "peer": true, + "requires": { + "ansi-regex": "^5.0.1" + } + }, + "strip-json-comments": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", + "dev": true, + "peer": true + }, + "supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "peer": true, + "requires": { + "has-flag": "^4.0.0" + } + }, + "type-check": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", + "integrity": "sha512-XleUoc9uwGXqjWwXaUTZAmzMcFZ5858QA2vvx1Ur5xIcixXIP+8LnFDgRplU30us6teqdlskFfu+ae4K79Ooew==", + "dev": true, + "peer": true, + "requires": { + "prelude-ls": "^1.2.1" + } + }, + "type-fest": { + "version": "0.20.2", + "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", + "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", + "dev": true, + "peer": true + } + } + }, + "eslint-config-prettier": { + "version": "8.3.0", + "resolved": "https://registry.npmjs.org/eslint-config-prettier/-/eslint-config-prettier-8.3.0.tgz", + "integrity": "sha512-BgZuLUSeKzvlL/VUjx/Yb787VQ26RU3gGjA3iiFvdsp/2bMfVIWUVP7tjxtjS0e+HP409cPlPvNkQloz8C91ew==", + "dev": true, + "requires": {} + }, + "eslint-plugin-jsdoc": { + "version": "36.1.0", + "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-36.1.0.tgz", + "integrity": "sha512-Qpied2AJCQcScxfzTObLKRiP5QgLXjMU/ITjBagEV5p2Q/HpumD1EQtazdRYdjDSwPmXhwOl2yquwOGQ4HOJNw==", + "dev": true, + "requires": { + "@es-joy/jsdoccomment": "0.10.8", + "comment-parser": "1.2.4", + "debug": "^4.3.2", + "esquery": "^1.4.0", + "jsdoc-type-pratt-parser": "^1.1.1", + "lodash": "^4.17.21", + "regextras": "^0.8.0", + "semver": "^7.3.5", + "spdx-expression-parse": "^3.0.1" + }, + "dependencies": { + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dev": true, + "requires": { + "lru-cache": "^6.0.0" + } + } + } + }, "eslint-scope": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", @@ -19452,6 +20952,21 @@ "estraverse": "^4.1.1" } }, + "eslint-utils": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/eslint-utils/-/eslint-utils-3.0.0.tgz", + "integrity": "sha512-uuQC43IGctw68pJA1RgbQS8/NP7rch6Cwd4j3ZBtgo4/8Flj4eGE7ZYSZRN3iq5pVUv6GPdW5Z1RFleo84uLDA==", + "dev": true, + "requires": { + "eslint-visitor-keys": "^2.0.0" + } + }, + "eslint-visitor-keys": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/eslint-visitor-keys/-/eslint-visitor-keys-2.1.0.tgz", + "integrity": "sha512-0rSmRBzXgDzIsD6mGdJgevzgezI534Cer5L/vyMX0kHzT/jiB43jRhd9YUlMGYLQy2zprNmoT8qasCGtY+QaKw==", + "dev": true + }, "espree": { "version": "2.2.5", "resolved": "https://registry.npmjs.org/espree/-/espree-2.2.5.tgz", @@ -19464,6 +20979,23 @@ "integrity": "sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==", "dev": true }, + "esquery": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/esquery/-/esquery-1.4.0.tgz", + "integrity": "sha512-cCDispWt5vHHtwMY2YrAQ4ibFkAL8RbH5YGBnZBc90MolvvfkkQcJro/aZiAQUlQ3qgrYS6D6v8Gc5G5CQsc9w==", + "dev": true, + "requires": { + "estraverse": "^5.1.0" + }, + "dependencies": { + "estraverse": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.2.0.tgz", + "integrity": "sha512-BxbNGGNm0RyRYvUdHpIwv9IWzeM9XClbOxwoATuFdOE7ZE6wHL+HQ5T8hoPM+zHvmKzzsEqhgy0GrQ5X13afiQ==", + "dev": true + } + } + }, "esrecurse": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", @@ -19796,6 +21328,19 @@ "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", "dev": true }, + "fast-glob": { + "version": "3.2.7", + "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.7.tgz", + "integrity": "sha512-rYGMRwip6lUMvYD3BTScMwT1HtAs2d71SMv66Vrxs0IekGZEjhM0pcMfjQPnknBt2zeCwQMEupiN02ZP4DiT1Q==", + "dev": true, + "requires": { + "@nodelib/fs.stat": "^2.0.2", + "@nodelib/fs.walk": "^1.2.3", + "glob-parent": "^5.1.2", + "merge2": "^1.3.0", + "micromatch": "^4.0.4" + } + }, "fast-json-stable-stringify": { "version": "2.1.0", "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz", @@ -19808,6 +21353,15 @@ "integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=", "dev": true }, + "fastq": { + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.13.0.tgz", + "integrity": "sha512-YpkpUnK8od0o1hmeSc7UUs/eB/vIPWJYjKck2QKIzAf71Vm1AAQ3EbuZB3g2JIy+pg+ERD0vqI79KyZiB2e2Nw==", + "dev": true, + "requires": { + "reusify": "^1.0.4" + } + }, "fb-watchman": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/fb-watchman/-/fb-watchman-2.0.1.tgz", @@ -19832,6 +21386,16 @@ "escape-string-regexp": "^1.0.5" } }, + "file-entry-cache": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/file-entry-cache/-/file-entry-cache-6.0.1.tgz", + "integrity": "sha512-7Gps/XWymbLk2QLYK4NzpMOrYjMhdIxXuIvy2QBsLE6ljuodKvdkWs/cpyJJ3CVIVpH0Oi1Hvg1ovbMzLdFBBg==", + "dev": true, + "peer": true, + "requires": { + "flat-cache": "^3.0.4" + } + }, "file-uri-to-path": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/file-uri-to-path/-/file-uri-to-path-1.0.0.tgz", @@ -19922,6 +21486,24 @@ "integrity": "sha512-lNaHNVymajmk0OJMBn8fVUAU1BtDeKIqKoVhk4xAALB57aALg6b4W0MfJ/cUE0g9YBXy5XhSlPIpYIJ7HaY/3Q==", "dev": true }, + "flat-cache": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.0.4.tgz", + "integrity": "sha512-dm9s5Pw7Jc0GvMYbshN6zchCA9RgQlzzEZX3vylR9IqFfS8XciblUXOKfW6SiuJ0e13eDYZoZV5wdrev7P3Nwg==", + "dev": true, + "peer": true, + "requires": { + "flatted": "^3.1.0", + "rimraf": "^3.0.2" + } + }, + "flatted": { + "version": "3.2.2", + "resolved": "https://registry.npmjs.org/flatted/-/flatted-3.2.2.tgz", + "integrity": "sha512-JaTY/wtrcSyvXJl4IMFHPKyFur1sE9AUqc0QnhOaJ0CxHtAoIV8pYDzeEfAaNEtGkOfq4gr3LBFmdXW5mOQFnA==", + "dev": true, + "peer": true + }, "flush-write-stream": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/flush-write-stream/-/flush-write-stream-1.1.1.tgz", @@ -20025,6 +21607,12 @@ "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", "dev": true }, + "functional-red-black-tree": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/functional-red-black-tree/-/functional-red-black-tree-1.0.1.tgz", + "integrity": "sha1-GwqzvVU7Kg1jmdKcDj6gslIHgyc=", + "dev": true + }, "gensync": { "version": "1.0.0-beta.2", "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.2.tgz", @@ -20587,6 +22175,20 @@ "integrity": "sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==", "dev": true }, + "globby": { + "version": "11.0.4", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.0.4.tgz", + "integrity": "sha512-9O4MVG9ioZJ08ffbcyVYyLOJLk5JQ688pJ4eMGLpdWLHq/Wr1D9BlriLQyL0E+jbkuePVZXYFj47QM/v093wHg==", + "dev": true, + "requires": { + "array-union": "^2.1.0", + "dir-glob": "^3.0.1", + "fast-glob": "^3.1.1", + "ignore": "^5.1.4", + "merge2": "^1.3.0", + "slash": "^3.0.0" + } + }, "glogg": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/glogg/-/glogg-1.0.2.tgz", @@ -20874,20 +22476,6 @@ } } }, - "gulp-tslint": { - "version": "8.1.4", - "resolved": "https://registry.npmjs.org/gulp-tslint/-/gulp-tslint-8.1.4.tgz", - "integrity": "sha512-wBoZIEMJRz9urHwolsvQpngA9l931p6g/Liwz1b/KrsVP6jEBFZv/o0NS1TFCQZi/l8mXxz8+v3twhf4HOXxPQ==", - "dev": true, - "requires": { - "@types/fancy-log": "1.3.0", - "ansi-colors": "^1.0.1", - "fancy-log": "1.3.3", - "map-stream": "~0.0.7", - "plugin-error": "1.0.1", - "through": "~2.3.8" - } - }, "gulplog": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/gulplog/-/gulplog-1.0.0.tgz", @@ -21101,6 +22689,12 @@ "safer-buffer": ">= 2.1.2 < 3" } }, + "ignore": { + "version": "5.1.8", + "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.1.8.tgz", + "integrity": "sha512-BMpfD7PpiETpBl/A6S498BaIJ6Y/ABT93ETbby2fP00v4EbvPBXWEoaR1UBPKs3iR53pJY7EtZk5KACI57i1Uw==", + "dev": true + }, "import-fresh": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.0.tgz", @@ -22888,6 +24482,12 @@ "esprima": "^4.0.0" } }, + "jsdoc-type-pratt-parser": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/jsdoc-type-pratt-parser/-/jsdoc-type-pratt-parser-1.1.1.tgz", + "integrity": "sha512-uelRmpghNwPBuZScwgBG/OzodaFk5RbO5xaivBdsAY70icWfShwZ7PCMO0x1zSkOa8T1FzHThmrdoyg/0AwV5g==", + "dev": true + }, "jsdom": { "version": "16.7.0", "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-16.7.0.tgz", @@ -23421,6 +25021,13 @@ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", "dev": true }, + "lodash.clonedeep": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz", + "integrity": "sha1-4j8/nE+Pvd6HJSnBBxhXoIblzO8=", + "dev": true, + "peer": true + }, "lodash.ismatch": { "version": "4.4.0", "resolved": "https://registry.npmjs.org/lodash.ismatch/-/lodash.ismatch-4.4.0.tgz", @@ -23433,6 +25040,20 @@ "integrity": "sha1-dx7Hg540c9nEzeKLGTlMNWL09tM=", "dev": true }, + "lodash.merge": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", + "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", + "dev": true, + "peer": true + }, + "lodash.truncate": { + "version": "4.4.2", + "resolved": "https://registry.npmjs.org/lodash.truncate/-/lodash.truncate-4.4.2.tgz", + "integrity": "sha1-WjUNoLERO4N+z//VgSy+WNbq4ZM=", + "dev": true, + "peer": true + }, "log-symbols": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz", @@ -23719,12 +25340,6 @@ "integrity": "sha512-hdN1wVrZbb29eBGiGjJbeP8JbKjq1urkHJ/LIP/NY48MZ1QVXUsQBV1G1zvYFHn1XE06cwjBsOI2K3Ulnj1YXQ==", "dev": true }, - "map-stream": { - "version": "0.0.7", - "resolved": "https://registry.npmjs.org/map-stream/-/map-stream-0.0.7.tgz", - "integrity": "sha1-ih8HiW2CsQkmvTdEokIACfiJdKg=", - "dev": true - }, "map-visit": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/map-visit/-/map-visit-1.0.0.tgz", @@ -24031,6 +25646,12 @@ "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", "dev": true }, + "merge2": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", + "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true + }, "micromatch": { "version": "4.0.4", "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.4.tgz", @@ -24130,27 +25751,6 @@ "mkdirp": "*" } }, - "mock-require": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/mock-require/-/mock-require-3.0.3.tgz", - "integrity": "sha512-lLzfLHcyc10MKQnNUCv7dMcoY/2Qxd6wJfbqCcVk3LDb8An4hF6ohk5AztrvgKhJCqj36uyzi/p5se+tvyD+Wg==", - "dev": true, - "requires": { - "get-caller-file": "^1.0.2", - "normalize-path": "^2.1.1" - }, - "dependencies": { - "normalize-path": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-2.1.1.tgz", - "integrity": "sha1-GrKLVW4Zg2Oowab35vogE3/mrtk=", - "dev": true, - "requires": { - "remove-trailing-separator": "^1.0.1" - } - } - } - }, "modify-values": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/modify-values/-/modify-values-1.0.1.tgz", @@ -25432,18 +27032,6 @@ "semver-compare": "^1.0.0" } }, - "plugin-error": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/plugin-error/-/plugin-error-1.0.1.tgz", - "integrity": "sha512-L1zP0dk7vGweZME2i+EeakvUNqSrdiI3F91TwEoYiGrAfUXmVv6fJIq4g82PAXxNsWOp0J7ZqQy/3Szz0ajTxA==", - "dev": true, - "requires": { - "ansi-colors": "^1.0.1", - "arr-diff": "^4.0.0", - "arr-union": "^3.1.0", - "extend-shallow": "^3.0.2" - } - }, "posix-character-classes": { "version": "0.1.1", "resolved": "https://registry.npmjs.org/posix-character-classes/-/posix-character-classes-0.1.1.tgz", @@ -25500,6 +27088,13 @@ "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==", "dev": true }, + "progress": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", + "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", + "dev": true, + "peer": true + }, "prompts": { "version": "2.4.1", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.1.tgz", @@ -25551,6 +27146,12 @@ "integrity": "sha1-fjL3W0E4EpHQRhHxvxQQmsAGUdc=", "dev": true }, + "queue-microtask": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", + "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true + }, "quick-lru": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/quick-lru/-/quick-lru-4.0.1.tgz", @@ -25778,6 +27379,18 @@ "safe-regex": "^1.1.0" } }, + "regexpp": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/regexpp/-/regexpp-3.2.0.tgz", + "integrity": "sha512-pq2bWo9mVD43nbts2wGv17XLiNLya+GklZ8kaDLV2Z08gDCsGpnKn9BFMepvWuHCbyVvY7J5o5+BVvoQbmlJLg==", + "dev": true + }, + "regextras": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/regextras/-/regextras-0.8.0.tgz", + "integrity": "sha512-k519uI04Z3SaY0fLX843MRXnDeG2+vHOFsyhiPZvNLe7r8rD2YNRjq4BQLZZ0oAr2NrtvZlICsXysGNFPGa3CQ==", + "dev": true + }, "remove-bom-buffer": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/remove-bom-buffer/-/remove-bom-buffer-3.0.0.tgz", @@ -25863,6 +27476,13 @@ "integrity": "sha1-jGStX9MNqxyXbiNE/+f3kqam30I=", "dev": true }, + "require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true, + "peer": true + }, "require-main-filename": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-1.0.1.tgz", @@ -25962,6 +27582,12 @@ "integrity": "sha512-TTlYpa+OL+vMMNG24xSlQGEJ3B/RzEfUlLct7b5G/ytav+wPrplCpVMFuwzXbkecJrb6IYo1iFb0S9v37754mg==", "dev": true }, + "reusify": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", + "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true + }, "rimraf": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", @@ -25986,6 +27612,15 @@ "integrity": "sha512-tvVnVv01b8c1RrA6Ep7JkStj85Guv/YrMcwqYQnwjsAS2cTmmPGBBjAjpCW7RrSodNSoE2/qg9O4bceNvUuDgQ==", "dev": true }, + "run-parallel": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", + "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, + "requires": { + "queue-microtask": "^1.2.2" + } + }, "rxjs": { "version": "6.6.7", "resolved": "https://registry.npmjs.org/rxjs/-/rxjs-6.6.7.tgz", @@ -26739,6 +28374,104 @@ "integrity": "sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw==", "dev": true }, + "table": { + "version": "6.7.1", + "resolved": "https://registry.npmjs.org/table/-/table-6.7.1.tgz", + "integrity": "sha512-ZGum47Yi6KOOFDE8m223td53ath2enHcYLgOCjGr5ngu8bdIARQk6mN/wRMv4yMRcHnCSnHbCEha4sobQx5yWg==", + "dev": true, + "peer": true, + "requires": { + "ajv": "^8.0.1", + "lodash.clonedeep": "^4.5.0", + "lodash.truncate": "^4.4.2", + "slice-ansi": "^4.0.0", + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0" + }, + "dependencies": { + "ajv": { + "version": "8.6.3", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.6.3.tgz", + "integrity": "sha512-SMJOdDP6LqTkD0Uq8qLi+gMwSt0imXLSV080qFVwJCpH9U6Mb+SUGHAXM0KNbcBPguytWyvFxcHgMLe2D2XSpw==", + "dev": true, + "peer": true, + "requires": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + } + }, + "ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "peer": true, + "requires": { + "color-convert": "^2.0.1" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "peer": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "peer": true + }, + "json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true, + "peer": true + }, + "slice-ansi": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/slice-ansi/-/slice-ansi-4.0.0.tgz", + "integrity": "sha512-qMCMfhY040cVHT43K9BFygqYbUPFZKHOg7K73mtTWJRb8pyP3fzf4Ixd5SzdEJQ6MRUg/WBnOLxghZtKKurENQ==", + "dev": true, + "peer": true, + "requires": { + "ansi-styles": "^4.0.0", + "astral-regex": "^2.0.0", + "is-fullwidth-code-point": "^3.0.0" + } + }, + "string-width": { + "version": "4.2.3", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", + "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, + "peer": true, + "requires": { + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.1" + } + }, + "strip-ansi": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", + "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, + "peer": true, + "requires": { + "ansi-regex": "^5.0.1" + } + } + } + }, "tapable": { "version": "2.2.1", "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.2.1.tgz", @@ -26881,6 +28614,13 @@ "integrity": "sha512-uuVGNWzgJ4yhRaNSiubPY7OjISw4sw4E5Uv0wbjp+OzcbmVU/rsT8ujgcXJhn9ypzsgr5vlzpPqP+MBBKcGvbg==", "dev": true }, + "text-table": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/text-table/-/text-table-0.2.0.tgz", + "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", + "dev": true, + "peer": true + }, "textextensions": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/textextensions/-/textextensions-3.3.0.tgz", @@ -27199,103 +28939,10 @@ "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", "integrity": "sha512-77EbyPPpMz+FRFRuAFlWMtmgUWGe9UOG2Z25NqCwiIjRhOf5iKGuzSe5P2w1laq+FkRy4p+PCuVkJSGkzTEKVw==" }, - "tslint": { - "version": "6.1.3", - "resolved": "https://registry.npmjs.org/tslint/-/tslint-6.1.3.tgz", - "integrity": "sha512-IbR4nkT96EQOvKE2PW/djGz8iGNeJ4rF2mBfiYaR/nvUWYKJhLwimoJKgjIFEIDibBtOevj7BqCRL4oHeWWUCg==", - "dev": true, - "requires": { - "@babel/code-frame": "^7.0.0", - "builtin-modules": "^1.1.1", - "chalk": "^2.3.0", - "commander": "^2.12.1", - "diff": "^4.0.1", - "glob": "^7.1.1", - "js-yaml": "^3.13.1", - "minimatch": "^3.0.4", - "mkdirp": "^0.5.3", - "resolve": "^1.3.2", - "semver": "^5.3.0", - "tslib": "^1.13.0", - "tsutils": "^2.29.0" - }, - "dependencies": { - "commander": { - "version": "2.20.3", - "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", - "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", - "dev": true - }, - "semver": { - "version": "5.7.1", - "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", - "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", - "dev": true - }, - "tslib": { - "version": "1.14.1", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", - "integrity": "sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==", - "dev": true - } - } - }, - "tslint-config-prettier": { - "version": "1.18.0", - "resolved": "https://registry.npmjs.org/tslint-config-prettier/-/tslint-config-prettier-1.18.0.tgz", - "integrity": "sha512-xPw9PgNPLG3iKRxmK7DWr+Ea/SzrvfHtjFt5LBl61gk2UBG/DB9kCXRjv+xyIU1rUtnayLeMUVJBcMX8Z17nDg==", - "dev": true - }, - "tslint-eslint-rules": { - "version": "5.4.0", - "resolved": "https://registry.npmjs.org/tslint-eslint-rules/-/tslint-eslint-rules-5.4.0.tgz", - "integrity": "sha512-WlSXE+J2vY/VPgIcqQuijMQiel+UtmXS+4nvK4ZzlDiqBfXse8FAvkNnTcYhnQyOTW5KFM+uRRGXxYhFpuBc6w==", - "dev": true, - "requires": { - "doctrine": "0.7.2", - "tslib": "1.9.0", - "tsutils": "^3.0.0" - }, - "dependencies": { - "tslib": { - "version": "1.9.0", - "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.9.0.tgz", - "integrity": "sha512-f/qGG2tUkrISBlQZEjEqoZ3B2+npJjIf04H1wuAv9iA8i04Icp+61KRXxFdha22670NJopsZCIjhC3SnjPRKrQ==", - "dev": true - }, - "tsutils": { - "version": "3.21.0", - "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", - "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", - "dev": true, - "requires": { - "tslib": "^1.8.1" - } - } - } - }, - "tslint-ionic-rules": { - "version": "0.0.21", - "resolved": "https://registry.npmjs.org/tslint-ionic-rules/-/tslint-ionic-rules-0.0.21.tgz", - "integrity": "sha512-F3iio3oYcy5LTH9cA6Xz6yrSOX/H8Twz00bWXZo9hyfmE7ZQgmNb6IHh1pK6cRtiToec+S99PDJlLvxlmr+hSw==", - "dev": true, - "requires": { - "@types/node": "^10.9.4", - "tslint-eslint-rules": "^5.3.1" - }, - "dependencies": { - "@types/node": { - "version": "10.17.60", - "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.60.tgz", - "integrity": "sha512-F0KIgDJfy2nA3zMLmWGKxcH2ZVEtCZXHHdOQs2gSaQ27+lNeEfGxzkIw90aXswATX7AZ33tahPbzy6KAfUreVw==", - "dev": true - } - } - }, "tsutils": { - "version": "2.29.0", - "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-2.29.0.tgz", - "integrity": "sha512-g5JVHCIJwzfISaXpXE1qvNalca5Jwob6FjI4AoPlqMusJ6ftFE7IkkFoMhVLRgK+4Kx3gkzb8UZK5t5yTTvEmA==", + "version": "3.21.0", + "resolved": "https://registry.npmjs.org/tsutils/-/tsutils-3.21.0.tgz", + "integrity": "sha512-mHKK3iUXL+3UF6xL5k0PEhKRUBKPBCv/+RkEOpjRWxxx27KKRBmmA60A9pgOUvMi8GKhRMPEmjBRPzs2W7O1OA==", "dev": true, "requires": { "tslib": "^1.8.1" @@ -27392,17 +29039,6 @@ "integrity": "sha512-pxnwLxeb/Z5SP80JDRzVjh58KsM6jZHRAOtTpS7sXLS4ogXNKC9ANxHHZqLLeVHZN35jCtI4JdmLLbLiC1kBow==", "dev": true }, - "typescript-tslint-plugin": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/typescript-tslint-plugin/-/typescript-tslint-plugin-1.0.1.tgz", - "integrity": "sha512-akj+J1FDoEv8y5uSs6f6SfkY3ywnhnTifDvOmwejSs4U+a18p73YoetrllKCDf14iq0VMNwIgCxNY/v88K6QYg==", - "dev": true, - "requires": { - "minimatch": "^3.0.4", - "mock-require": "^3.0.3", - "vscode-languageserver": "^5.2.1" - } - }, "uglify-js": { "version": "3.14.2", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.14.2.tgz", @@ -27585,6 +29221,13 @@ "integrity": "sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==", "dev": true }, + "v8-compile-cache": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.3.0.tgz", + "integrity": "sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA==", + "dev": true, + "peer": true + }, "v8-to-istanbul": { "version": "8.1.0", "resolved": "https://registry.npmjs.org/v8-to-istanbul/-/v8-to-istanbul-8.1.0.tgz", @@ -27712,50 +29355,12 @@ } } }, - "vscode-jsonrpc": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-4.0.0.tgz", - "integrity": "sha512-perEnXQdQOJMTDFNv+UF3h1Y0z4iSiaN9jIlb0OqIYgosPCZGYh/MCUlkFtV2668PL69lRDO32hmvL2yiidUYg==", - "dev": true - }, - "vscode-languageserver": { - "version": "5.2.1", - "resolved": "https://registry.npmjs.org/vscode-languageserver/-/vscode-languageserver-5.2.1.tgz", - "integrity": "sha512-GuayqdKZqAwwaCUjDvMTAVRPJOp/SLON3mJ07eGsx/Iq9HjRymhKWztX41rISqDKhHVVyFM+IywICyZDla6U3A==", - "dev": true, - "requires": { - "vscode-languageserver-protocol": "3.14.1", - "vscode-uri": "^1.0.6" - } - }, - "vscode-languageserver-protocol": { - "version": "3.14.1", - "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.14.1.tgz", - "integrity": "sha512-IL66BLb2g20uIKog5Y2dQ0IiigW0XKrvmWiOvc0yXw80z3tMEzEnHjaGAb3ENuU7MnQqgnYJ1Cl2l9RvNgDi4g==", - "dev": true, - "requires": { - "vscode-jsonrpc": "^4.0.0", - "vscode-languageserver-types": "3.14.0" - } - }, - "vscode-languageserver-types": { - "version": "3.14.0", - "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.14.0.tgz", - "integrity": "sha512-lTmS6AlAlMHOvPQemVwo3CezxBp0sNB95KNPkqp3Nxd5VFEnuG1ByM0zlRWos0zjO3ZWtkvhal0COgiV1xIA4A==", - "dev": true - }, "vscode-textmate": { "version": "5.2.0", "resolved": "https://registry.npmjs.org/vscode-textmate/-/vscode-textmate-5.2.0.tgz", "integrity": "sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==", "dev": true }, - "vscode-uri": { - "version": "1.0.8", - "resolved": "https://registry.npmjs.org/vscode-uri/-/vscode-uri-1.0.8.tgz", - "integrity": "sha512-obtSWTlbJ+a+TFRYGaUumtVwb+InIUVI0Lu0VBUAPmj2cU5JutEXg3xUE0c2J5Tcy7h2DEKVJBFi+Y9ZSFzzPQ==", - "dev": true - }, "w3c-hr-time": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/w3c-hr-time/-/w3c-hr-time-1.0.2.tgz", diff --git a/package.json b/package.json index 600b2d9f..17eebdd3 100644 --- a/package.json +++ b/package.json @@ -16,7 +16,7 @@ "build": "npm run build:core && npm run build:esm && npm run build:ngx && npm run build:es5", "prebuild": "rimraf -rf dist", "npmpub": "ts-node -P scripts/tsconfig.json scripts/tasks/publish", - "lint": "gulp lint", + "lint": "eslint src/**/*.ts", "readmes": "gulp readmes", "docs-json": "ts-node -P scripts/tsconfig.json scripts/docs-json", "version": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md", @@ -38,16 +38,19 @@ "@types/node": "^16.9.1", "@types/rimraf": "^3.0.2", "@types/webpack": "^5.28.0", + "@typescript-eslint/eslint-plugin": "^4.32.0", + "@typescript-eslint/parser": "^4.32.0", "async-promise-queue": "^1.0.5", "conventional-changelog-cli": "^2.1.1", "cz-conventional-changelog": "^3.3.0", "dgeni": "^0.4.14", "dgeni-packages": "0.16.10", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-jsdoc": "^36.1.0", "fs-extra": "^10.0.0", "gulp": "^4.0.2", "gulp-rename": "^2.0.0", "gulp-replace": "^1.1.3", - "gulp-tslint": "^8.1.4", "husky": "^7.0.1", "is-ci": "^3.0.0", "jest": "^27.0.6", @@ -61,12 +64,8 @@ "terser-webpack-plugin": "^5.2.4", "ts-jest": "^27.0.5", "ts-node": "^10.2.1", - "tslint": "~6.1.0", - "tslint-config-prettier": "^1.18.0", - "tslint-ionic-rules": "0.0.21", "typedoc": "^0.22.4", - "typescript": "4.1.6", - "typescript-tslint-plugin": "^1.0.1", + "typescript": "^4.1.6", "unminified-webpack-plugin": "^3.0.0", "webpack": "^5.51.1", "winston": "^3.3.3", diff --git a/src/@awesome-cordova-plugins/core/awesome-cordova-plugin.ts b/src/@awesome-cordova-plugins/core/awesome-cordova-plugin.ts index e5110ed5..4dc4b4bd 100644 --- a/src/@awesome-cordova-plugins/core/awesome-cordova-plugin.ts +++ b/src/@awesome-cordova-plugins/core/awesome-cordova-plugin.ts @@ -11,7 +11,8 @@ export class AwesomeCordovaNativePlugin { /** * Returns a boolean that indicates whether the plugin is installed - * @return {boolean} + * + * @returns {boolean} */ static installed(): boolean { const isAvailable = checkAvailability(this.pluginRef) === true; diff --git a/src/@awesome-cordova-plugins/core/bootstrap.ts b/src/@awesome-cordova-plugins/core/bootstrap.ts index 3c748361..f25a5597 100644 --- a/src/@awesome-cordova-plugins/core/bootstrap.ts +++ b/src/@awesome-cordova-plugins/core/bootstrap.ts @@ -1,3 +1,6 @@ +/** + * + */ export function checkReady() { if (typeof process === 'undefined') { const win: any = typeof window !== 'undefined' ? window : {}; diff --git a/src/@awesome-cordova-plugins/core/decorators/common.ts b/src/@awesome-cordova-plugins/core/decorators/common.ts index b2c6ff92..d974396e 100644 --- a/src/@awesome-cordova-plugins/core/decorators/common.ts +++ b/src/@awesome-cordova-plugins/core/decorators/common.ts @@ -7,6 +7,9 @@ declare const window: any; export const ERR_CORDOVA_NOT_AVAILABLE = { error: 'cordova_not_available' }; export const ERR_PLUGIN_NOT_INSTALLED = { error: 'plugin_not_installed' }; +/** + * @param callback + */ export function getPromise(callback: (resolve: Function, reject?: Function) => any): Promise { const tryNativePromise = () => { if (Promise) { @@ -37,6 +40,12 @@ export function getPromise(callback: (resolve: Function, reject?: Function) = return tryNativePromise(); } +/** + * @param pluginObj + * @param methodName + * @param args + * @param opts + */ export function wrapPromise(pluginObj: any, methodName: string, args: any[], opts: CordovaOptions = {}) { let pluginResult: any, rej: Function; const p = getPromise((resolve: Function, reject: Function) => { @@ -64,6 +73,12 @@ export function wrapPromise(pluginObj: any, methodName: string, args: any[], opt return p; } +/** + * @param pluginObj + * @param methodName + * @param args + * @param opts + */ function wrapOtherPromise(pluginObj: any, methodName: string, args: any[], opts: any = {}) { return getPromise((resolve: Function, reject: Function) => { const pluginResult = callCordovaPlugin(pluginObj, methodName, args, opts); @@ -79,6 +94,12 @@ function wrapOtherPromise(pluginObj: any, methodName: string, args: any[], opts: }); } +/** + * @param pluginObj + * @param methodName + * @param args + * @param opts + */ function wrapObservable(pluginObj: any, methodName: string, args: any[], opts: any = {}) { return new Observable((observer) => { let pluginResult; @@ -136,6 +157,7 @@ function wrapObservable(pluginObj: any, methodName: string, args: any[], opts: a /** * Wrap the event with an observable + * * @private * @param event event name * @param element The element to attach the event listener to @@ -151,7 +173,8 @@ function wrapEventObservable(event: string, element: any): Observable { /** * Checks if plugin/cordova is available - * @return {boolean | { error: string } } + * + * @returns {boolean | { error: string } } * @private */ export function checkAvailability( @@ -164,8 +187,13 @@ export function checkAvailability( methodName?: string, pluginName?: string ): boolean | { error: string }; +/** + * @param plugin + * @param methodName + * @param pluginName + */ export function checkAvailability(plugin: any, methodName?: string, pluginName?: string): boolean | { error: string } { - let pluginRef, pluginInstance, pluginPackage; + let pluginRef, pluginPackage; if (typeof plugin === 'string') { pluginRef = plugin; @@ -175,7 +203,7 @@ export function checkAvailability(plugin: any, methodName?: string, pluginName?: pluginPackage = plugin.constructor.getPluginInstallName(); } - pluginInstance = getPlugin(pluginRef); + const pluginInstance = getPlugin(pluginRef); if (!pluginInstance || (!!methodName && typeof pluginInstance[methodName] === 'undefined')) { if (typeof window === 'undefined' || !window.cordova) { @@ -192,12 +220,21 @@ export function checkAvailability(plugin: any, methodName?: string, pluginName?: /** * Checks if _objectInstance exists and has the method/property + * + * @param pluginObj + * @param methodName * @private */ export function instanceAvailability(pluginObj: any, methodName?: string): boolean { return pluginObj._objectInstance && (!methodName || typeof pluginObj._objectInstance[methodName] !== 'undefined'); } +/** + * @param args + * @param opts + * @param resolve + * @param reject + */ export function setIndex(args: any[], opts: any = {}, resolve?: Function, reject?: Function): any { // ignore resolve and reject in case sync if (opts.sync) { @@ -258,6 +295,14 @@ export function setIndex(args: any[], opts: any = {}, resolve?: Function, reject return args; } +/** + * @param pluginObj + * @param methodName + * @param args + * @param opts + * @param resolve + * @param reject + */ export function callCordovaPlugin( pluginObj: any, methodName: string, @@ -274,12 +319,21 @@ export function callCordovaPlugin( if (availabilityCheck === true) { const pluginInstance = getPlugin(pluginObj.constructor.getPluginRef()); + // eslint-disable-next-line prefer-spread return pluginInstance[methodName].apply(pluginInstance, args); } else { return availabilityCheck; } } +/** + * @param pluginObj + * @param methodName + * @param args + * @param opts + * @param resolve + * @param reject + */ export function callInstance( pluginObj: any, methodName: string, @@ -291,10 +345,14 @@ export function callInstance( args = setIndex(args, opts, resolve, reject); if (instanceAvailability(pluginObj, methodName)) { + // eslint-disable-next-line prefer-spread return pluginObj._objectInstance[methodName].apply(pluginObj._objectInstance, args); } } +/** + * @param pluginRef + */ export function getPlugin(pluginRef: string): any { if (typeof window !== 'undefined') { return get(window, pluginRef); @@ -302,6 +360,10 @@ export function getPlugin(pluginRef: string): any { return null; } +/** + * @param element + * @param path + */ export function get(element: Element | Window, path: string) { const paths: string[] = path.split('.'); let obj: any = element; @@ -314,6 +376,11 @@ export function get(element: Element | Window, path: string) { return obj; } +/** + * @param pluginName + * @param plugin + * @param method + */ export function pluginWarn(pluginName: string, plugin?: string, method?: string): void { if (method) { console.warn( @@ -357,6 +424,9 @@ export function cordovaWarn(pluginName: string, method?: string): void { export type WrapFn = (...args: any[]) => any; /** + * @param pluginObj + * @param methodName + * @param opts * @private */ export const wrap = (pluginObj: any, methodName: string, opts: CordovaOptions = {}): WrapFn => { @@ -377,6 +447,9 @@ export const wrap = (pluginObj: any, methodName: string, opts: CordovaOptions = }; /** + * @param pluginObj + * @param methodName + * @param opts * @private */ export function wrapInstance(pluginObj: any, methodName: string, opts: any = {}): Function { diff --git a/src/@awesome-cordova-plugins/core/decorators/cordova-function-override.ts b/src/@awesome-cordova-plugins/core/decorators/cordova-function-override.ts index b9a874c7..a32da2c5 100644 --- a/src/@awesome-cordova-plugins/core/decorators/cordova-function-override.ts +++ b/src/@awesome-cordova-plugins/core/decorators/cordova-function-override.ts @@ -2,6 +2,10 @@ import { Observable, Observer } from 'rxjs'; import { checkAvailability, getPlugin } from './common'; +/** + * @param pluginObj + * @param methodName + */ function overrideFunction(pluginObj: any, methodName: string): Observable { return new Observable((observer: Observer) => { const availabilityCheck = checkAvailability(pluginObj, methodName); @@ -17,6 +21,11 @@ function overrideFunction(pluginObj: any, methodName: string): Observable { }); } +/** + * @param pluginObj + * @param methodName + * @param args + */ export function cordovaFunctionOverride(pluginObj: any, methodName: string, args: IArguments | any[] = []) { return overrideFunction(pluginObj, methodName); } diff --git a/src/@awesome-cordova-plugins/core/decorators/cordova-instance.ts b/src/@awesome-cordova-plugins/core/decorators/cordova-instance.ts index fc798ad9..f017db4c 100644 --- a/src/@awesome-cordova-plugins/core/decorators/cordova-instance.ts +++ b/src/@awesome-cordova-plugins/core/decorators/cordova-instance.ts @@ -1,6 +1,12 @@ import { wrapInstance } from './common'; import { CordovaOptions } from './interfaces'; +/** + * @param pluginObj + * @param methodName + * @param config + * @param args + */ export function cordovaInstance(pluginObj: any, methodName: string, config: CordovaOptions, args: IArguments | any[]) { args = Array.from(args); return wrapInstance(pluginObj, methodName, config).apply(this, args); diff --git a/src/@awesome-cordova-plugins/core/decorators/cordova-property.ts b/src/@awesome-cordova-plugins/core/decorators/cordova-property.ts index 9cc51a81..9d8ef9ee 100644 --- a/src/@awesome-cordova-plugins/core/decorators/cordova-property.ts +++ b/src/@awesome-cordova-plugins/core/decorators/cordova-property.ts @@ -1,5 +1,9 @@ import { checkAvailability, getPlugin } from './common'; +/** + * @param pluginObj + * @param key + */ export function cordovaPropertyGet(pluginObj: any, key: string) { if (checkAvailability(pluginObj, key) === true) { return getPlugin(pluginObj.constructor.getPluginRef())[key]; @@ -7,6 +11,11 @@ export function cordovaPropertyGet(pluginObj: any, key: string) { return null; } +/** + * @param pluginObj + * @param key + * @param value + */ export function cordovaPropertySet(pluginObj: any, key: string, value: any) { if (checkAvailability(pluginObj, key) === true) { getPlugin(pluginObj.constructor.getPluginRef())[key] = value; diff --git a/src/@awesome-cordova-plugins/core/decorators/cordova.ts b/src/@awesome-cordova-plugins/core/decorators/cordova.ts index 44f0ab09..eaade2fc 100644 --- a/src/@awesome-cordova-plugins/core/decorators/cordova.ts +++ b/src/@awesome-cordova-plugins/core/decorators/cordova.ts @@ -1,6 +1,12 @@ import { wrap } from './common'; import { CordovaOptions } from './interfaces'; +/** + * @param pluginObj + * @param methodName + * @param config + * @param args + */ export function cordova(pluginObj: any, methodName: string, config: CordovaOptions, args: IArguments | any[]) { return wrap(pluginObj, methodName, config).apply(this, args); } diff --git a/src/@awesome-cordova-plugins/core/decorators/instance-property.ts b/src/@awesome-cordova-plugins/core/decorators/instance-property.ts index 6f02f7b8..d09b3dad 100644 --- a/src/@awesome-cordova-plugins/core/decorators/instance-property.ts +++ b/src/@awesome-cordova-plugins/core/decorators/instance-property.ts @@ -1,3 +1,7 @@ +/** + * @param pluginObj + * @param key + */ export function instancePropertyGet(pluginObj: any, key: string) { if (pluginObj._objectInstance && pluginObj._objectInstance[key]) { return pluginObj._objectInstance[key]; @@ -5,6 +9,11 @@ export function instancePropertyGet(pluginObj: any, key: string) { return null; } +/** + * @param pluginObj + * @param key + * @param value + */ export function instancePropertySet(pluginObj: any, key: string, value: any) { if (pluginObj._objectInstance) { pluginObj._objectInstance[key] = value; diff --git a/src/@awesome-cordova-plugins/core/ng1.ts b/src/@awesome-cordova-plugins/core/ng1.ts index 4a6d0322..9fd74f77 100644 --- a/src/@awesome-cordova-plugins/core/ng1.ts +++ b/src/@awesome-cordova-plugins/core/ng1.ts @@ -4,6 +4,8 @@ declare const window: any; * Initialize the ionic.native Angular module if we're running in ng1. * This iterates through the list of registered plugins and dynamically * creates Angular 1 services of the form $cordovaSERVICE, ex: $cordovaStatusBar. + * + * @param plugins */ export function initAngular1(plugins: any) { if (typeof window !== 'undefined' && window.angular) { diff --git a/src/@awesome-cordova-plugins/core/util.ts b/src/@awesome-cordova-plugins/core/util.ts index f734562e..12a1032c 100644 --- a/src/@awesome-cordova-plugins/core/util.ts +++ b/src/@awesome-cordova-plugins/core/util.ts @@ -1,6 +1,8 @@ declare const window: any; /** + * @param element + * @param path * @private */ export function get(element: Element | Window, path: string) { @@ -16,6 +18,7 @@ export function get(element: Element | Window, path: string) { } /** + * @param callback * @private */ export function getPromise(callback: Function = () => {}): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/abbyy-rtr/index.ts b/src/@awesome-cordova-plugins/plugins/abbyy-rtr/index.ts index ce817afb..6cb815cb 100644 --- a/src/@awesome-cordova-plugins/plugins/abbyy-rtr/index.ts +++ b/src/@awesome-cordova-plugins/plugins/abbyy-rtr/index.ts @@ -271,7 +271,6 @@ export interface DataCaptureResult { * @description * This plugin allows to use the Text Capture and Data Capture features of * ABBYY Real-Time Recognition SDK (RTR SDK) in apps. - * * @usage * ```typescript * import { AbbyyRTR } from '@awesome-cordova-plugins/abbyy-rtr/ngx'; @@ -305,8 +304,9 @@ export interface DataCaptureResult { export class AbbyyRTR extends AwesomeCordovaNativePlugin { /** * Opens a modal dialog with controls for the Text Capture scenario. + * * @param {TextCaptureOptions} options - * @return {Promise} + * @returns {Promise} */ @CordovaCheck() startTextCapture(options: TextCaptureOptions): Promise { @@ -323,8 +323,9 @@ export class AbbyyRTR extends AwesomeCordovaNativePlugin { /** * Opens a modal dialog with controls for the Data Capture scenario. + * * @param {DataCaptureOptions} options - * @return {Promise} + * @returns {Promise} */ @CordovaCheck() startDataCapture(options: DataCaptureOptions): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/action-sheet/index.ts b/src/@awesome-cordova-plugins/plugins/action-sheet/index.ts index 69bba4b9..0e958c2b 100644 --- a/src/@awesome-cordova-plugins/plugins/action-sheet/index.ts +++ b/src/@awesome-cordova-plugins/plugins/action-sheet/index.ts @@ -59,7 +59,6 @@ export interface ActionSheetOptions { * The ActionSheet plugin shows a native list of options the user can choose from. * * Requires Cordova plugin: `cordova-plugin-actionsheet`. For more info, please see the [ActionSheet plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-actionsheet). - * * @usage * ```typescript * import { ActionSheet, ActionSheetOptions } from '@awesome-cordova-plugins/action-sheet/ngx'; @@ -116,6 +115,7 @@ export class ActionSheet extends AwesomeCordovaNativePlugin { /** * Show a native ActionSheet component. See below for options. + * * @param {ActionSheetOptions} [options] Options See table below * @returns {Promise} Returns a Promise that resolves with the index of the * button pressed (1 based, so 1, 2, 3, etc.) @@ -127,6 +127,7 @@ export class ActionSheet extends AwesomeCordovaNativePlugin { /** * Programmatically hide the native ActionSheet + * * @param {ActionSheetOptions} [options] Options See table below * @returns {Promise} Returns a Promise that resolves when the actionsheet is closed */ diff --git a/src/@awesome-cordova-plugins/plugins/adjust/index.ts b/src/@awesome-cordova-plugins/plugins/adjust/index.ts index 98240f5c..d60c77f6 100644 --- a/src/@awesome-cordova-plugins/plugins/adjust/index.ts +++ b/src/@awesome-cordova-plugins/plugins/adjust/index.ts @@ -454,7 +454,6 @@ export enum AdjustAdRevenueSource { * This is the Ionic Cordova SDK of Adjust™. You can read more about Adjust™ at adjust.com. * * Requires Cordova plugin: `com.adjust.sdk`. For more info, please see the [Adjust Cordova SDK](https://github.com/adjust/cordova_sdk) - * * @usage * ```typescript * import { Adjust, AdjustConfig, AdjustEnvironment } from '@awesome-cordova-plugins/adjust/ngx'; @@ -499,6 +498,7 @@ export enum AdjustAdRevenueSource { export class Adjust extends AwesomeCordovaNativePlugin { /** * This method initializes Adjust SDK + * * @param {AdjustConig} config Adjust config object used as starting options */ @Cordova({ sync: true }) @@ -506,6 +506,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * This method tracks an event + * * @param {AdjustEvent} event Adjust event object to be tracked */ @Cordova({ sync: true }) @@ -513,6 +514,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * This method tracks App Store subscription + * * @param {AdjustAppStoreSubscription} subscription Adjust App Store subscription object to be tracked */ @Cordova({ sync: true }) @@ -520,6 +522,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * This method tracks Play Store subscription + * * @param {AdjustPlayStoreSubscription} subscription Adjust Play Store subscription object to be tracked */ @Cordova({ sync: true }) @@ -527,6 +530,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * This method tracks third party sharing choice + * * @param {AdjustThirdPartySharing} thirdPartySharing Adjust third party sharing object to be tracked */ @Cordova({ sync: true }) @@ -534,6 +538,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * This method tracks ad revenue data + * * @param {AdjustAdRevenueSource} source Ad revenue source * @param {string} payload Ad revenue JSON string payload */ @@ -541,6 +546,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * This method tracks ad revenue data + * * @param {AdjustAdRevenue} adRevenue Adjust ad revenue object */ trackAdRevenue(adRevenue: AdjustAdRevenue): void; @@ -551,6 +557,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * This method tracks measurement consent choice + * * @param {boolean} measurementConsent set measurement consent to true or false */ @Cordova({ sync: true }) @@ -558,6 +565,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * This method sets offline mode on or off + * * @param {boolean} enabled set to true for offline mode on */ @Cordova({ sync: true }) @@ -565,6 +573,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * By making this call, the Adjust SDK will try to find if there is any new attribution info inside of the deep link and if any, it will be sent to the Adjust backend. + * * @param {string} url URL of the deeplink */ @Cordova({ sync: true }) @@ -572,6 +581,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * You can disable/enable the Adjust SDK from tracking by invoking this method + * * @param {boolean} enabled set to false to disable SDK */ @Cordova({ sync: true }) @@ -580,6 +590,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * To send us the push notification token, add the following call to Adjust whenever you get your token in the app or when it gets updated. * Push tokens are used for Audience Builder and client callbacks, and they are required for the upcoming uninstall tracking feature. + * * @param {string} pushToken push token value */ @Cordova({ sync: true }) @@ -587,6 +598,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * Check if the Adjust SDK is currently enabled by calling this function + * * @returns {Promise} */ @Cordova() @@ -610,7 +622,8 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * Function used to get Google AdId - * @return {Promise} Returns a promise with google AdId value + * + * @returns {Promise} Returns a promise with google AdId value */ @Cordova() getGoogleAdId(): Promise { @@ -619,7 +632,8 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * If you need to obtain the Amazon Advertising ID, you can make a call to this function. - * @return {Promise} Returns a promise with anazib adv. ID + * + * @returns {Promise} Returns a promise with anazib adv. ID */ @Cordova() getAmazonAdId(): Promise { @@ -628,7 +642,8 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * To obtain the IDFA, call this function - * @return {Promise} Returns a promise with IDFA string value + * + * @returns {Promise} Returns a promise with IDFA string value */ @Cordova() getIdfa(): Promise { @@ -638,7 +653,8 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * For every device with your app installed on it, the Adjust backend generates a unique Adjust device identifier (adid). * In order to obtain this identifier, call this function - * @return {Promise} Returns a promise with adid value + * + * @returns {Promise} Returns a promise with adid value */ @Cordova() getAdid(): Promise { @@ -647,7 +663,8 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * If you want to access information about a user's current attribution whenever you need it, you can make a call to this function - * @return {Promise} Returns a promise with AdjustAttribution object + * + * @returns {Promise} Returns a promise with AdjustAttribution object */ @Cordova() getAttribution(): Promise { @@ -656,7 +673,8 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * Get the information about version of the SDK used - * @return {Promise} Returns a promise with sdk version information + * + * @returns {Promise} Returns a promise with sdk version information */ @Cordova() getSdkVersion(): Promise { @@ -665,6 +683,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * Method used to add session callback parameters + * * @param key key * @param value value */ @@ -673,6 +692,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * Remove a specific session callback parameter by passing the desiring key to this method + * * @param key key */ @Cordova({ sync: true }) @@ -686,6 +706,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * Method used to add session partner parameters + * * @param key key * @param value value */ @@ -694,6 +715,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * Remove a specific session partner parameter by passing the desiring key to this method + * * @param key key */ @Cordova({ sync: true }) @@ -714,7 +736,8 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * Request Adjust SDK to show pop up dialog for asking user's consent to be tracked. * In order to do this, call this function - * @return {Promise} Returns a promise with user's consent value + * + * @returns {Promise} Returns a promise with user's consent value */ @Cordova() requestTrackingAuthorizationWithCompletionHandler(): Promise { @@ -723,6 +746,7 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * You can update SKAdNetwork conversion value with calling this method + * * @param {number} conversionValue conversion value for the user */ @Cordova({ sync: true }) @@ -730,7 +754,8 @@ export class Adjust extends AwesomeCordovaNativePlugin { /** * To obtain the app tracking authorization status in iOS, call this function - * @return {Promise} Returns a promise with app tracking authorization status + * + * @returns {Promise} Returns a promise with app tracking authorization status */ @Cordova() getAppTrackingAuthorizationStatus(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/admob-pro/index.ts b/src/@awesome-cordova-plugins/plugins/admob-pro/index.ts index 3f07275c..6d1baae4 100644 --- a/src/@awesome-cordova-plugins/plugins/admob-pro/index.ts +++ b/src/@awesome-cordova-plugins/plugins/admob-pro/index.ts @@ -129,7 +129,6 @@ export interface AdExtras { * } * * ``` - * * @interfaces * AdMobOptions * AdExtras @@ -171,6 +170,7 @@ export class AdMobPro extends AwesomeCordovaNativePlugin { /** * Create a banner + * * @param {string | AdMobOptions} adIdOrOptions Ad ID or Options * @returns {Promise} Returns a Promise that resolves when the banner is created */ @@ -189,6 +189,7 @@ export class AdMobPro extends AwesomeCordovaNativePlugin { /** * Show banner at position + * * @param {number} position Position. Use `AdMobPro.AD_POSITION` to set values. */ @Cordova({ @@ -198,6 +199,7 @@ export class AdMobPro extends AwesomeCordovaNativePlugin { /** * Show banner at custom position + * * @param {number} x Offset from screen left. * @param {number} y Offset from screen top. */ @@ -216,6 +218,7 @@ export class AdMobPro extends AwesomeCordovaNativePlugin { /** * Prepare interstitial banner + * * @param {string | AdMobOptions} adIdOrOptions Ad ID or Options * @returns {Promise} Returns a Promise that resolves when interstitial is prepared */ @@ -234,6 +237,7 @@ export class AdMobPro extends AwesomeCordovaNativePlugin { /** * Prepare a reward video ad + * * @param {string | AdMobOptions} adIdOrOptions Ad ID or Options * @returns {Promise} Returns a Promise that resolves when the ad is prepared */ @@ -252,6 +256,7 @@ export class AdMobPro extends AwesomeCordovaNativePlugin { /** * Sets the values for configuration and targeting + * * @param {AdMobOptions} options Options * @returns {Promise} Returns a Promise that resolves when the options have been set */ @@ -262,6 +267,7 @@ export class AdMobPro extends AwesomeCordovaNativePlugin { /** * Get user ad settings + * * @returns {Promise} Returns a promise that resolves with the ad settings */ @Cordova() @@ -271,6 +277,7 @@ export class AdMobPro extends AwesomeCordovaNativePlugin { /** * Triggered when failed to receive Ad + * * @returns {Observable} */ @Cordova({ @@ -284,6 +291,7 @@ export class AdMobPro extends AwesomeCordovaNativePlugin { /** * Triggered when Ad received + * * @returns {Observable} */ @Cordova({ @@ -297,6 +305,7 @@ export class AdMobPro extends AwesomeCordovaNativePlugin { /** * Triggered when Ad will be showed on screen + * * @returns {Observable} */ @Cordova({ @@ -310,6 +319,7 @@ export class AdMobPro extends AwesomeCordovaNativePlugin { /** * Triggered when user click the Ad, and will jump out of your App + * * @returns {Observable} */ @Cordova({ @@ -323,6 +333,7 @@ export class AdMobPro extends AwesomeCordovaNativePlugin { /** * Triggered when dismiss the Ad and back to your App + * * @returns {Observable} */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/admob/index.ts b/src/@awesome-cordova-plugins/plugins/admob/index.ts index 85718c84..8ff984ec 100644 --- a/src/@awesome-cordova-plugins/plugins/admob/index.ts +++ b/src/@awesome-cordova-plugins/plugins/admob/index.ts @@ -135,14 +135,13 @@ export interface AdMobEvent { * Most complete Admob plugin with support for [Tappx](http://www.tappx.com/?h=dec334d63287772de859bdb4e977fce6) ads. * Monetize your apps and games with AdMob ads, using latest Google AdMob SDK. With this plugin you can show AdMob ads easily! * - * **Supports:** + * Supports:** * - Banner ads (top and bottom) * - Interstitial ads * - Rewarded ads * - [Tappx](http://www.tappx.com/?h=dec334d63287772de859bdb4e977fce6) ads - * * @usage - * **Note:** No ads will be served on apps with package name `io.ionic.starter`. This is the default package name for new `ionic` apps. Make sure to rename the package name so ads can be displayed. + * Note:** No ads will be served on apps with package name `io.ionic.starter`. This is the default package name for new `ionic` apps. Make sure to rename the package name so ads can be displayed. * ```typescript * import { Admob, AdmobOptions } from '@awesome-cordova-plugins/admob'; * @@ -295,6 +294,7 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * This enum represents AdMob's supported ad sizes. * Use one of these constants as adSize option when calling createBannerView + * * @readonly */ @CordovaProperty() @@ -308,6 +308,7 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * This enum represents AdMob's supported ad types + * * @readonly */ @CordovaProperty() @@ -320,8 +321,9 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * Set the options to start displaying ads. * Although it is not required to call this method, as options can be specified in other methods, it is highly recommended + * * @param options {AdmobOptions} Some param to configure something - * @return {Promise} Returns a promise that resolves when the options are set + * @returns {Promise} Returns a promise that resolves when the options are set */ @Cordova() setOptions(options: AdmobOptions | AdmobWebOptions): Promise { @@ -330,8 +332,9 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * Creates a new banner ad view. Call this method in order to be able to start showing banners + * * @param options {AdmobOptions} (Optional) Setup options - * @return {Promise} Returns a promise that resolves when the banner view is created + * @returns {Promise} Returns a promise that resolves when the banner view is created */ @Cordova() createBannerView(options?: AdmobOptions | AdmobWebOptions): Promise { @@ -340,8 +343,9 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * Show banner ads. You must call createBannerView first, otherwise it will result in failure callback and no ads will be shown + * * @param show {boolean} (Optional) Indicates whether to show or hide banner ads. Defaults to `true` - * @return {Promise} Returns a promise that resolves when the banner shown or hidden + * @returns {Promise} Returns a promise that resolves when the banner shown or hidden */ @Cordova() showBannerAd(show?: boolean): Promise { @@ -360,8 +364,9 @@ export class Admob extends AwesomeCordovaNativePlugin { * If `options.autoShowInterstitial` is set to `true` (default), the ad will automatically be displayed. * Otherwise you need to subscribe to `onAdLoaded()` event and call `showInterstitialAd()` after it will be raised specifying that an interstitial ad is available. * If you already called `requestInterstitialAd()` but the interstitial has never been shown, the successive calls to `requestInterstitialAd()` will result in the ad being inmediately available (the one that was obtained on the first call) + * * @param options {AdmobOptions} (Optional) Setup options - * @return {Promise} Returns a promise that resolves when the interstitial ad is loaded + * @returns {Promise} Returns a promise that resolves when the interstitial ad is loaded */ @Cordova() requestInterstitialAd(options?: AdmobOptions | AdmobWebOptions): Promise { @@ -370,7 +375,8 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * Show an interstitial ad. Call it after `requestInterstitialAd()` and `onAdLoaded()` event raised. - * @return {Promise} Returns a promise that resolves when the interstitial ad is shown + * + * @returns {Promise} Returns a promise that resolves when the interstitial ad is shown */ @Cordova() showInterstitialAd(): Promise { @@ -382,8 +388,9 @@ export class Admob extends AwesomeCordovaNativePlugin { * If `options.autoShowRewarded` is set to `true` (default), the ad will automatically be displayed. * Otherwise you need to subscribe to `onAdLoaded()` enent and call `showRewardedAd()` after it will be raised specifying that a rewarded ad is available. * If you already called `requestRewardedAd()` but the rewarded has never been shown, the successive calls to `requestRewardedAd()` will result in the ad being inmediately available (the one that was obtained on the first call) + * * @param options {AdmobOptions} (Optional) Setup options - * @return {Promise} Returns a promise that resolves when the rewarded ad is loaded + * @returns {Promise} Returns a promise that resolves when the rewarded ad is loaded */ @Cordova() requestRewardedAd(options?: AdmobOptions | AdmobWebOptions): Promise { @@ -392,7 +399,8 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * Show a rewarded ad - * @return {Promise} Returns a promise that resolves when the rewarded ad is shown + * + * @returns {Promise} Returns a promise that resolves when the rewarded ad is shown */ @Cordova() showRewardedAd(): Promise { @@ -402,13 +410,14 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * Called when an ad is received. * - * *WARNING*: only **ionic^4**. Older versions of ionic, use: + * WARNING*: only **ionic^4**. Older versions of ionic, use: * * ```js * document.addEventListener(window.admob.events.onAdLoaded, () => { }); * ``` * * Please refer to the documentation on https://admob-ionic.com/Events. + * * @returns {Observable} Returns an observable when an ad is received */ @Cordova({ @@ -423,13 +432,14 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * Called when an ad request failed. * - * *WARNING*: only **ionic^4**. Older versions of ionic, use: + * WARNING*: only **ionic^4**. Older versions of ionic, use: * * ```js * document.addEventListener(window.admob.events.onAdFailedToLoad, () => { }); * ``` * * Please refer to the documentation on https://admob-ionic.com/Events. + * * @returns {Observable} Returns an observable when an ad request is failed */ @Cordova({ @@ -445,13 +455,14 @@ export class Admob extends AwesomeCordovaNativePlugin { * Called when an ad opens an overlay that covers the screen. * Please note that onPause cordova event is raised when an interstitial is shown. * - * *WARNING*: only **ionic^4**. Older versions of ionic, use: + * WARNING*: only **ionic^4**. Older versions of ionic, use: * * ```js * document.addEventListener(window.admob.events.onAdOpened, () => { }); * ``` * * Please refer to the documentation on https://admob-ionic.com/Events. + * * @returns {Observable} Returns an observable when an ad is opened */ @Cordova({ @@ -467,13 +478,14 @@ export class Admob extends AwesomeCordovaNativePlugin { * Called when the user is about to return to the application after clicking on an ad. * Please note that onResume cordova event is raised when an interstitial is closed. * - * *WARNING*: only **ionic^4**. Older versions of ionic, use: + * WARNING*: only **ionic^4**. Older versions of ionic, use: * * ```js * document.addEventListener(window.admob.events.onAdClosed, () => { }); * ``` * * Please refer to the documentation on https://admob-ionic.com/Events. + * * @returns {Observable} Returns an observable when an ad is closed */ @Cordova({ @@ -487,9 +499,10 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * Called when the user leaves the application after clicking an ad (e.g., to go to the browser) + * * @returns {Observable} Returns an observable when an ad leaves the application. * - * *WARNING*: only **ionic^4**. Older versions of ionic, use: + * WARNING*: only **ionic^4**. Older versions of ionic, use: * * ```js * document.addEventListener(window.admob.events.onAdLeftApplication, () => { }); @@ -510,13 +523,14 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * Called when the user has been rewarded by an ad. * - * *WARNING*: only **ionic^4**. Older versions of ionic, use: + * WARNING*: only **ionic^4**. Older versions of ionic, use: * * ```js * document.addEventListener(window.admob.events.onRewardedAd, () => { }); * ``` * * Please refer to the documentation on https://admob-ionic.com/Events. + * * @returns {Observable} Returns an observable when the user rewards an ad */ @Cordova({ @@ -531,13 +545,14 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * Called when the video of a rewarded ad started. * - * *WARNING*: only **ionic^4**. Older versions of ionic, use: + * WARNING*: only **ionic^4**. Older versions of ionic, use: * * ```js * document.addEventListener(window.admob.events.onRewardedAdVideoStarted, () => { }); * ``` * * Please refer to the documentation on https://admob-ionic.com/Events. + * * @returns {Observable} Returns an observable when the video is started */ @Cordova({ @@ -552,13 +567,14 @@ export class Admob extends AwesomeCordovaNativePlugin { /** * Called when the video of a rewarded ad has completed. * - * *WARNING*: only **ionic^4**. Older versions of ionic, use: + * WARNING*: only **ionic^4**. Older versions of ionic, use: * * ```js * document.addEventListener(window.admob.events.onRewardedAdVideoCompleted, () => { }); * ``` * * Please refer to the documentation on https://admob-ionic.com/Events. + * * @returns {Observable} Returns an observable when the video is completed */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/aes-256/index.ts b/src/@awesome-cordova-plugins/plugins/aes-256/index.ts index 9ac35aff..7f662227 100644 --- a/src/@awesome-cordova-plugins/plugins/aes-256/index.ts +++ b/src/@awesome-cordova-plugins/plugins/aes-256/index.ts @@ -7,7 +7,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * This cordova ionic plugin allows you to perform AES 256 encryption and decryption on the plain text. * It's a cross-platform plugin which supports both Android and iOS. * The encryption and decryption are performed on the device native layer so that the performance is much faster. - * * @usage * ```typescript * import { AES256 } from '@awesome-cordova-plugins/aes-256/ngx'; @@ -35,12 +34,12 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * .catch((error: any) => console.error(error)); * * - * * this.aes256.generateSecureKey('random password 12345') + * this.aes256.generateSecureKey('random password 12345') * .then(res => console.log('Secure Key : ',res)) * .catch((error: any) => console.error(error)); * * - * * this.aes256.generateSecureIV('random password 12345') + * this.aes256.generateSecureIV('random password 12345') * .then(res => console.log('Secure IV : ',res)) * .catch((error: any) => console.error(error)); * @@ -58,10 +57,11 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class AES256 extends AwesomeCordovaNativePlugin { /** * This function used to perform the aes256 encryption + * * @param {string} secureKey A 32 bytes string, which will used as input key for AES256 encryption. * @param {string} secureIV A 16 bytes string, which will used as initial vector for AES256 encryption. * @param {string} data A string which will be encrypted - * @return {Promise} Returns a promise that resolves when encryption happens. The success response will returns encrypted data. + * @returns {Promise} Returns a promise that resolves when encryption happens. The success response will returns encrypted data. */ @Cordova() encrypt(secureKey: string, secureIV: string, data: string): Promise { @@ -70,10 +70,11 @@ export class AES256 extends AwesomeCordovaNativePlugin { /** * This function used to perform the aes256 decryption + * * @param {string} secureKey A 32 bytes string, which will used as input key for AES256 decryption. * @param {string} secureIV A 16 bytes string, which will used as initial vector for AES256 decryption. * @param {string} data An AES256 encrypted data which will be decrypted. - * @return {Promise} Returns a promise that resolves when decryption happens. The success response will returns decrypted data. + * @returns {Promise} Returns a promise that resolves when decryption happens. The success response will returns decrypted data. */ @Cordova() decrypt(secureKey: string, secureIV: string, data: string): Promise { @@ -83,8 +84,9 @@ export class AES256 extends AwesomeCordovaNativePlugin { /** * This function used to generate a secure key based on an password. Perfect if you want to delegate the key generation for encryption to the plugin. * Make sure to save the return value of this function somewhere so your encrypted data can be decrypted in the future. + * * @param {string} password A random string, which will be used as input for a PBKDF2 function - * @return {Promise} Returns a promise that resolves when key is generated. + * @returns {Promise} Returns a promise that resolves when key is generated. */ @Cordova() generateSecureKey(password: string): Promise { @@ -94,8 +96,9 @@ export class AES256 extends AwesomeCordovaNativePlugin { /** * This function used to generate a secure IV based on an password. Perfect if you want to delegate the IV generation for encryption to the plugin. * Make sure to save the return value of this function somewhere so your encrypted data can be decrypted in the future. + * * @param {string} password A random string, which will be used as input for a PBKDF2 function - * @return {Promise} Returns a promise that resolves when IV is generated. + * @returns {Promise} Returns a promise that resolves when IV is generated. */ @Cordova() generateSecureIV(password: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/all-in-one-sdk/index.ts b/src/@awesome-cordova-plugins/plugins/all-in-one-sdk/index.ts index 5f1a2142..f64cd77c 100644 --- a/src/@awesome-cordova-plugins/plugins/all-in-one-sdk/index.ts +++ b/src/@awesome-cordova-plugins/plugins/all-in-one-sdk/index.ts @@ -16,7 +16,6 @@ import { Observable } from 'rxjs'; * Paytm All-in-One SDK provides a swift, secure and seamless payment experience to your users by invoking the Paytm app (if installed on your user’s smartphone) to complete payment for your order. * Paytm All-in-One SDK enables payment acceptance via Paytm wallet, Paytm Payments Bank, saved Debit/Credit cards, Net Banking, BHIM UPI and EMI as available in your customer’s Paytm account. If Paytm app is not installed on a customer's device, the transaction will be processed via web view within the All-in-One SDK. * For more information about Paytm All-in-One SDK, please visit https://developer.paytm.com/docs/all-in-one-sdk/hybrid-apps/cordova/ - * * @usage * ```typescript * import { AllInOneSDK } from '@awesome-cordova-plugins/all-in-one-sdk/ngx'; @@ -39,7 +38,6 @@ import { Observable } from 'rxjs'; * After adding the plugin, open the iOS project, you can find the same at /platforms/ios. * In case merchant don’t have callback URL, Add an entry into Info.plist LSApplicationQueriesSchemes(Array) Item 0 (String)-> paytm * Add a URL Scheme “paytm”+”MID” - * */ @Plugin({ pluginName: 'AllInOneSDK', @@ -53,8 +51,9 @@ export class AllInOneSDK extends AwesomeCordovaNativePlugin { * This function checks if Paytm Application is available on the device. * If Paytm exists then it invokes Paytm Application with the parameters sent and creates an order. * If the Paytm Application is not available the transaction is continued on a webView within All-in-One SDK. + * * @param options {PaymentIntentModel} These parameters are required and will be used to create an order. - * @return {Promise} Returns a promise that resolves when a transaction completes(both failed and successful). + * @returns {Promise} Returns a promise that resolves when a transaction completes(both failed and successful). */ @Cordova() startTransaction(options: PaymentIntentModel | PaymentAssistIntentModel): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/analytics-firebase/index.ts b/src/@awesome-cordova-plugins/plugins/analytics-firebase/index.ts index 535d0ed9..9671fd40 100644 --- a/src/@awesome-cordova-plugins/plugins/analytics-firebase/index.ts +++ b/src/@awesome-cordova-plugins/plugins/analytics-firebase/index.ts @@ -5,7 +5,6 @@ import { Cordova, CordovaProperty, AwesomeCordovaNativePlugin, Plugin } from '@a * @name Analytics Firebase * @description * Google Analytics Firebase plugin for Ionic Native apps. - * * @usage * ```typescript * import { AnalyticsFirebase } from '@awesome-cordova-plugins/analytics-firebase'; @@ -65,6 +64,7 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin { /** * This enum represents AnalyticsFirebase default events. * Use one of these default events or a custom event + * * @readonly */ @CordovaProperty() @@ -105,6 +105,7 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin { /** * This enum represents AnalyticsFirebase default params. * Use one of these default params or a custom param + * * @readonly */ @CordovaProperty() @@ -168,7 +169,7 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin { * * @param eventName {string} The event name * @param eventParams {object} (Optional) The event params - * @return {Promise} Returns a promise that resolves when the event is logged + * @returns {Promise} Returns a promise that resolves when the event is logged */ @Cordova() logEvent(eventName: string, eventParams?: object): Promise { @@ -177,7 +178,8 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin { /** * Clears all analytics data for this app from the device and resets the app instance id - * @return {Promise} Returns a promise that resolves when the analytics data is cleared + * + * @returns {Promise} Returns a promise that resolves when the analytics data is cleared */ @Cordova() resetAnalyticsData(): Promise { @@ -186,8 +188,10 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin { /** * Sets whether analytics collection is enabled for this app on this device. This setting is persisted across app sessions. By default it is enabled + * * @param screenName {boolean} The value of the collection - * @return {Promise} Returns a promise that resolves when the collection is enabled/disabled + * @param enabled + * @returns {Promise} Returns a promise that resolves when the collection is enabled/disabled */ @Cordova() setAnalyticsCollectionEnabled(enabled: boolean): Promise { @@ -197,8 +201,9 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin { /** * Sets the current screen name, which specifies the current visual context in your app. * This helps identify the areas in your app where users spend their time and how they interact with your app + * * @param screenName {string} The screen name - * @return {Promise} Returns a promise that resolves when the current screen is setted + * @returns {Promise} Returns a promise that resolves when the current screen is setted */ @Cordova() setCurrentScreen(screenName: string): Promise { @@ -207,8 +212,10 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin { /** * Sets the minimum engagement time required before starting a session. The default value is 10000 (10 seconds) + * * @param screenName {number} The duration in milliseconds - * @return {Promise} Returns a promise that resolves when the minimum session duration is set + * @param milliseconds + * @returns {Promise} Returns a promise that resolves when the minimum session duration is set */ @Cordova() setMinimumSessionDuration(milliseconds: number): Promise { @@ -217,8 +224,10 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin { /** * Sets the duration of inactivity that terminates the current session. The default value is 1800000 (30 minutes) + * * @param screenName {number} The duration in milliseconds - * @return {Promise} Returns a promise that resolves when the session timeout duration is set + * @param milliseconds + * @returns {Promise} Returns a promise that resolves when the session timeout duration is set */ @Cordova() setSessionTimeoutDuration(milliseconds: number): Promise { @@ -227,8 +236,9 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin { /** * Sets the user ID property. This feature must be used in accordance with Google's Privacy Policy + * * @param userId {string} The user id - * @return {Promise} Returns a promise that resolves when the user id is setted + * @returns {Promise} Returns a promise that resolves when the user id is setted */ @Cordova() setUserId(userId: string): Promise { @@ -237,9 +247,10 @@ export class AnalyticsFirebase extends AwesomeCordovaNativePlugin { /** * Sets a user property to a given value. Up to 25 user property names are supported. Once set, user property values persist throughout the app lifecycle and across sessions + * * @param userPropertyName {string} The user property name * @param userPropertyValue {string} The user property value - * @return {Promise} Returns a promise that resolves when the user property setted + * @returns {Promise} Returns a promise that resolves when the user property setted */ @Cordova() setUserProperty(userPropertyName: string, userPropertyValue: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/android-exoplayer/index.ts b/src/@awesome-cordova-plugins/plugins/android-exoplayer/index.ts index b036ea54..bda23e87 100644 --- a/src/@awesome-cordova-plugins/plugins/android-exoplayer/index.ts +++ b/src/@awesome-cordova-plugins/plugins/android-exoplayer/index.ts @@ -155,7 +155,6 @@ export interface AndroidExoPlayerControllerConfig { * Cordova media player plugin using Google's ExoPlayer framework. * * https://github.com/google/ExoPlayer - * * @usage * ```typescript * import { AndroidExoPlayer } from '@awesome-cordova-plugins/android-exoplayer/ngx'; @@ -167,7 +166,6 @@ export interface AndroidExoPlayerControllerConfig { * this.androidExoPlayer.show({url: 'http://www.youtube.com/api/manifest/dash/id/bf5bb2419360daf1/source/youtube'}); * * ``` - * * @interfaces * AndroidExoPlayerParams * AndroidExoplayerState @@ -184,8 +182,9 @@ export interface AndroidExoPlayerControllerConfig { export class AndroidExoplayer extends AwesomeCordovaNativePlugin { /** * Show the player. + * * @param {AndroidExoPlayerParams} parameters Parameters - * @return {Observable} + * @returns {Observable} */ @Cordova({ observable: true, @@ -200,9 +199,10 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin { /** * Switch stream without disposing of the player. + * * @param {string} url The url of the new stream. * @param {AndroidExoPlayerControllerConfig} controller Configuration of the controller. - * @return {Promise} + * @returns {Promise} */ @Cordova() setStream(url: string, controller: AndroidExoPlayerControllerConfig): Promise { @@ -211,7 +211,8 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin { /** * Will pause if playing and play if paused - * @return {Promise} + * + * @returns {Promise} */ @Cordova() playPause(): Promise { @@ -220,7 +221,8 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin { /** * Stop playing. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() stop(): Promise { @@ -229,8 +231,9 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin { /** * Jump to a particular position. + * * @param {number} milliseconds Position in stream in milliseconds - * @return {Promise} + * @returns {Promise} */ @Cordova() seekTo(milliseconds: number): Promise { @@ -239,8 +242,9 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin { /** * Jump to a particular time relative to the current position. + * * @param {number} milliseconds Time in milliseconds - * @return {Promise} + * @returns {Promise} */ @Cordova() seekBy(milliseconds: number): Promise { @@ -249,7 +253,8 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin { /** * Get the current player state. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getState(): Promise { @@ -258,7 +263,8 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin { /** * Show the controller. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() showController(): Promise { @@ -267,7 +273,8 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin { /** * Hide the controller. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() hideController(): Promise { @@ -276,8 +283,9 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin { /** * Update the controller configuration. + * * @param {AndroidExoPlayerControllerConfig} controller Configuration of the controller. - * @return {Promise} + * @returns {Promise} */ @Cordova() setController(controller: AndroidExoPlayerControllerConfig): Promise { @@ -286,7 +294,8 @@ export class AndroidExoplayer extends AwesomeCordovaNativePlugin { /** * Close and dispose of player, call before destroy. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() close(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/android-full-screen/index.ts b/src/@awesome-cordova-plugins/plugins/android-full-screen/index.ts index 8fb813fb..26248101 100644 --- a/src/@awesome-cordova-plugins/plugins/android-full-screen/index.ts +++ b/src/@awesome-cordova-plugins/plugins/android-full-screen/index.ts @@ -3,6 +3,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl /** * Bit flag values for setSystemUiVisibility() + * * @see https://developer.android.com/reference/android/view/View.html#setSystemUiVisibility(int) */ export enum AndroidSystemUiFlags { @@ -59,7 +60,8 @@ export enum AndroidSystemUiFlags { export class AndroidFullScreen extends AwesomeCordovaNativePlugin { /** * Is this plugin supported? - * @return {Promise} + * + * @returns {Promise} */ @Cordova() isSupported(): Promise { @@ -68,7 +70,8 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin { /** * Is immersive mode supported? - * @return {Promise} + * + * @returns {Promise} */ @Cordova() isImmersiveModeSupported(): Promise { @@ -77,7 +80,8 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin { /** * The width of the screen in immersive mode. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() immersiveWidth(): Promise { @@ -86,7 +90,8 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin { /** * The height of the screen in immersive mode. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() immersiveHeight(): Promise { @@ -95,7 +100,8 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin { /** * Hide system UI until user interacts. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() leanMode(): Promise { @@ -104,7 +110,8 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin { /** * Show system UI. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() showSystemUI(): Promise { @@ -113,7 +120,8 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin { /** * Extend your app underneath the status bar (Android 4.4+ only). - * @return {Promise} + * + * @returns {Promise} */ @Cordova() showUnderStatusBar(): Promise { @@ -122,7 +130,8 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin { /** * Extend your app underneath the system UI (Android 4.4+ only). - * @return {Promise} + * + * @returns {Promise} */ @Cordova() showUnderSystemUI(): Promise { @@ -131,7 +140,8 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin { /** * Hide system UI and keep it hidden (Android 4.4+ only). - * @return {Promise} + * + * @returns {Promise} */ @Cordova() immersiveMode(): Promise { @@ -140,9 +150,10 @@ export class AndroidFullScreen extends AwesomeCordovaNativePlugin { /** * Manually set the the system UI to a custom mode. This mirrors the Android method of the same name. (Android 4.4+ only). + * * @see https://developer.android.com/reference/android/view/View.html#setSystemUiVisibility(int) * @param {AndroidSystemUiFlags} visibility Bitwise-OR of flags in AndroidSystemUiFlags - * @return {Promise} + * @returns {Promise} */ @Cordova() setSystemUiVisibility(visibility: AndroidSystemUiFlags): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/android-notch/index.ts b/src/@awesome-cordova-plugins/plugins/android-notch/index.ts index 3da3761f..9d83e21e 100644 --- a/src/@awesome-cordova-plugins/plugins/android-notch/index.ts +++ b/src/@awesome-cordova-plugins/plugins/android-notch/index.ts @@ -7,7 +7,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl * This plugin enables developers to get the cutout and android devices inset sizes * It is based on the cordova plugin developed by @tobspr: https://github.com/tobspr/cordova-plugin-android-notch * This plugin works on all android versions, but we can only detect notches starting from Android 9. - * * @usage * ```typescript * import { AndroidNotch } from '@awesome-cordova-plugins/android-notch/ngx'; @@ -52,7 +51,7 @@ export class AndroidNotch extends AwesomeCordovaNativePlugin { /** * Returns true if the android device has cutout * - * @return {Promise} + * @returns {Promise} */ @Cordova() hasCutout(): Promise { @@ -62,7 +61,7 @@ export class AndroidNotch extends AwesomeCordovaNativePlugin { /** * Returns the heigth of the top inset * - * @return {Promise} + * @returns {Promise} */ @Cordova() getInsetTop(): Promise { @@ -72,7 +71,7 @@ export class AndroidNotch extends AwesomeCordovaNativePlugin { /** * Returns the heigth of the right inset * - * @return {Promise} + * @returns {Promise} */ @Cordova() getInsetRight(): Promise { @@ -81,7 +80,8 @@ export class AndroidNotch extends AwesomeCordovaNativePlugin { /** * Returns the heigth of the bottom inset - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getInsetBottom(): Promise { @@ -90,7 +90,8 @@ export class AndroidNotch extends AwesomeCordovaNativePlugin { /** * Returns the heigth of the left inset - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getInsetLeft(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/android-permissions/index.ts b/src/@awesome-cordova-plugins/plugins/android-permissions/index.ts index 3643c30e..8ce69258 100644 --- a/src/@awesome-cordova-plugins/plugins/android-permissions/index.ts +++ b/src/@awesome-cordova-plugins/plugins/android-permissions/index.ts @@ -8,7 +8,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * This plugin is designed to support Android new permissions checking mechanism. * * You can find all permissions here: https://developer.android.com/reference/android/Manifest.permission.html - * * @usage * ``` * import { AndroidPermissions } from '@awesome-cordova-plugins/android-permissions/ngx'; @@ -195,8 +194,9 @@ export class AndroidPermissions extends AwesomeCordovaNativePlugin { /** * Check permission + * * @param {string} permission The name of the permission - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() checkPermission(permission: string): Promise { @@ -205,8 +205,9 @@ export class AndroidPermissions extends AwesomeCordovaNativePlugin { /** * Request permission + * * @param {string} permission The name of the permission to request - * @return {Promise} + * @returns {Promise} */ @Cordova() requestPermission(permission: string): Promise { @@ -215,8 +216,9 @@ export class AndroidPermissions extends AwesomeCordovaNativePlugin { /** * Request permissions + * * @param {string[]} permissions An array with permissions - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() requestPermissions(permissions: string[]): Promise { @@ -225,8 +227,9 @@ export class AndroidPermissions extends AwesomeCordovaNativePlugin { /** * This function still works now, will not support in the future. + * * @param {string} permission The name of the permission - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() hasPermission(permission: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/anyline/index.ts b/src/@awesome-cordova-plugins/plugins/anyline/index.ts index d26226cb..7fcbc4fc 100644 --- a/src/@awesome-cordova-plugins/plugins/anyline/index.ts +++ b/src/@awesome-cordova-plugins/plugins/anyline/index.ts @@ -13,7 +13,6 @@ export interface AnylineOptions { * @name Anyline * @description * Anyline provides an easy-to-use SDK for applications to enable Optical Character Recognition (OCR) on mobile devices. - * * @usage * ```typescript * import { Anyline } from '@awesome-cordova-plugins/anyline/ngx'; @@ -41,8 +40,9 @@ export interface AnylineOptions { export class Anyline extends AwesomeCordovaNativePlugin { /** * Scan + * * @param options {AnylineOptions} Scanning options - * @return {Promise} Returns a promise that resolves when Code is captured + * @returns {Promise} Returns a promise that resolves when Code is captured */ @Cordova() scan(options: AnylineOptions): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/app-availability/index.ts b/src/@awesome-cordova-plugins/plugins/app-availability/index.ts index 7ee12b7f..95e21d0d 100644 --- a/src/@awesome-cordova-plugins/plugins/app-availability/index.ts +++ b/src/@awesome-cordova-plugins/plugins/app-availability/index.ts @@ -7,7 +7,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * This plugin allows you to check if an app is installed on the user's device. It requires an URI Scheme (e.g. twitter://) on iOS or a Package Name (e.g com.twitter.android) on Android. * * Requires Cordova plugin: cordova-plugin-appavailability. For more info, please see the [AppAvailability plugin docs](https://github.com/ohh2ahh/AppAvailability). - * * @usage * ```typescript * import { AppAvailability } from '@awesome-cordova-plugins/app-availability/ngx'; @@ -43,6 +42,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class AppAvailability extends AwesomeCordovaNativePlugin { /** * Checks if an app is available on device + * * @param {string} app Package name on android, or URI scheme on iOS * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/app-center-analytics/index.ts b/src/@awesome-cordova-plugins/plugins/app-center-analytics/index.ts index 376f0a52..9151c36b 100644 --- a/src/@awesome-cordova-plugins/plugins/app-center-analytics/index.ts +++ b/src/@awesome-cordova-plugins/plugins/app-center-analytics/index.ts @@ -14,7 +14,6 @@ export interface StringMap { * All the information captured is available in the App Center portal for you to analyze the data. * * For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/analytics/cordova - * * @usage * ```typescript * import { AppCenterAnalytics } from '@awesome-cordova-plugins/app-center-analytics/ngx'; @@ -47,6 +46,7 @@ export class AppCenterAnalytics extends AwesomeCordovaNativePlugin { * Tracks an custom event. * You can send up to 200 distinct event names. Also, there is a maximum limit of 256 characters per event name * and 64 characters per event property name and event property value. + * * @param {string} eventName Event name * @param {StringMap} properties Event properties * @returns {Promise} @@ -58,6 +58,7 @@ export class AppCenterAnalytics extends AwesomeCordovaNativePlugin { /** * Check if App Center Analytics is enabled + * * @returns {Promise} */ @Cordova() @@ -67,6 +68,7 @@ export class AppCenterAnalytics extends AwesomeCordovaNativePlugin { /** * Enable or disable App Center Analytics at runtime + * * @param {boolean} shouldEnable Set value * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/app-center-crashes/index.ts b/src/@awesome-cordova-plugins/plugins/app-center-crashes/index.ts index b042e5f9..b27e7034 100644 --- a/src/@awesome-cordova-plugins/plugins/app-center-crashes/index.ts +++ b/src/@awesome-cordova-plugins/plugins/app-center-crashes/index.ts @@ -37,7 +37,6 @@ export interface AppCenterCrashReportDevice { * All the information captured is available in the App Center portal for you to analyze the data. * * For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/crashes/cordova - * * @usage * ```typescript * import { AppCenterCrashes } from '@awesome-cordova-plugins/app-center-crashes/ngx'; @@ -70,6 +69,7 @@ export class AppCenterCrashes extends AwesomeCordovaNativePlugin { /** * App Center Crashes provides you with an API to generate a test crash for easy testing of the SDK. * This API can only be used in test/beta apps and won't do anything in production apps. + * * @returns void */ @Cordova() @@ -77,6 +77,7 @@ export class AppCenterCrashes extends AwesomeCordovaNativePlugin { /** * At any time after starting the SDK, you can check if the app crashed in the previous launch + * * @returns {Promise} */ @Cordova() @@ -86,6 +87,7 @@ export class AppCenterCrashes extends AwesomeCordovaNativePlugin { /** * Details about the last crash + * * @returns {Promise} */ @Cordova() @@ -95,6 +97,7 @@ export class AppCenterCrashes extends AwesomeCordovaNativePlugin { /** * Check if App Center Crashes is enabled + * * @returns {Promise} */ @Cordova() @@ -104,6 +107,7 @@ export class AppCenterCrashes extends AwesomeCordovaNativePlugin { /** * Enable or disable App Center Crashes at runtime + * * @param {boolean} shouldEnable Set value * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/app-center-low-memory/index.ts b/src/@awesome-cordova-plugins/plugins/app-center-low-memory/index.ts index 4c04f1d6..a1f3acf1 100644 --- a/src/@awesome-cordova-plugins/plugins/app-center-low-memory/index.ts +++ b/src/@awesome-cordova-plugins/plugins/app-center-low-memory/index.ts @@ -6,7 +6,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @description * Generates a low memory warning. * For more info, please see: https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-generate-low-memory - * * @usage * ```typescript * import { LowMemory } from '@awesome-cordova-plugins/app-center-low-memory/ngx'; @@ -32,6 +31,7 @@ export class LowMemory extends AwesomeCordovaNativePlugin { /** * Generates a low memory warning. * For more info, please see: https://github.com/Microsoft/appcenter-sdk-cordova/tree/master/cordova-plugin-appcenter-generate-low-memory + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/app-center-push/index.ts b/src/@awesome-cordova-plugins/plugins/app-center-push/index.ts index ce7952a0..0561d462 100644 --- a/src/@awesome-cordova-plugins/plugins/app-center-push/index.ts +++ b/src/@awesome-cordova-plugins/plugins/app-center-push/index.ts @@ -7,7 +7,6 @@ import { Observable } from 'rxjs'; * @description * * For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/push/cordova - * * @usage * ```typescript * import { AppCenterPush } from '@awesome-cordova-plugins/app-center-push/ngx'; @@ -36,6 +35,7 @@ import { Observable } from 'rxjs'; export class AppCenterPush extends AwesomeCordovaNativePlugin { /** * Subscribe to an event + * * @param {string} eventName Event name * @returns {Observable} */ @@ -48,6 +48,7 @@ export class AppCenterPush extends AwesomeCordovaNativePlugin { } /** * Check if App Center Push is enabled + * * @returns {Promise} */ @Cordova() @@ -57,6 +58,7 @@ export class AppCenterPush extends AwesomeCordovaNativePlugin { /** * Enable or disable App Center Push at runtime + * * @param {boolean} shouldEnable Set value * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/app-center-shared/index.ts b/src/@awesome-cordova-plugins/plugins/app-center-shared/index.ts index e61db3cd..f2f51ab8 100644 --- a/src/@awesome-cordova-plugins/plugins/app-center-shared/index.ts +++ b/src/@awesome-cordova-plugins/plugins/app-center-shared/index.ts @@ -8,7 +8,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * Exposes additional shared APIs for App Center. * * For more info, please see https://docs.microsoft.com/en-us/appcenter/sdk/other-apis/cordova - * * @usage * ```typescript * import { AppCenter } from '@awesome-cordova-plugins/app-center-shared/ngx'; @@ -42,6 +41,7 @@ export class AppCenter extends AwesomeCordovaNativePlugin { /** * Returns AppCenter UUID. * For more info, please see: https://docs.microsoft.com/en-us/appcenter/sdk/other-apis/cordova#identify-installations + * * @returns {Promise} Install ID */ @Cordova() @@ -52,6 +52,7 @@ export class AppCenter extends AwesomeCordovaNativePlugin { /** * Set a user ID that's used to augment crash reports. * For more info, please see: https://docs.microsoft.com/en-us/appcenter/sdk/other-apis/cordova#identify-users + * * @param {string} userId Ex. "your-user-id" * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/app-preferences/index.ts b/src/@awesome-cordova-plugins/plugins/app-preferences/index.ts index cea192a0..84e8c8cc 100644 --- a/src/@awesome-cordova-plugins/plugins/app-preferences/index.ts +++ b/src/@awesome-cordova-plugins/plugins/app-preferences/index.ts @@ -6,7 +6,6 @@ import { Injectable } from '@angular/core'; * @name App Preferences * @description * This plugin allows you to read and write app preferences - * * @usage * ```typescript * import { AppPreferences } from '@awesome-cordova-plugins/app-preferences/ngx'; @@ -18,7 +17,6 @@ import { Injectable } from '@angular/core'; * this.appPreferences.fetch('key').then((res) => { console.log(res); }); * * ``` - * */ @Plugin({ pluginName: 'AppPreferences', @@ -34,7 +32,7 @@ export class AppPreferences extends AwesomeCordovaNativePlugin { * * @param {string} dict Dictionary for key (OPTIONAL) * @param {string} key Key - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova({ callbackOrder: 'reverse', @@ -49,7 +47,7 @@ export class AppPreferences extends AwesomeCordovaNativePlugin { * @param {string} dict Dictionary for key (OPTIONAL) * @param {string} key Key * @param {any} value Value - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova({ callbackOrder: 'reverse', @@ -63,7 +61,7 @@ export class AppPreferences extends AwesomeCordovaNativePlugin { * * @param {string} dict Dictionary for key (OPTIONAL) * @param {string} key Key - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova({ callbackOrder: 'reverse', @@ -75,7 +73,7 @@ export class AppPreferences extends AwesomeCordovaNativePlugin { /** * Clear preferences * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova({ callbackOrder: 'reverse', @@ -87,7 +85,7 @@ export class AppPreferences extends AwesomeCordovaNativePlugin { /** * Show native preferences interface * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova({ callbackOrder: 'reverse', @@ -100,7 +98,7 @@ export class AppPreferences extends AwesomeCordovaNativePlugin { * Show native preferences interface * * @param {boolean} subscribe true value to subscribe, false - unsubscribe - * @return {Observable} Returns an observable + * @returns {Observable} Returns an observable */ @Cordova({ observable: true, @@ -113,6 +111,7 @@ export class AppPreferences extends AwesomeCordovaNativePlugin { * Return named configuration context * In iOS you'll get a suite configuration, on Android — named file * Supports: Android, iOS + * * @param {string} suiteName suite name * @returns {Object} Custom object, bound to that suite */ @@ -135,6 +134,7 @@ export class AppPreferences extends AwesomeCordovaNativePlugin { /** * Return cloud synchronized configuration context * Currently supports Windows and iOS/macOS + * * @returns {Object} Custom object, bound to that suite */ @Cordova({ @@ -147,6 +147,7 @@ export class AppPreferences extends AwesomeCordovaNativePlugin { /** * Return default configuration context * Currently supports Windows and iOS/macOS + * * @returns {Object} Custom Object, bound to that suite */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/app-rate/index.ts b/src/@awesome-cordova-plugins/plugins/app-rate/index.ts index 12b6aa4c..21703041 100644 --- a/src/@awesome-cordova-plugins/plugins/app-rate/index.ts +++ b/src/@awesome-cordova-plugins/plugins/app-rate/index.ts @@ -205,7 +205,6 @@ export interface AppUrls { * The AppRate plugin makes it easy to prompt the user to rate your app, either now, later, or never. * * Requires Cordova plugin: cordova-plugin-apprate. For more info, please see the [AppRate plugin docs](https://github.com/pushandplay/cordova-plugin-apprate). - * * @usage * ```typescript * import { AppRate } from '@awesome-cordova-plugins/app-rate/ngx'; @@ -236,13 +235,11 @@ export interface AppUrls { * * this.appRate.promptForRating(false); * ``` - * * @interfaces * AppRatePreferences * AppUrls * AppRateCallbacks * AppRateCustomLocal - * */ @Plugin({ pluginName: 'AppRate', @@ -261,7 +258,9 @@ export class AppRate extends AwesomeCordovaNativePlugin { /** * Set preferences - * @return void + * + * @param pref + * @returns void */ @Cordova() setPreferences(pref: AppRatePreferences): void { @@ -270,7 +269,8 @@ export class AppRate extends AwesomeCordovaNativePlugin { /** * Get preferences - * @return AppRatePreferences + * + * @returns AppRatePreferences */ @Cordova() getPreferences(): AppRatePreferences { @@ -279,6 +279,7 @@ export class AppRate extends AwesomeCordovaNativePlugin { /** * Prompts the user for rating + * * @param {boolean} immediately Show the rating prompt immediately. */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/app-version/index.ts b/src/@awesome-cordova-plugins/plugins/app-version/index.ts index b07d1e34..572de460 100644 --- a/src/@awesome-cordova-plugins/plugins/app-version/index.ts +++ b/src/@awesome-cordova-plugins/plugins/app-version/index.ts @@ -8,7 +8,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * Reads the version of your app from the target build settings. * * Requires Cordova plugin: `cordova-plugin-app-version`. For more info, please see the [Cordova App Version docs](https://github.com/whiteoctober/cordova-plugin-app-version). - * * @usage * ```typescript * import { AppVersion } from '@awesome-cordova-plugins/app-version/ngx'; @@ -36,6 +35,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class AppVersion extends AwesomeCordovaNativePlugin { /** * Returns the name of the app, e.g.: "My Awesome App" + * * @returns {Promise} */ @Cordova() @@ -45,6 +45,7 @@ export class AppVersion extends AwesomeCordovaNativePlugin { /** * Returns the package name of the app, e.g.: "com.example.myawesomeapp" + * * @returns {Promise} */ @Cordova() @@ -56,6 +57,7 @@ export class AppVersion extends AwesomeCordovaNativePlugin { * Returns the build identifier of the app. * In iOS a string with the build version like "1.6095" * In Android a number generated from the version string, like 10203 for version "1.2.3" + * * @returns {Promise} */ @Cordova() @@ -65,6 +67,7 @@ export class AppVersion extends AwesomeCordovaNativePlugin { /** * Returns the version of the app, e.g.: "1.2.3" + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/apple-wallet/index.ts b/src/@awesome-cordova-plugins/plugins/apple-wallet/index.ts index 3c25bae6..fd3a0452 100644 --- a/src/@awesome-cordova-plugins/plugins/apple-wallet/index.ts +++ b/src/@awesome-cordova-plugins/plugins/apple-wallet/index.ts @@ -35,7 +35,6 @@ export interface WatchExistData { * @name Apple Wallet * @description * A Cordova plugin that enables users from Add Payment Cards to their Apple Wallet. - * * @usage * ```typescript * import { AppleWallet } from '@awesome-cordova-plugins/apple-wallet/ngx'; @@ -156,7 +155,8 @@ export interface WatchExistData { export class AppleWallet extends AwesomeCordovaNativePlugin { /** * Simple call to determine if the current device supports Apple Pay and has a supported card installed. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() isAvailable(): Promise { @@ -165,8 +165,9 @@ export class AppleWallet extends AwesomeCordovaNativePlugin { /** * Simple call to check Card Eligibility + * * @param {string} primaryAccountIdentifier - * @return {Promise} + * @returns {Promise} */ @Cordova() checkCardEligibility(primaryAccountIdentifier: string): Promise { @@ -175,8 +176,9 @@ export class AppleWallet extends AwesomeCordovaNativePlugin { /** * Simple call to checkCardEligibilityBySuffix + * * @param {string} cardSuffix - * @return {Promise} + * @returns {Promise} */ @Cordova() checkCardEligibilityBySuffix(cardSuffix: string): Promise { @@ -185,7 +187,8 @@ export class AppleWallet extends AwesomeCordovaNativePlugin { /** * Simple call to check out if there is any paired Watches so that you can toggle visibility of 'Add to Watch' button - * @return {Promise} + * + * @returns {Promise} */ @Cordova() checkPairedDevices(): Promise { @@ -194,8 +197,9 @@ export class AppleWallet extends AwesomeCordovaNativePlugin { /** * Simple call to check paired devices with a card by its suffix + * * @param {string} cardSuffix - * @return {Promise} + * @returns {Promise} */ @Cordova() checkPairedDevicesBySuffix(cardSuffix: string): Promise { @@ -204,8 +208,9 @@ export class AppleWallet extends AwesomeCordovaNativePlugin { /** * Simple call with the configuration data needed to instantiate a new PKAddPaymentPassViewController object. + * * @param {cardData} data - * @return {Promise} + * @returns {Promise} */ @Cordova() startAddPaymentPass(data: CardData): Promise { @@ -214,8 +219,9 @@ export class AppleWallet extends AwesomeCordovaNativePlugin { /** * Simple completion handler that takes encrypted card data returned from your server side, in order to get the final response from Apple to know if the card is added succesfully or not. + * * @param {encryptedCardData} data - * @return {Promise} + * @returns {Promise} */ @Cordova() completeAddPaymentPass(data: EncryptedCardData): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/approov-advanced-http/index.ts b/src/@awesome-cordova-plugins/plugins/approov-advanced-http/index.ts index efdcc209..724d8dfd 100644 --- a/src/@awesome-cordova-plugins/plugins/approov-advanced-http/index.ts +++ b/src/@awesome-cordova-plugins/plugins/approov-advanced-http/index.ts @@ -132,7 +132,6 @@ export interface ApproovLoggableToken { * * Note: This plugin extends the pre-existing [cordova-advanced-http-plugin](https://github.com/silkimen/cordova-plugin-advanced-http), * we have only added approov functionality on top of it. All credit goes to the actual plugin developer. - * * @usage * ```typescript * import { ApproovHttp } from '@awesome-cordova-plugins/http/ngx'; @@ -172,6 +171,7 @@ export interface ApproovLoggableToken { export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * This enum represents the internal error codes which can be returned in a HTTPResponse object. + * * @readonly */ @CordovaProperty() @@ -188,6 +188,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * This returns an object representing a basic HTTP Authorization header of the form. + * * @param username {string} Username * @param password {string} Password * @returns {Object} an object representing a basic HTTP Authorization header of the form {'Authorization': 'Basic base64EncodedUsernameAndPassword'} @@ -199,6 +200,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * This sets up all future requests to use Basic HTTP authentication with the given username and password. + * * @param username {string} Username * @param password {string} Password */ @@ -207,6 +209,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Get all headers defined for a given hostname. + * * @param host {string} The hostname * @returns {string} return all headers defined for the hostname */ @@ -217,6 +220,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Set a header for all future requests. Takes a hostname, a header and a value. + * * @param host {string} The hostname to be used for scoping this header * @param header {string} The name of the header * @param value {string} The value of the header @@ -226,6 +230,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Get the name of the data serializer which will be used for all future POST and PUT requests. + * * @returns {string} returns the name of the configured data serializer */ @Cordova({ sync: true }) @@ -235,6 +240,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Set the data serializer which will be used for all future POST, PUT and PATCH requests. Takes a string representing the name of the serializer. + * * @param serializer {string} The name of the serializer. * @see https://github.com/silkimen/cordova-plugin-advanced-http#setdataserializer */ @@ -243,6 +249,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Add a custom cookie. + * * @param url {string} Scope of the cookie * @param cookie {string} RFC compliant cookie string */ @@ -257,6 +264,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Remove cookies for given URL. + * * @param url {string} * @param cb */ @@ -265,6 +273,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Resolve cookie string for given URL. + * * @param url {string} */ @Cordova({ sync: true }) @@ -274,6 +283,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Get global request timeout value in seconds. + * * @returns {number} returns the global request timeout value */ @Cordova({ sync: true }) @@ -283,6 +293,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Set global request timeout value in seconds. + * * @param timeout {number} The timeout in seconds. Default 60 */ @Cordova({ sync: true }) @@ -290,6 +301,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Resolve if it should follow redirects automatically. + * * @returns {boolean} returns true if it is configured to follow redirects automatically */ @Cordova({ sync: true }) @@ -299,6 +311,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Configure if it should follow redirects automatically. + * * @param follow {boolean} Set to false to disable following redirects automatically */ @Cordova({ sync: true }) @@ -310,6 +323,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { * legacy: use legacy default behavior (< 2.0.3), excluding user installed CA certs (only for Android); * nocheck: disable SSL certificate checking and hostname verification, trusting all certs (meant to be used only for testing purposes); * pinned: trust only provided certificates; + * * @see https://github.com/silkimen/cordova-plugin-advanced-http#setservertrustmode * @param {string} mode server trust mode */ @@ -320,6 +334,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make a POST request + * * @param url {string} The url to send the request to * @param body {Object} The body of the request * @param headers {Object} The headers to set for this request @@ -332,6 +347,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make a sync POST request + * * @param url {string} The url to send the request to * @param body {Object} The body of the request * @param headers {Object} The headers to set for this request @@ -355,6 +371,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make a GET request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -367,6 +384,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make a sync GET request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -390,6 +408,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make a PUT request + * * @param url {string} The url to send the request to * @param body {Object} The body of the request * @param headers {Object} The headers to set for this request @@ -402,6 +421,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make a sync PUT request + * * @param url {string} The url to send the request to * @param body {Object} The body of the request * @param headers {Object} The headers to set for this request @@ -425,6 +445,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make a PATCH request + * * @param url {string} The url to send the request to * @param body {Object} The body of the request * @param headers {Object} The headers to set for this request @@ -437,6 +458,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make a sync PATCH request + * * @param url {string} The url to send the request to * @param body {Object} The body of the request * @param headers {Object} The headers to set for this request @@ -460,6 +482,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make a DELETE request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -472,6 +495,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make a sync DELETE request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -495,6 +519,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make a HEAD request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -507,6 +532,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make a sync HEAD request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -530,6 +556,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make an OPTIONS request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -542,6 +569,7 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { /** * Make an sync OPTIONS request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -655,7 +683,6 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { * @param options.filePath {string} file path(s) to be used during upload and download see uploadFile and downloadFile for detailed information * @param options.name {string} name(s) to be used during upload see uploadFile for detailed information * @param options.responseType {string} response type, defaults to text - * * @returns {Promise} returns a promise that will resolve on success, and reject on failure */ @Cordova() @@ -691,7 +718,6 @@ export class ApproovHttp extends AwesomeCordovaNativePlugin { * @param options.responseType {string} response type, defaults to text * @param success {function} A callback that is called when the request succeed * @param failure {function} A callback that is called when the request failed - * * @returns {string} returns a string that represents the requestId */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/appsflyer/index.ts b/src/@awesome-cordova-plugins/plugins/appsflyer/index.ts index 40f2ae9f..be0c3a4e 100644 --- a/src/@awesome-cordova-plugins/plugins/appsflyer/index.ts +++ b/src/@awesome-cordova-plugins/plugins/appsflyer/index.ts @@ -54,7 +54,6 @@ export interface AppsflyerInviteOptions { * @name Appsflyer * @description * Appsflyer Cordova SDK support for Attribution - * * @usage * ```typescript * import { Appsflyer } from '@awesome-cordova-plugins/appsflyer/ngx'; @@ -68,7 +67,6 @@ export interface AppsflyerInviteOptions { * this.appsflyer.initSdk(options); * * ``` - * * @interfaces * AppsflyerOptions * AppsflyerEvent @@ -86,6 +84,7 @@ export interface AppsflyerInviteOptions { export class Appsflyer extends AwesomeCordovaNativePlugin { /** * initialize the SDK + * * @param {AppsflyerOptions} options * @returns {Promise} */ @@ -96,6 +95,7 @@ export class Appsflyer extends AwesomeCordovaNativePlugin { /** * These in-app events help you track how loyal users discover your app, and attribute them to specific campaigns/media-sources. Please take the time define the event/s you want to measure to allow you to track ROI (Return on Investment) and LTV (Lifetime Value). + * * @param {string} eventName custom event name, is presented in your dashboard * @param {AppsflyerEvent} eventValues event details */ @@ -104,6 +104,7 @@ export class Appsflyer extends AwesomeCordovaNativePlugin { /** * Setting your own Custom ID enables you to cross-reference your own unique ID with AppsFlyer’s user ID and the other devices’ IDs. This ID is available in AppsFlyer CSV reports along with postbacks APIs for cross-referencing with you internal IDs. + * * @param {string} customerUserId user id */ @Cordova({ sync: true }) @@ -111,13 +112,16 @@ export class Appsflyer extends AwesomeCordovaNativePlugin { /** * Setting your own Custom ID enables you to cross-reference your own unique ID with AppsFlyer’s user ID and the other devices’ IDs. This ID is available in AppsFlyer CSV reports along with postbacks APIs for cross-referencing with you internal IDs. + * * @param {boolean} customerUserId In some extreme cases you might want to shut down all SDK tracking due to legal and privacy compliance. This can be achieved with the isStopTracking API. Once this API is invoked, our SDK will no longer communicate with our servers and stop functioning. + * @param isStopTracking */ @Cordova({ sync: true }) Stop(isStopTracking: boolean): void {} /** * Get the data from Attribution + * * @returns {Promise} */ @Cordova() @@ -138,6 +142,7 @@ export class Appsflyer extends AwesomeCordovaNativePlugin { /** * Allows to pass GCM/FCM Tokens that where collected by third party plugins to the AppsFlyer server. Can be used for Uninstall Tracking. + * * @param {string} token GCM/FCM ProjectNumber */ @Cordova({ sync: true }) @@ -145,6 +150,7 @@ export class Appsflyer extends AwesomeCordovaNativePlugin { /** * (iOS) Allows to pass APN Tokens that where collected by third party plugins to the AppsFlyer server. Can be used for Uninstall Tracking. + * * @param {string} token APN Token */ @Cordova({ sync: true }) @@ -160,6 +166,7 @@ export class Appsflyer extends AwesomeCordovaNativePlugin { /** * End User Opt-Out (Optional) AppsFlyer provides you a method to opt‐out specific users from AppsFlyer analytics. This method complies with the latest privacy requirements and complies with Facebook data and privacy policies. Default is FALSE, meaning tracking is enabled by default. + * * @param {boolean} disable Set to true to opt-out user from tracking */ @Cordova({ sync: true }) @@ -167,6 +174,7 @@ export class Appsflyer extends AwesomeCordovaNativePlugin { /** * Set AppsFlyer’s OneLink ID. Setting a valid OneLink ID will result in shortened User Invite links, when one is generated. The OneLink ID can be obtained on the AppsFlyer Dashboard. + * * @param {string} oneLinkId OneLink ID */ @Cordova({ sync: true }) @@ -174,6 +182,7 @@ export class Appsflyer extends AwesomeCordovaNativePlugin { /** * Allowing your existing users to invite their friends and contacts as new users to your app can be a key growth factor for your app. AppsFlyer allows you to track and attribute new installs originating from user invites within your app. + * * @param {AppsflyerInviteOptions} options Parameters for Invite link * @returns {Promise} */ @@ -184,6 +193,7 @@ export class Appsflyer extends AwesomeCordovaNativePlugin { /** * Use this call to track an impression use the following API call. Make sure to use the promoted App ID as it appears within the AppsFlyer dashboard. + * * @param {string} appId Promoted Application ID * @param {string} campaign Promoted Campaign */ @@ -192,6 +202,7 @@ export class Appsflyer extends AwesomeCordovaNativePlugin { /** * Use this call to track the click and launch the app store's app page (via Browser) + * * @param {string} appId Promoted Application ID * @param {string} campaign Promoted Campaign * @param {Object} options Additional Parameters to track diff --git a/src/@awesome-cordova-plugins/plugins/background-fetch/index.ts b/src/@awesome-cordova-plugins/plugins/background-fetch/index.ts index 66d8063c..af66e08f 100644 --- a/src/@awesome-cordova-plugins/plugins/background-fetch/index.ts +++ b/src/@awesome-cordova-plugins/plugins/background-fetch/index.ts @@ -14,7 +14,6 @@ export interface BackgroundFetchConfig { * iOS Background Fetch Implementation. See: https://developer.apple.com/reference/uikit/uiapplication#1657399 * iOS Background Fetch is basically an API which wakes up your app about every 15 minutes (during the user's prime-time hours) and provides your app exactly 30s of background running-time. This plugin will execute your provided callbackFn whenever a background-fetch event occurs. There is no way to increase the rate which a fetch-event occurs and this plugin sets the rate to the most frequent possible value of UIApplicationBackgroundFetchIntervalMinimum -- iOS determines the rate automatically based upon device usage and time-of-day (ie: fetch-rate is about ~15min during prime-time hours; less frequently when the user is presumed to be sleeping, at 3am for example). * For more detail, please see https://github.com/transistorsoft/cordova-plugin-background-fetch - * * @usage * * ```typescript @@ -48,7 +47,6 @@ export interface BackgroundFetchConfig { * ``` * @interfaces * BackgroundFetchConfig - * */ @Plugin({ pluginName: 'BackgroundFetch', @@ -63,7 +61,7 @@ export class BackgroundFetch extends AwesomeCordovaNativePlugin { * Configures the plugin's fetch callbackFn * * @param {BackgroundFetchConfig} config Configuration for plugin - * @return {Promise} + * @returns {Promise} */ @Cordova({ callbackOrder: 'reverse', @@ -75,6 +73,7 @@ export class BackgroundFetch extends AwesomeCordovaNativePlugin { /** * Start the background-fetch API. * Your callbackFn provided to #configure will be executed each time a background-fetch event occurs. NOTE the #configure method automatically calls #start. You do not have to call this method after you #configure the plugin + * * @returns {Promise} */ @Cordova() @@ -84,6 +83,7 @@ export class BackgroundFetch extends AwesomeCordovaNativePlugin { /** * Stop the background-fetch API from firing fetch events. Your callbackFn provided to #configure will no longer be executed. + * * @returns {Promise} */ @Cordova() @@ -93,6 +93,8 @@ export class BackgroundFetch extends AwesomeCordovaNativePlugin { /** * You MUST call this method in your fetch callbackFn provided to #configure in order to signal to iOS that your fetch action is complete. iOS provides only 30s of background-time for a fetch-event -- if you exceed this 30s, iOS will kill your app. + * + * @param taskId */ @Cordova({ sync: true, @@ -101,6 +103,7 @@ export class BackgroundFetch extends AwesomeCordovaNativePlugin { /** * Return the status of the background-fetch + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/background-geolocation/index.ts b/src/@awesome-cordova-plugins/plugins/background-geolocation/index.ts index 46895136..471fc20c 100644 --- a/src/@awesome-cordova-plugins/plugins/background-geolocation/index.ts +++ b/src/@awesome-cordova-plugins/plugins/background-geolocation/index.ts @@ -305,6 +305,7 @@ export interface BackgroundGeolocationConfig { * * Platform: Android * Provider: all + * * @default "Background tracking" */ notificationTitle?: string; @@ -493,7 +494,6 @@ export declare enum BackgroundGeolocationIOSActivity { * @description * This plugin provides foreground and background geolocation with battery-saving "circular region monitoring" and "stop detection". For * more detail, please see https://github.com/mauron85/cordova-plugin-background-geolocation - * * @usage * * BackgroundGeolocation must be called within app.ts and or before Geolocation. Otherwise the platform will not ask you for background tracking permission. @@ -551,7 +551,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { * Configure the plugin. * * @param options {BackgroundGeolocationConfig} options An object of type Config - * @return {Promise} + * @returns {Promise} */ @Cordova() configure(options: BackgroundGeolocationConfig): Promise { @@ -561,6 +561,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Turn ON the background-geolocation system. * The user will be tracked whenever they suspend the app. + * * @returns {Promise} */ @Cordova() @@ -570,6 +571,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Turn OFF background-tracking + * * @returns {Promise} */ @Cordova() @@ -579,6 +581,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Inform the native plugin that you're finished, the background-task may be completed + * * @returns {Promise} */ @Cordova({ @@ -590,6 +593,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Force the plugin to enter "moving" or "stationary" state + * * @param isMoving {boolean} * @returns {Promise} */ @@ -602,6 +606,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Setup configuration + * * @param options {BackgroundGeolocationConfig} * @returns {Promise} */ @@ -614,6 +619,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Returns current stationaryLocation if available. null if not + * * @returns {Promise} */ @Cordova({ @@ -626,6 +632,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Add a stationary-region listener. Whenever the devices enters "stationary-mode", * your #success callback will be executed with #location param containing #radius of region + * * @returns {Promise} */ @Cordova({ @@ -637,6 +644,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Check if location is enabled on the device + * * @returns {Promise} Returns a promise with int argument that takes values 0, 1 (true). */ @Cordova({ @@ -662,6 +670,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { * Method can be used to detect user changes in location services settings. * If user enable or disable location services then success callback will be executed. * In case or (SettingNotFoundException) fail callback will be executed. + * * @returns {Observable} */ @Cordova({ @@ -674,6 +683,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Stop watching for location mode changes. + * * @returns {Promise} */ @Cordova({ @@ -690,6 +700,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { * by the system * or * - option.debug is true + * * @returns {Promise} */ @Cordova({ @@ -701,6 +712,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Method will return locations, which has not been yet posted to server. NOTE: Locations does contain locationId. + * * @returns {Promise} */ @Cordova() @@ -710,6 +722,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Delete stored location by given locationId. + * * @param locationId {number} * @returns {Promise} */ @@ -722,6 +735,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Delete all stored locations. + * * @returns {Promise} */ @Cordova({ @@ -753,8 +767,10 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Return all logged events. Useful for plugin debugging. Parameter limit limits number of returned entries. - * @see https://github.com/mauron85/cordova-plugin-background-geolocation/tree/v2.2.1#debugging for more information. * + * @see https://github.com/mauron85/cordova-plugin-background-geolocation/tree/v2.2.1#debugging for more information. + * @param fromId + * @param minLevel * @param limit {number} Limits the number of entries * @returns {Promise} */ @@ -769,8 +785,8 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * Return all logged events. Useful for plugin debugging. Parameter limit limits number of returned entries. - * @see https://github.com/mauron85/cordova-plugin-background-geolocation/tree/v2.2.1#debugging for more information. * + * @see https://github.com/mauron85/cordova-plugin-background-geolocation/tree/v2.2.1#debugging for more information. * @returns {Promise} */ @Cordova() @@ -820,6 +836,8 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { /** * End background task indentified by taskKey (iOS only) + * + * @param taskKey */ @Cordova({ platforms: ['IOS'], @@ -870,6 +888,7 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { * Register event listener. * * Triggered when server responded with "285 Updates Not Required" to post/sync request. + * * @param event * @param callbackFn */ @@ -884,6 +903,8 @@ export class BackgroundGeolocation extends AwesomeCordovaNativePlugin { * Unregister all event listeners for given event. * * If parameter event is not provided then all event listeners will be removed. + * + * @param event */ @Cordova() removeAllListeners(event?: BackgroundGeolocationEvents): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/background-mode/index.ts b/src/@awesome-cordova-plugins/plugins/background-mode/index.ts index 7167030d..742e1355 100644 --- a/src/@awesome-cordova-plugins/plugins/background-mode/index.ts +++ b/src/@awesome-cordova-plugins/plugins/background-mode/index.ts @@ -65,7 +65,6 @@ export interface BackgroundModeConfiguration { * * this.backgroundMode.enable(); * ``` - * * @interfaces * BackgroundModeConfiguration */ @@ -102,8 +101,7 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin { * Enable or disable the background mode. * * @param enable {boolean} The status to set for. - * - * @return {void} + * @returns {void} */ @Cordova({ sync: true, @@ -115,8 +113,7 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin { * * @param event {string} event The event's name. * @param args {array} The callback's arguments. - * - * @return {string} + * @returns {string} */ @Cordova({ sync: true, @@ -127,6 +124,7 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin { /** * Checks if background mode is enabled or not. + * * @returns {boolean} returns a boolean that indicates if the background mode is enabled. */ @Cordova({ @@ -138,6 +136,7 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin { /** * Can be used to get the information if the background mode is active. + * * @returns {boolean} returns a boolean that indicates if the background mode is active. */ @Cordova({ @@ -150,6 +149,7 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin { /** * Overwrite the default settings. * Available only for Android platform. + * * @param overrides {BackgroundModeConfiguration} Dict of options to be overridden. * @returns {Promise} */ @@ -161,6 +161,7 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin { /** * Modify the displayed information. * Available only for Android platform. + * * @param {BackgroundModeConfiguration} [options] Any options you want to update. See table below. */ @Cordova({ @@ -172,6 +173,7 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin { /** * Register callback for given event. * > Available events are `enable`, `disable`, `activate`, `deactivate` and `failure`. + * * @param event {string} Event name * @returns {Observable} */ @@ -186,6 +188,7 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin { /** * Listen for events that the plugin fires. Available events are `enable`, `disable`, `activate`, `deactivate` and `failure`. + * * @param event {string} Event name * @param callback {function} The function to be exec as callback. * @returns {Observable} @@ -242,6 +245,7 @@ export class BackgroundMode extends AwesomeCordovaNativePlugin { /** * If the screen is off. + * * @param fn {function} Callback function to invoke with boolean arg. * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/background-upload/index.ts b/src/@awesome-cordova-plugins/plugins/background-upload/index.ts index 77916a61..d038b1ba 100644 --- a/src/@awesome-cordova-plugins/plugins/background-upload/index.ts +++ b/src/@awesome-cordova-plugins/plugins/background-upload/index.ts @@ -77,7 +77,6 @@ export class FileTransferManager { * @name BackgroundUpload * @description * This plugin does something - * * @usage * ```typescript * import { BackgroundUpload } from '@awesome-cordova-plugins/background-upload/ngx'; diff --git a/src/@awesome-cordova-plugins/plugins/badge/index.ts b/src/@awesome-cordova-plugins/plugins/badge/index.ts index 9216e2ea..d40253a0 100644 --- a/src/@awesome-cordova-plugins/plugins/badge/index.ts +++ b/src/@awesome-cordova-plugins/plugins/badge/index.ts @@ -10,7 +10,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * Requires Cordova plugin: cordova-plugin-badge. For more info, please see the [Badge plugin docs](https://github.com/katzer/cordova-plugin-badge). * * Android Note: Badges have historically only been a feature implemented by third party launchers and not visible unless one of those launchers was being used (E.G. Samsung or Nova Launcher) and if enabled by the user. As of Android 8 (Oreo), [notification badges](https://developer.android.com/training/notify-user/badges) were introduced officially to reflect unread notifications. This plugin is unlikely to work as expected on devices running Android 8 or newer. Please see the [local notifications plugin docs](https://github.com/katzer/cordova-plugin-local-notifications) for more information on badge use with notifications. - * * @usage * ```typescript * import { Badge } from '@awesome-cordova-plugins/badge/ngx'; @@ -35,6 +34,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class Badge extends AwesomeCordovaNativePlugin { /** * Clear the badge of the app icon. + * * @returns {Promise} */ @Cordova() @@ -44,6 +44,7 @@ export class Badge extends AwesomeCordovaNativePlugin { /** * Set the badge of the app icon. + * * @param {number} badgeNumber The new badge number. * @returns {Promise} */ @@ -54,6 +55,7 @@ export class Badge extends AwesomeCordovaNativePlugin { /** * Get the badge of the app icon. + * * @returns {Promise} */ @Cordova() @@ -63,6 +65,7 @@ export class Badge extends AwesomeCordovaNativePlugin { /** * Increase the badge number. + * * @param {number} increaseBy Count to add to the current badge number * @returns {Promise} */ @@ -73,6 +76,7 @@ export class Badge extends AwesomeCordovaNativePlugin { /** * Decrease the badge number. + * * @param {number} decreaseBy Count to subtract from the current badge number * @returns {Promise} */ @@ -83,6 +87,7 @@ export class Badge extends AwesomeCordovaNativePlugin { /** * Check support to show badges. + * * @returns {Promise} */ @Cordova() @@ -92,6 +97,7 @@ export class Badge extends AwesomeCordovaNativePlugin { /** * Determine if the app has permission to show badges. + * * @returns {Promise} */ @Cordova() @@ -101,6 +107,7 @@ export class Badge extends AwesomeCordovaNativePlugin { /** * Register permission to set badge notifications + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/barcode-scanner/index.ts b/src/@awesome-cordova-plugins/plugins/barcode-scanner/index.ts index 1b070720..567653a6 100644 --- a/src/@awesome-cordova-plugins/plugins/barcode-scanner/index.ts +++ b/src/@awesome-cordova-plugins/plugins/barcode-scanner/index.ts @@ -86,7 +86,6 @@ export interface BarcodeScanResult { * The Barcode Scanner Plugin opens a camera view and automatically scans a barcode, returning the data back to you. * * Requires Cordova plugin: `phonegap-plugin-barcodescanner`. For more info, please see the [BarcodeScanner plugin docs](https://github.com/phonegap/phonegap-plugin-barcodescanner). - * * @usage * ```typescript * import { BarcodeScanner } from '@awesome-cordova-plugins/barcode-scanner/ngx'; @@ -129,6 +128,7 @@ export class BarcodeScanner extends AwesomeCordovaNativePlugin { /** * Open the barcode scanner. + * * @param {BarcodeScannerOptions} [options] Optional options to pass to the scanner * @returns {Promise} Returns a Promise that resolves with scanner data, or rejects with an error. */ @@ -142,6 +142,7 @@ export class BarcodeScanner extends AwesomeCordovaNativePlugin { /** * Encodes data into a barcode. * NOTE: not well supported on Android + * * @param {string} type Type of encoding * @param {any} data Data to encode * @returns {Promise} diff --git a/src/@awesome-cordova-plugins/plugins/battery-status/index.ts b/src/@awesome-cordova-plugins/plugins/battery-status/index.ts index 0fc45b25..5fad2840 100644 --- a/src/@awesome-cordova-plugins/plugins/battery-status/index.ts +++ b/src/@awesome-cordova-plugins/plugins/battery-status/index.ts @@ -18,7 +18,6 @@ export interface BatteryStatusResponse { * @name Battery Status * @description * Requires Cordova plugin: cordova-plugin-batterystatus. For more info, please see the [BatteryStatus plugin docs](https://github.com/apache/cordova-plugin-battery-status). - * * @usage * ```typescript * import { BatteryStatus } from '@awesome-cordova-plugins/battery-status/ngx'; @@ -51,6 +50,7 @@ export interface BatteryStatusResponse { export class BatteryStatus extends AwesomeCordovaNativePlugin { /** * Watch the change in battery level + * * @returns {Observable} Returns an observable that pushes a status object */ @Cordova({ @@ -63,6 +63,7 @@ export class BatteryStatus extends AwesomeCordovaNativePlugin { /** * Watch when the battery level goes low + * * @returns {Observable} Returns an observable that pushes a status object */ @Cordova({ @@ -75,6 +76,7 @@ export class BatteryStatus extends AwesomeCordovaNativePlugin { /** * Watch when the battery level goes to critical + * * @returns {Observable} Returns an observable that pushes a status object */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/biocatch/index.ts b/src/@awesome-cordova-plugins/plugins/biocatch/index.ts index 464653cb..42952a14 100644 --- a/src/@awesome-cordova-plugins/plugins/biocatch/index.ts +++ b/src/@awesome-cordova-plugins/plugins/biocatch/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name BioCatch * @description * BioCatch SDK Cordova support - * * @usage * ```typescript * import { BioCatch } from '@awesome-cordova-plugins/biocatch'; @@ -33,10 +32,11 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class BioCatch extends AwesomeCordovaNativePlugin { /** * Start a session + * * @param customerSessionID {String} Customer session id * @param wupUrl {String} WUP server URL * @param publicKey {String} Public Key - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() start(customerSessionID: string | null, wupUrl: string, publicKey: string | null): Promise { @@ -45,7 +45,8 @@ export class BioCatch extends AwesomeCordovaNativePlugin { /** * Pause the session - * @return {Promise} Returns a promise + * + * @returns {Promise} Returns a promise */ @Cordova() pause(): Promise { @@ -54,7 +55,8 @@ export class BioCatch extends AwesomeCordovaNativePlugin { /** * Resume the session - * @return {Promise} Returns a promise + * + * @returns {Promise} Returns a promise */ @Cordova() resume(): Promise { @@ -63,7 +65,8 @@ export class BioCatch extends AwesomeCordovaNativePlugin { /** * Stop the session - * @return {Promise} Returns a promise + * + * @returns {Promise} Returns a promise */ @Cordova() stop(): Promise { @@ -72,7 +75,8 @@ export class BioCatch extends AwesomeCordovaNativePlugin { /** * Reset the session - * @return {Promise} Returns a promise + * + * @returns {Promise} Returns a promise */ @Cordova() resetSession(): Promise { @@ -81,8 +85,9 @@ export class BioCatch extends AwesomeCordovaNativePlugin { /** * Change the session context + * * @param contextName {String} Context name - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() changeContext(contextName: string): Promise { @@ -91,8 +96,9 @@ export class BioCatch extends AwesomeCordovaNativePlugin { /** * Update the customer session ID + * * @param customerSessionID {String} - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() updateCustomerSessionID(customerSessionID: string | null): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/biometric-wrapper/index.ts b/src/@awesome-cordova-plugins/plugins/biometric-wrapper/index.ts index 5e5a109a..bd6c7b0d 100644 --- a/src/@awesome-cordova-plugins/plugins/biometric-wrapper/index.ts +++ b/src/@awesome-cordova-plugins/plugins/biometric-wrapper/index.ts @@ -6,7 +6,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl * @description * This plugin capture biometric(Iris and Fingerprint) and validate the user. * May be used in Banking domain - * * @usage * ```typescript * import { BiometricWrapper } from '@awesome-cordova-plugins/biometric-wrapper/ngx'; @@ -37,7 +36,9 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl export class BiometricWrapper extends AwesomeCordovaNativePlugin { /** * This function activate iris activity - * @return {Promise} Returns a promise that resolves when iris data captured + * + * @param args + * @returns {Promise} Returns a promise that resolves when iris data captured */ @Cordova() activateIris(args: any): Promise { @@ -46,7 +47,9 @@ export class BiometricWrapper extends AwesomeCordovaNativePlugin { /** * This function activate fingerprint activity - * @return {Promise} Returns a promise that resolves when FP data captured + * + * @param args + * @returns {Promise} Returns a promise that resolves when FP data captured */ @Cordova() activateFingerprint(args: any): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/ble/index.ts b/src/@awesome-cordova-plugins/plugins/ble/index.ts index 85b1bd9c..4c47232a 100644 --- a/src/@awesome-cordova-plugins/plugins/ble/index.ts +++ b/src/@awesome-cordova-plugins/plugins/ble/index.ts @@ -23,7 +23,6 @@ export interface BLEScanOptions { * Advertising information is returned when scanning for peripherals. Service, characteristic, and property info is returned when connecting to a peripheral. All access is via service and characteristic UUIDs. The plugin manages handles internally. * * Simultaneous connections to multiple peripherals are supported. - * * @usage * * ```typescript @@ -171,7 +170,6 @@ export interface BLEScanOptions { * ## UUIDs * * UUIDs are always strings and not numbers. Some 16-bit UUIDs, such as '2220' look like integers, but they're not. (The integer 2220 is 0x8AC in hex.) This isn't a problem with 128 bit UUIDs since they look like strings 82b9e6e1-593a-456f-be9b-9215160ebcac. All 16-bit UUIDs should also be passed to methods as strings. - * * @interfaces * BLEScanOptions */ @@ -231,6 +229,7 @@ export class BLE extends AwesomeCordovaNativePlugin { /** * Scans for BLE devices. This function operates similarly to the `startScan` function, but allows you to specify extra options (like allowing duplicate device reports). + * * @param {string[]} services List of service UUIDs to discover, or `[]` to find all devices * @param {BLEScanOptions} options Options * @returns {Observable} Returns an Observable that notifies of each peripheral discovered. @@ -265,6 +264,7 @@ export class BLE extends AwesomeCordovaNativePlugin { /** * Set device pin. + * * @usage * ``` * BLE.setPin(pin).subscribe(success => { @@ -275,7 +275,7 @@ export class BLE extends AwesomeCordovaNativePlugin { * }); * ``` * @param {string} pin Pin of the device as a string - * @return {Observable} Returns an Observable that notifies of success/failure. + * @returns {Observable} Returns an Observable that notifies of success/failure. */ @Cordova({ observable: true, @@ -286,6 +286,7 @@ export class BLE extends AwesomeCordovaNativePlugin { /** * Connect to a peripheral. + * * @usage * ``` * BLE.connect('12:34:56:78:9A:BC').subscribe(peripheralData => { @@ -296,7 +297,7 @@ export class BLE extends AwesomeCordovaNativePlugin { * }); * ``` * @param {string} deviceId UUID or MAC address of the peripheral - * @return {Observable} Returns an Observable that notifies of connect/disconnect. + * @returns {Observable} Returns an Observable that notifies of connect/disconnect. */ @Cordova({ observable: true, @@ -331,8 +332,8 @@ export class BLE extends AwesomeCordovaNativePlugin { * * ``` * @param {string} deviceId UUID or MAC address of the peripheral - * @param {function} connectCallback function that is called with peripheral data when the devices connects - * @param {function} disconnectCallback function that is called with peripheral data when the devices disconnects + * @param {Function} connectCallback function that is called with peripheral data when the devices connects + * @param {Function} disconnectCallback function that is called with peripheral data when the devices disconnects */ @Cordova({ sync: true }) autoConnect(deviceId: string, connectCallback: any, disconnectCallback: any) { @@ -342,6 +343,7 @@ export class BLE extends AwesomeCordovaNativePlugin { /** * Request MTU size. * May be used to fix the Error 14 "Unlikely" on write requests with more than 20 bytes. + * * @usage * ``` * BLE.requestMtu('12:34:56:78:9A:BC', 512).then(() => { @@ -352,7 +354,7 @@ export class BLE extends AwesomeCordovaNativePlugin { * ``` * @param {string} deviceId UUID or MAC address of the peripheral * @param {number} mtuSize The new MTU size. (23 - 517, default is usually 23. Max recommended: 512) - * @return {Promise} Returns a Promise. + * @returns {Promise} Returns a Promise. */ @Cordova() requestMtu(deviceId: string, mtuSize: number): Promise { @@ -364,6 +366,7 @@ export class BLE extends AwesomeCordovaNativePlugin { * This method may fix a issue of old cached services and characteristics. * NOTE Since this uses an undocumented API it's not guaranteed to work. * If you choose a too low delay time (timeoutMillis) the method could fail. + * * @usage * ``` * BLE.refreshDeviceCache('12:34:56:78:9A:BC', 10000).then(discoveredServices => { @@ -374,7 +377,7 @@ export class BLE extends AwesomeCordovaNativePlugin { * ``` * @param {string} deviceId UUID or MAC address of the peripheral * @param {number} timeoutMillis Delay in milliseconds after refresh before discovering services. - * @return {Promise} Returns a Promise. + * @returns {Promise} Returns a Promise. */ @Cordova() refreshDeviceCache(deviceId: string, timeoutMillis: number): Promise { @@ -383,6 +386,7 @@ export class BLE extends AwesomeCordovaNativePlugin { /** * Disconnect from a peripheral. + * * @usage * ``` * BLE.disconnect('12:34:56:78:9A:BC').then(() => { @@ -390,7 +394,7 @@ export class BLE extends AwesomeCordovaNativePlugin { * }); * ``` * @param {string} deviceId UUID or MAC address of the peripheral - * @return {Promise} Returns a Promise + * @returns {Promise} Returns a Promise */ @Cordova() disconnect(deviceId: string): Promise { @@ -403,7 +407,7 @@ export class BLE extends AwesomeCordovaNativePlugin { * @param {string} deviceId UUID or MAC address of the peripheral * @param {string} serviceUUID UUID of the BLE service * @param {string} characteristicUUID UUID of the BLE characteristic - * @return {Promise} Returns a Promise + * @returns {Promise} Returns a Promise */ @Cordova() read(deviceId: string, serviceUUID: string, characteristicUUID: string): Promise { @@ -412,6 +416,7 @@ export class BLE extends AwesomeCordovaNativePlugin { /** * Write the value of a characteristic. + * * @usage * ``` * // send 1 byte to switch a light on @@ -436,7 +441,7 @@ export class BLE extends AwesomeCordovaNativePlugin { * @param {string} serviceUUID UUID of the BLE service * @param {string} characteristicUUID UUID of the BLE characteristic * @param {ArrayBuffer} value Data to write to the characteristic, as an ArrayBuffer. - * @return {Promise} Returns a Promise + * @returns {Promise} Returns a Promise */ @Cordova() write(deviceId: string, serviceUUID: string, characteristicUUID: string, value: ArrayBuffer): Promise { @@ -450,7 +455,7 @@ export class BLE extends AwesomeCordovaNativePlugin { * @param {string} serviceUUID UUID of the BLE service * @param {string} characteristicUUID UUID of the BLE characteristic * @param {ArrayBuffer} value Data to write to the characteristic, as an ArrayBuffer. - * @return {Promise} Returns a Promise + * @returns {Promise} Returns a Promise */ @Cordova() writeWithoutResponse( @@ -471,11 +476,10 @@ export class BLE extends AwesomeCordovaNativePlugin { * console.log(String.fromCharCode.apply(null, new Uint8Array(buffer)); * }); * ``` - * * @param {string} deviceId UUID or MAC address of the peripheral * @param {string} serviceUUID UUID of the BLE service * @param {string} characteristicUUID UUID of the BLE characteristic - * @return {Observable} Returns an Observable that notifies of characteristic changes. + * @returns {Observable} Returns an Observable that notifies of characteristic changes. * The observer emit an array with data at index 0 and sequence order at index 1. * The sequence order is always undefined on iOS. On android it leave the client to check the sequence order and reorder if needed */ @@ -539,8 +543,7 @@ export class BLE extends AwesomeCordovaNativePlugin { * console.log("Bluetooth is " + state); * }); * ``` - * - * @return {Observable} Returns an Observable that notifies when the Bluetooth is enabled or disabled on the device. + * @returns {Observable} Returns an Observable that notifies when the Bluetooth is enabled or disabled on the device. */ @Cordova({ observable: true, @@ -585,7 +588,6 @@ export class BLE extends AwesomeCordovaNativePlugin { * Read the RSSI value on the device connection. * * @param {string} deviceId UUID or MAC address of the peripheral - * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/blinkid/index.ts b/src/@awesome-cordova-plugins/plugins/blinkid/index.ts index 1273bff4..70a96871 100644 --- a/src/@awesome-cordova-plugins/plugins/blinkid/index.ts +++ b/src/@awesome-cordova-plugins/plugins/blinkid/index.ts @@ -176,12 +176,12 @@ export interface OverlaySettings { overlaySettingsType: string; } -export interface BarcodeOverlaySettings extends OverlaySettings {} +export type BarcodeOverlaySettings = OverlaySettings; export interface BarcodeOverlaySettingsCtor { new (): BarcodeOverlaySettings; } -export interface DocumentOverlaySettings extends OverlaySettings {} +export type DocumentOverlaySettings = OverlaySettings; export interface DocumentOverlaySettingsCtor { new (): DocumentOverlaySettings; } @@ -239,7 +239,7 @@ export interface BarcodeRecognizerResult extends RecognizerResult { stringData: string; uncertain: boolean; } -export interface BarcodeRecognizerResultCtor extends RecognizerResultCtor {} +export type BarcodeRecognizerResultCtor = RecognizerResultCtor; export interface BarcodeRecognizer extends Recognizer { autoScaleDetection: boolean; @@ -260,7 +260,7 @@ export interface BarcodeRecognizer extends Recognizer { scanUpce: boolean; slowerThoroughScan: boolean; } -export interface BarcodeRecognizerCtor extends RecognizerCtor {} +export type BarcodeRecognizerCtor = RecognizerCtor; export interface MrzResult { documentType: string; @@ -286,8 +286,7 @@ export interface MrzResult { export interface SuccessFrameGrabberRecognizerResult extends RecognizerResult { successFrame: string; } -export interface SuccessFrameGrabberRecognizerResultCtor - extends RecognizerResultCtor {} +export type SuccessFrameGrabberRecognizerResultCtor = RecognizerResultCtor; export interface SuccessFrameGrabberRecognizer extends Recognizer { slaveRecognizer: Recognizer; @@ -304,7 +303,7 @@ export interface AustraliaDlBackRecognizerResult extends RecognizerResult { lastName: string; licenseNumber: string; } -export interface AustraliaDlBackRecognizerResultCtor extends RecognizerResultCtor {} +export type AustraliaDlBackRecognizerResultCtor = RecognizerResultCtor; export interface AustraliaDlBackRecognizer extends Recognizer { extractAddress: boolean; @@ -313,7 +312,7 @@ export interface AustraliaDlBackRecognizer extends Recognizer {} +export type AustraliaDlBackRecognizerCtor = RecognizerCtor; export interface AustraliaDlFrontRecognizerResult extends RecognizerResult { address: string; @@ -326,7 +325,7 @@ export interface AustraliaDlFrontRecognizerResult extends RecognizerResult { name: string; signatureImage: string; } -export interface AustraliaDlFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type AustraliaDlFrontRecognizerResultCtor = RecognizerResultCtor; export interface AustraliaDlFrontRecognizer extends Recognizer { extractAddress: boolean; @@ -337,7 +336,7 @@ export interface AustraliaDlFrontRecognizer extends Recognizer {} +export type AustraliaDlFrontRecognizerCtor = RecognizerCtor; export interface AustriaCombinedRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -363,7 +362,7 @@ export interface AustriaCombinedRecognizerResult extends RecognizerResult { signatureImage: string; surname: string; } -export interface AustriaCombinedRecognizerResultCtor extends RecognizerResultCtor {} +export type AustriaCombinedRecognizerResultCtor = RecognizerResultCtor; export interface AustriaCombinedRecognizer extends Recognizer { detectGlare: boolean; @@ -388,7 +387,7 @@ export interface AustriaCombinedRecognizer extends Recognizer {} +export type AustriaCombinedRecognizerCtor = RecognizerCtor; export interface AustriaDlFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -404,7 +403,7 @@ export interface AustriaDlFrontRecognizerResult extends RecognizerResult { signatureImage: string; vehicleCategories: string; } -export interface AustriaDlFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type AustriaDlFrontRecognizerResultCtor = RecognizerResultCtor; export interface AustriaDlFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -424,7 +423,7 @@ export interface AustriaDlFrontRecognizer extends Recognizer {} +export type AustriaDlFrontRecognizerCtor = RecognizerCtor; export interface AustriaIdBackRecognizerResult extends RecognizerResult { dateOfIssuance: Date; @@ -437,7 +436,7 @@ export interface AustriaIdBackRecognizerResult extends RecognizerResult { placeOfBirth: string; principalResidence: string; } -export interface AustriaIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type AustriaIdBackRecognizerResultCtor = RecognizerResultCtor; export interface AustriaIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -450,7 +449,7 @@ export interface AustriaIdBackRecognizer extends Recognizer {} +export type AustriaIdBackRecognizerCtor = RecognizerCtor; export interface AustriaIdFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -462,7 +461,7 @@ export interface AustriaIdFrontRecognizerResult extends RecognizerResult { signatureImage: string; surname: string; } -export interface AustriaIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type AustriaIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface AustriaIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -477,7 +476,7 @@ export interface AustriaIdFrontRecognizer extends Recognizer {} +export type AustriaIdFrontRecognizerCtor = RecognizerCtor; export interface AustriaPassportRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -496,7 +495,7 @@ export interface AustriaPassportRecognizerResult extends RecognizerResult { signatureImage: string; surname: string; } -export interface AustriaPassportRecognizerResultCtor extends RecognizerResultCtor {} +export type AustriaPassportRecognizerResultCtor = RecognizerResultCtor; export interface AustriaPassportRecognizer extends Recognizer { detectGlare: boolean; @@ -518,7 +517,7 @@ export interface AustriaPassportRecognizer extends Recognizer {} +export type AustriaPassportRecognizerCtor = RecognizerCtor; export interface ColombiaDlFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -530,7 +529,7 @@ export interface ColombiaDlFrontRecognizerResult extends RecognizerResult { licenseNumber: string; name: string; } -export interface ColombiaDlFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type ColombiaDlFrontRecognizerResultCtor = RecognizerResultCtor; export interface ColombiaDlFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -555,7 +554,7 @@ export interface ColombiaIdBackRecognizerResult extends RecognizerResult { lastName: string; sex: string; } -export interface ColombiaIdBackRecognizerResultCtor extends Recognizer {} +export type ColombiaIdBackRecognizerResultCtor = Recognizer; export interface ColombiaIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -565,7 +564,7 @@ export interface ColombiaIdBackRecognizer extends Recognizer {} +export type ColombiaIdBackRecognizerCtor = RecognizerCtor; export interface ColombiaIdFrontRecognizerResult extends RecognizerResult { documentNumber: string; @@ -575,7 +574,7 @@ export interface ColombiaIdFrontRecognizerResult extends RecognizerResult { lastName: string; signatureImage: string; } -export interface ColombiaIdFrontRecognizerResultCtor extends Recognizer {} +export type ColombiaIdFrontRecognizerResultCtor = Recognizer; export interface ColombiaIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -588,7 +587,7 @@ export interface ColombiaIdFrontRecognizer extends Recognizer {} +export type ColombiaIdFrontRecognizerCtor = RecognizerCtor; export interface CroatiaCombinedRecognizerResult extends RecognizerResult { address: string; @@ -615,7 +614,7 @@ export interface CroatiaCombinedRecognizerResult extends RecognizerResult { sex: string; signatureImage: string; } -export interface CroatiaCombinedRecognizerResultCtor extends RecognizerResultCtor {} +export type CroatiaCombinedRecognizerResultCtor = RecognizerResultCtor; export interface CroatiaCombinedRecognizer extends Recognizer { detectGlare: boolean; @@ -634,7 +633,7 @@ export interface CroatiaIdBackRecognizerResult extends RecognizerResult { mrzResult: MrzResult; residence: string; } -export interface CroatiaIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type CroatiaIdBackRecognizerResultCtor = RecognizerResultCtor; export interface CroatiaIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -660,7 +659,7 @@ export interface CroatiaIdFrontRecognizerResult extends RecognizerResult { sex: string; signatureImage: string; } -export interface CroatiaIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type CroatiaIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface CroatiaIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -685,7 +684,7 @@ export interface CyprusIdBackRecognizerResult extends RecognizerResult { fullDocumentImage: string; sex: string; } -export interface CyprusIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type CyprusIdBackRecognizerResultCtor = RecognizerResultCtor; export interface CyprusIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -695,7 +694,7 @@ export interface CyprusIdBackRecognizer extends Recognizer {} +export type CyprusIdBackRecognizerCtor = RecognizerCtor; export interface CyprusIdFrontRecognizerResult extends RecognizerResult { documentNumber: string; @@ -705,7 +704,7 @@ export interface CyprusIdFrontRecognizerResult extends RecognizerResult { name: string; surname: string; } -export interface CyprusIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type CyprusIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface CyprusIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -718,7 +717,7 @@ export interface CyprusIdFrontRecognizer extends Recognizer {} +export type CyprusIdFrontRecognizerCtor = RecognizerCtor; export interface CzechiaCombinedRecognizerResult extends RecognizerResult { address: string; @@ -743,7 +742,7 @@ export interface CzechiaCombinedRecognizerResult extends RecognizerResult { sex: string; signatureImage: string; } -export interface CzechiaCombinedRecognizerResultCtor extends RecognizerResultCtor {} +export type CzechiaCombinedRecognizerResultCtor = RecognizerResultCtor; export interface CzechiaCombinedRecognizer extends Recognizer { detectGlare: boolean; @@ -772,7 +771,7 @@ export interface CzechiaIdBackRecognizerResult extends RecognizerResult { secondaryId: string; sex: string; } -export interface CzechiaIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type CzechiaIdBackRecognizerResultCtor = RecognizerResultCtor; export interface CzechiaIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -795,7 +794,7 @@ export interface CyprusIdFrontRecognizerResult extends RecognizerResult { sex: string; signatureImage: string; } -export interface CyprusIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type CyprusIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface CyprusIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -810,7 +809,7 @@ export interface CyprusIdFrontRecognizer extends Recognizer {} +export type CyprusIdFrontRecognizerCtor = RecognizerCtor; export interface DocumentFaceRecognizerResult extends RecognizerResult { documentLocation: string; @@ -818,7 +817,7 @@ export interface DocumentFaceRecognizerResult extends RecognizerResult { faceLocation: Quadrilateral; fullDocumentImage: string; } -export interface DocumentFaceRecognizerResultCtor extends RecognizerResultCtor {} +export type DocumentFaceRecognizerResultCtor = RecognizerResultCtor; export interface DocumentFaceRecognizer extends Recognizer { detectorType: DocumentFaceDetectorType.TD1; @@ -835,7 +834,7 @@ export interface EgyptIdFrontRecognizerResult extends RecognizerResult { fullDocumentImage: string; nationalNumber: string; } -export interface EgyptIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type EgyptIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface EgyptIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -843,7 +842,7 @@ export interface EgyptIdFrontRecognizer extends Recognizer {} +export type EgyptIdFrontRecognizerCtor = RecognizerCtor; export interface BlinkCardEliteRecognizerResult extends RecognizerResult { cardNumber: string; @@ -858,7 +857,7 @@ export interface BlinkCardEliteRecognizerResult extends RecognizerResult { scanningFirstSideDone: boolean; validThru: Date; } -export interface BlinkCardEliteRecognizerResultCtor extends RecognizerResultCtor {} +export type BlinkCardEliteRecognizerResultCtor = RecognizerResultCtor; export interface BlinkCardEliteRecognizer extends Recognizer { anonymizeCardNumber: boolean; @@ -873,7 +872,7 @@ export interface BlinkCardEliteRecognizer extends Recognizer {} +export type BlinkCardEliteRecognizerCtor = RecognizerCtor; export interface EudlRecognizerResult extends RecognizerResult { address: string; @@ -889,7 +888,7 @@ export interface EudlRecognizerResult extends RecognizerResult { lastName: string; personalNumber: string; } -export interface EudlRecognizerResultCtor extends RecognizerResultCtor {} +export type EudlRecognizerResultCtor = RecognizerResultCtor; export interface EudlRecognizer extends Recognizer { country: EudlCountry.Automatic; @@ -930,7 +929,7 @@ export interface GermanyCombinedRecognizerResult extends RecognizerResult { sex: boolean; signatureImage: string; } -export interface GermanyCombinedRecognizerResultCtor extends RecognizerResultCtor {} +export type GermanyCombinedRecognizerResultCtor = RecognizerResultCtor; export interface GermanyCombinedRecognizer extends Recognizer { detectGlare: boolean; @@ -941,14 +940,14 @@ export interface GermanyCombinedRecognizer extends Recognizer {} +export type GermanyCombinedRecognizerCtor = RecognizerCtor; export interface GermanyDlBackRecognizerResult extends RecognizerResult { dateOfIssueB10: string; dateOfIssueB10NotSpecified: boolean; fullDocumentImage: string; } -export interface GermanyDlBackRecognizerResultCtor extends RecognizerResultCtor {} +export type GermanyDlBackRecognizerResultCtor = RecognizerResultCtor; export interface GermanyDlBackRecognizer extends Recognizer { detectGlare: boolean; @@ -956,7 +955,7 @@ export interface GermanyDlBackRecognizer extends Recognizer {} +export type GermanyDlBackRecognizerCtor = RecognizerCtor; export interface GermanyIdBackRecognizerResult extends RecognizerResult { address: string; @@ -984,7 +983,7 @@ export interface GermanyIdBackRecognizerResult extends RecognizerResult { secondaryId: string; sex: string; } -export interface GermanyIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type GermanyIdBackRecognizerResultCtor = RecognizerResultCtor; export interface GermanyIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -995,7 +994,7 @@ export interface GermanyIdBackRecognizer extends Recognizer {} +export type GermanyIdBackRecognizerCtor = RecognizerCtor; export interface GermanyIdFrontRecognizerResult extends RecognizerResult { canNumber: string; @@ -1010,7 +1009,7 @@ export interface GermanyIdFrontRecognizerResult extends RecognizerResult { signatureImage: string; surname: string; } -export interface GermanyIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type GermanyIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface GermanyIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1029,7 +1028,7 @@ export interface GermanyIdFrontRecognizer extends Recognizer {} +export type GermanyIdFrontRecognizerCtor = RecognizerCtor; export interface GermanyOldIdRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -1051,7 +1050,7 @@ export interface GermanyOldIdRecognizerResult extends RecognizerResult { sex: string; signatureImage: string; } -export interface GermanyOldIdRecognizerResultCtor extends RecognizerResultCtor {} +export type GermanyOldIdRecognizerResultCtor = RecognizerResultCtor; export interface GermanyOldIdRecognizer extends Recognizer { detectGlare: boolean; @@ -1061,7 +1060,7 @@ export interface GermanyOldIdRecognizer extends Recognizer {} +export type GermanyOldIdRecognizerCtor = RecognizerCtor; export interface GermanyPassportRecognizerResult extends RecognizerResult { authority: string; @@ -1087,7 +1086,7 @@ export interface GermanyPassportRecognizerResult extends RecognizerResult { signatureImage: string; surname: string; } -export interface GermanyPassportRecognizerResultCtor extends RecognizerResultCtor {} +export type GermanyPassportRecognizerResultCtor = RecognizerResultCtor; export interface GermanyPassportRecognizer extends Recognizer { detectGlare: boolean; @@ -1102,7 +1101,7 @@ export interface GermanyPassportRecognizer extends Recognizer {} +export type GermanyPassportRecognizerCtor = RecognizerCtor; export interface HongKongIdFrontRecognizerResult extends RecognizerResult { commercialCode: string; @@ -1115,7 +1114,7 @@ export interface HongKongIdFrontRecognizerResult extends RecognizerResult { residentialStatus: string; sex: string; } -export interface HongKongIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type HongKongIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface HongKongIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1130,7 +1129,7 @@ export interface HongKongIdFrontRecognizer extends Recognizer {} +export type HongKongIdFrontRecognizerCtor = RecognizerCtor; export interface IkadRecognizerResult extends RecognizerResult { address: string; @@ -1146,7 +1145,7 @@ export interface IkadRecognizerResult extends RecognizerResult { sectory: string; sex: string; } -export interface IkadRecognizerResultCtor extends RecognizerResultCtor {} +export type IkadRecognizerResultCtor = RecognizerResultCtor; export interface IkadRecognizer extends Recognizer { detectGlare: boolean; @@ -1161,7 +1160,7 @@ export interface IkadRecognizer extends Recognizer { returnFaceImage: boolean; returnFullDocumentImage: boolean; } -export interface IkadRecognizerCtor extends RecognizerCtor {} +export type IkadRecognizerCtor = RecognizerCtor; export interface IndonesiaIdFrontRecognizerResult extends RecognizerResult { address: string; @@ -1187,7 +1186,7 @@ export interface IndonesiaIdFrontRecognizerResult extends RecognizerResult { sex: string; signatureImage: string; } -export interface IndonesiaIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type IndonesiaIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface IndonesiaIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1213,7 +1212,7 @@ export interface IndonesiaIdFrontRecognizer extends Recognizer {} +export type IndonesiaIdFrontRecognizerCtor = RecognizerCtor; export interface IrelandDlFrontRecognizerResult extends RecognizerResult { address: string; @@ -1233,7 +1232,7 @@ export interface IrelandDlFrontRecognizerResult extends RecognizerResult { signatureImage: string; surname: string; } -export interface IrelandDlFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type IrelandDlFrontRecognizerResultCtor = RecognizerResultCtor; export interface IrelandDlFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1255,7 +1254,7 @@ export interface IrelandDlFrontRecognizer extends Recognizer {} +export type IrelandDlFrontRecognizerCtor = RecognizerCtor; export interface ItalyDlFrontRecognizerResult extends RecognizerResult { address: string; @@ -1275,7 +1274,7 @@ export interface ItalyDlFrontRecognizerResult extends RecognizerResult { signatureImage: string; surname: string; } -export interface ItalyDlFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type ItalyDlFrontRecognizerResultCtor = RecognizerResultCtor; export interface ItalyDlFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1296,7 +1295,7 @@ export interface ItalyDlFrontRecognizer extends Recognizer {} +export type ItalyDlFrontRecognizerCtor = RecognizerCtor; export interface JordanCombinedRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -1316,13 +1315,13 @@ export interface JordanCombinedRecognizerResult extends RecognizerResult { scanningFirstSideDone: boolean; sex: string; } -export interface JordanCombinedRecognizerResultCtor extends RecognizerResultCtor {} +export type JordanCombinedRecognizerResultCtor = RecognizerResultCtor; export interface JordanCombinedRecognizer extends Recognizer { detectGlare: boolean; returnFullDocumentImage: boolean; } -export interface JordanCombinedRecognizerCtor extends RecognizerCtor {} +export type JordanCombinedRecognizerCtor = RecognizerCtor; export interface JordanIdBackRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -1341,7 +1340,7 @@ export interface JordanIdBackRecognizerResult extends RecognizerResult { secondaryId: string; sex: string; } -export interface JordanIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type JordanIdBackRecognizerResultCtor = RecognizerResultCtor; export interface JordanIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -1352,7 +1351,7 @@ export interface JordanIdBackRecognizer extends Recognizer {} +export type JordanIdBackRecognizerCtor = RecognizerCtor; export interface JordanIdFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -1362,7 +1361,7 @@ export interface JordanIdFrontRecognizerResult extends RecognizerResult { nationalNumber: string; sex: string; } -export interface JordanIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type JordanIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface JordanIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1373,14 +1372,14 @@ export interface JordanIdFrontRecognizer extends Recognizer {} +export type JordanIdFrontRecognizerCtor = RecognizerCtor; export interface KuwaitIdBackRecognizerResult extends RecognizerResult { fullDocumentImage: string; mrzResult: MrzResult; serialNo: string; } -export interface KuwaitIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type KuwaitIdBackRecognizerResultCtor = RecognizerResultCtor; export interface KuwaitIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -1389,7 +1388,7 @@ export interface KuwaitIdBackRecognizer extends Recognizer {} +export type KuwaitIdBackRecognizerCtor = RecognizerCtor; export interface KuwaitIdFrontRecognizerResult extends RecognizerResult { birthData: Date; @@ -1401,7 +1400,7 @@ export interface KuwaitIdFrontRecognizerResult extends RecognizerResult { nationality: string; sex: string; } -export interface KuwaitIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type KuwaitIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface KuwaitIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1415,7 +1414,7 @@ export interface KuwaitIdFrontRecognizer extends Recognizer {} +export type KuwaitIdFrontRecognizerCtor = RecognizerCtor; export interface MalaysiaDlFrontRecognizerResult extends RecognizerResult { city: string; @@ -1432,7 +1431,7 @@ export interface MalaysiaDlFrontRecognizerResult extends RecognizerResult { validUntil: Date; zipcode: string; } -export interface MalaysiaDlFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type MalaysiaDlFrontRecognizerResultCtor = RecognizerResultCtor; export interface MalaysiaDlFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1448,7 +1447,7 @@ export interface MalaysiaDlFrontRecognizer extends Recognizer {} +export type MalaysiaDlFrontRecognizerCtor = RecognizerCtor; export interface MalaysiaMyTenteraRecognizerResult extends RecognizerResult { armyNumber: string; @@ -1465,8 +1464,7 @@ export interface MalaysiaMyTenteraRecognizerResult extends RecognizerResult { street: string; zipcode: string; } -export interface MalaysiaMyTenteraRecognizerResultCtor - extends RecognizerResultCtor {} +export type MalaysiaMyTenteraRecognizerResultCtor = RecognizerResultCtor; export interface MalaysiaMyTenteraRecognizer extends Recognizer { detectGlare: boolean; @@ -1478,7 +1476,7 @@ export interface MalaysiaMyTenteraRecognizer extends Recognizer {} +export type MalaysiaMyTenteraRecognizerCtor = RecognizerCtor; export interface MexicoVoterIdFrontRecognizerResult extends RecognizerResult { address: string; @@ -1491,8 +1489,7 @@ export interface MexicoVoterIdFrontRecognizerResult extends RecognizerResult { sex: string; signatureImage: string; } -export interface MexicoVoterIdFrontRecognizerResultCtor - extends RecognizerResultCtor {} +export type MexicoVoterIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface MexicoVoterIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1507,7 +1504,7 @@ export interface MexicoVoterIdFrontRecognizer extends Recognizer {} +export type MexicoVoterIdFrontRecognizerCtor = RecognizerCtor; export interface MoroccoIdBackRecognizerResult extends RecognizerResult { address: string; @@ -1519,7 +1516,7 @@ export interface MoroccoIdBackRecognizerResult extends RecognizerResult { mothersName: string; sex: string; } -export interface MoroccoIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type MoroccoIdBackRecognizerResultCtor = RecognizerResultCtor; export interface MoroccoIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -1533,7 +1530,7 @@ export interface MoroccoIdBackRecognizer extends Recognizer {} +export type MoroccoIdBackRecognizerCtor = RecognizerCtor; export interface MoroccoIdFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -1547,7 +1544,7 @@ export interface MoroccoIdFrontRecognizerResult extends RecognizerResult { signatureImage: string; surname: string; } -export interface MoroccoIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type MoroccoIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface MoroccoIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1565,7 +1562,7 @@ export interface MoroccoIdFrontRecognizer extends Recognizer {} +export type MoroccoIdFrontRecognizerCtor = RecognizerCtor; export interface MrtdCombinedRecognizerResult extends RecognizerResult { alienNumber: string; @@ -1595,7 +1592,7 @@ export interface MrtdCombinedRecognizerResult extends RecognizerResult { secondaryId: string; sex: string; } -export interface MrtdCombinedRecognizerResultCtor extends RecognizerResultCtor {} +export type MrtdCombinedRecognizerResultCtor = RecognizerResultCtor; export interface MrtdCombinedRecognizer extends Recognizer { allowUnparsedResults: boolean; @@ -1606,14 +1603,14 @@ export interface MrtdCombinedRecognizer extends Recognizer {} +export type MrtdCombinedRecognizerCtor = RecognizerCtor; export interface MrtdRecognizerResult extends RecognizerResult { fullDocumentImage: string; mrzImage: string; mrzResult: MrzResult; } -export interface MrtdRecognizerResultCtor extends RecognizerResultCtor {} +export type MrtdRecognizerResultCtor = RecognizerResultCtor; export interface MrtdRecognizer extends Recognizer { allowUnparsedResults: boolean; @@ -1623,7 +1620,7 @@ export interface MrtdRecognizer extends Recognizer { returnMrzImage: boolean; saveImageDPI: number; } -export interface MrtdRecognizerCtor extends RecognizerCtor {} +export type MrtdRecognizerCtor = RecognizerCtor; export interface MyKadBackRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -1634,7 +1631,7 @@ export interface MyKadBackRecognizerResult extends RecognizerResult { sex: string; signatureImage: string; } -export interface MyKadBackRecognizerResultCtor extends RecognizerResultCtor {} +export type MyKadBackRecognizerResultCtor = RecognizerResultCtor; export interface MyKadBackRecognizer extends Recognizer { detectGlare: boolean; @@ -1645,7 +1642,7 @@ export interface MyKadBackRecognizer extends Recognizer {} +export type MyKadBackRecognizerCtor = RecognizerCtor; export interface MyKadFrontRecognizerResult extends RecognizerResult { armyNumber: string; @@ -1662,7 +1659,7 @@ export interface MyKadFrontRecognizerResult extends RecognizerResult { ownerReligion: string; ownerSex: string; } -export interface MyKadFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type MyKadFrontRecognizerResultCtor = RecognizerResultCtor; export interface MyKadFrontRecognizer extends Recognizer { extractArmyNumber: boolean; @@ -1670,7 +1667,7 @@ export interface MyKadFrontRecognizer extends Recognizer {} +export type MyKadFrontRecognizerCtor = RecognizerCtor; export interface NewZealandDlFrontRecognizerResult extends RecognizerResult { address: string; @@ -1686,8 +1683,7 @@ export interface NewZealandDlFrontRecognizerResult extends RecognizerResult { signatureImage: string; surname: string; } -export interface NewZealandDlFrontRecognizerResultCtor - extends RecognizerResultCtor {} +export type NewZealandDlFrontRecognizerResultCtor = RecognizerResultCtor; export interface NewZealandDlFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1706,7 +1702,7 @@ export interface NewZealandDlFrontRecognizer extends Recognizer {} +export type NewZealandDlFrontRecognizerCtor = RecognizerCtor; export interface BlinkCardRecognizerResult extends RecognizerResult { cardNumber: string; @@ -1722,7 +1718,7 @@ export interface BlinkCardRecognizerResult extends RecognizerResult { scanningFirstSideDone: boolean; validThru: Date; } -export interface BlinkCardRecognizerResultCtor extends RecognizerResultCtor {} +export type BlinkCardRecognizerResultCtor = RecognizerResultCtor; export interface BlinkCardRecognizer extends Recognizer { anonymizeCardNumber: boolean; @@ -1738,7 +1734,7 @@ export interface BlinkCardRecognizer extends Recognizer {} +export type BlinkCardRecognizerCtor = RecognizerCtor; export interface Pdf417RecognizerResult extends RecognizerResult { barcodeType: string; @@ -1746,14 +1742,14 @@ export interface Pdf417RecognizerResult extends RecognizerResult { stringData: string; uncertain: boolean; } -export interface Pdf417RecognizerResultCtor extends RecognizerResultCtor {} +export type Pdf417RecognizerResultCtor = RecognizerResultCtor; export interface Pdf417Recognizer extends Recognizer { nullQuietZoneAllowed: boolean; scanInverse: boolean; scanUncertain: boolean; } -export interface Pdf417RecognizerCtor extends RecognizerCtor {} +export type Pdf417RecognizerCtor = RecognizerCtor; export interface PolandCombinedRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -1776,7 +1772,7 @@ export interface PolandCombinedRecognizerResult extends RecognizerResult { sex: string; surname: string; } -export interface PolandCombinedRecognizerResultCtor extends RecognizerResultCtor {} +export type PolandCombinedRecognizerResultCtor = RecognizerResultCtor; export interface PolandCombinedRecognizer extends Recognizer { detectGlare: boolean; @@ -1790,7 +1786,7 @@ export interface PolandCombinedRecognizer extends Recognizer {} +export type PolandCombinedRecognizerCtor = RecognizerCtor; export interface PolandIdBackRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -1809,13 +1805,13 @@ export interface PolandIdBackRecognizerResult extends RecognizerResult { secondaryId: string; sex: string; } -export interface PolandIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type PolandIdBackRecognizerResultCtor = RecognizerResultCtor; export interface PolandIdBackRecognizer extends Recognizer { detectGlare: boolean; returnFullDocumentImage: boolean; } -export interface PolandIdBackRecognizerCtor extends RecognizerCtor {} +export type PolandIdBackRecognizerCtor = RecognizerCtor; export interface PolandIdFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -1827,7 +1823,7 @@ export interface PolandIdFrontRecognizerResult extends RecognizerResult { sex: string; surname: string; } -export interface PolandIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type PolandIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface PolandIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1840,7 +1836,7 @@ export interface PolandIdFrontRecognizer extends Recognizer {} +export type PolandIdFrontRecognizerCtor = RecognizerCtor; export interface RomaniaIdFrontRecognizerResult extends RecognizerResult { address: string; @@ -1873,7 +1869,7 @@ export interface RomaniaIdFrontRecognizerResult extends RecognizerResult { validFrom: Date; validUntil: Date; } -export interface RomaniaIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type RomaniaIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface RomaniaIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1888,7 +1884,7 @@ export interface RomaniaIdFrontRecognizer extends Recognizer {} +export type RomaniaIdFrontRecognizerCtor = RecognizerCtor; export interface SerbiaCombinedRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -1911,7 +1907,7 @@ export interface SerbiaCombinedRecognizerResult extends RecognizerResult { sex: string; signatureImage: string; } -export interface SerbiaCombinedRecognizerResultCtor extends RecognizerResultCtor {} +export type SerbiaCombinedRecognizerResultCtor = RecognizerResultCtor; export interface SerbiaCombinedRecognizer extends Recognizer { detectGlare: boolean; @@ -1920,7 +1916,7 @@ export interface SerbiaCombinedRecognizer extends Recognizer {} +export type SerbiaCombinedRecognizerCtor = RecognizerCtor; export interface SerbiaIdBackRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -1939,13 +1935,13 @@ export interface SerbiaIdBackRecognizerResult extends RecognizerResult { secondaryId: string; sex: string; } -export interface SerbiaIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type SerbiaIdBackRecognizerResultCtor = RecognizerResultCtor; export interface SerbiaIdBackRecognizer extends Recognizer { detectGlare: boolean; returnFullDocumentImage: boolean; } -export interface SerbiaIdBackRecognizerCtor extends RecognizerCtor {} +export type SerbiaIdBackRecognizerCtor = RecognizerCtor; export interface SerbiaIdFrontRecognizerResult extends RecognizerResult { documentNumber: string; @@ -1956,7 +1952,7 @@ export interface SerbiaIdFrontRecognizerResult extends RecognizerResult { validThru: Date; validUntil: Date; } -export interface SerbiaIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type SerbiaIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface SerbiaIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -1966,15 +1962,15 @@ export interface SerbiaIdFrontRecognizer extends Recognizer {} +export type SerbiaIdFrontRecognizerCtor = RecognizerCtor; export interface SimNumberRecognizerResult extends RecognizerResult { simNumber: string; } -export interface SimNumberRecognizerResultCtor extends RecognizerResultCtor {} +export type SimNumberRecognizerResultCtor = RecognizerResultCtor; -export interface SimNumberRecognizer extends Recognizer {} -export interface SimNumberRecognizerCtor extends RecognizerCtor {} +export type SimNumberRecognizer = Recognizer; +export type SimNumberRecognizerCtor = RecognizerCtor; export interface SingaporeChangiEmployeeIdRecognizerResult extends RecognizerResult { companyName: string; @@ -1984,8 +1980,8 @@ export interface SingaporeChangiEmployeeIdRecognizerResult extends RecognizerRes fullDocumentImage: string; name: string; } -export interface SingaporeChangiEmployeeIdRecognizerResultCtor - extends RecognizerResultCtor {} +export type SingaporeChangiEmployeeIdRecognizerResultCtor = + RecognizerResultCtor; export interface SingaporeChangiEmployeeIdRecognizer extends Recognizer { detectGlare: boolean; @@ -1998,7 +1994,7 @@ export interface SingaporeChangiEmployeeIdRecognizer extends Recognizer {} +export type SingaporeChangiEmployeeIdRecognizerCtor = RecognizerCtor; export interface SingaporeCombinedRecognizerResult extends RecognizerResult { address: string; @@ -2019,8 +2015,7 @@ export interface SingaporeCombinedRecognizerResult extends RecognizerResult { scanningFirstSideDone: string; sex: string; } -export interface SingaporeCombinedRecognizerResultCtor - extends RecognizerResultCtor {} +export type SingaporeCombinedRecognizerResultCtor = RecognizerResultCtor; export interface SingaporeCombinedRecognizer extends Recognizer { detectGlare: boolean; @@ -2040,7 +2035,7 @@ export interface SingaporeCombinedRecognizer extends Recognizer {} +export type SingaporeCombinedRecognizerCtor = RecognizerCtor; export interface SingaporeDlFrontRecognizerResult extends RecognizerResult { birthData: Date; @@ -2051,7 +2046,7 @@ export interface SingaporeDlFrontRecognizerResult extends RecognizerResult { name: string; validTill: Date; } -export interface SingaporeDlFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type SingaporeDlFrontRecognizerResultCtor = RecognizerResultCtor; export interface SingaporeDlFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -2065,7 +2060,7 @@ export interface SingaporeDlFrontRecognizer extends Recognizer {} +export type SingaporeDlFrontRecognizerCtor = RecognizerCtor; export interface SingaporeIdBackRecognizerResult extends RecognizerResult { address: string; @@ -2075,7 +2070,7 @@ export interface SingaporeIdBackRecognizerResult extends RecognizerResult { dateOfIssue: Date; fullDocumentImage: string; } -export interface SingaporeIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type SingaporeIdBackRecognizerResultCtor = RecognizerResultCtor; export interface SingaporeIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -2087,7 +2082,7 @@ export interface SingaporeIdBackRecognizer extends Recognizer {} +export type SingaporeIdBackRecognizerCtor = RecognizerCtor; export interface SingaporeIdFrontRecognizerResult extends RecognizerResult { countryOfBirth: string; @@ -2099,7 +2094,7 @@ export interface SingaporeIdFrontRecognizerResult extends RecognizerResult { race: string; sex: string; } -export interface SingaporeIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type SingaporeIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface SingaporeIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -2114,7 +2109,7 @@ export interface SingaporeIdFrontRecognizer extends Recognizer {} +export type SingaporeIdFrontRecognizerCtor = RecognizerCtor; export interface SlovakiaCombinedRecognizerResult extends RecognizerResult { address: string; @@ -2141,7 +2136,7 @@ export interface SlovakiaCombinedRecognizerResult extends RecognizerResult { specialRemarks: string; surnameAtBirth: string; } -export interface SlovakiaCombinedRecognizerResultCtor extends RecognizerResultCtor {} +export type SlovakiaCombinedRecognizerResultCtor = RecognizerResultCtor; export interface SlovakiaCombinedRecognizer extends Recognizer { detectGlare: boolean; @@ -2159,7 +2154,7 @@ export interface SlovakiaCombinedRecognizer extends Recognizer {} +export type SlovakiaCombinedRecognizerCtor = RecognizerCtor; export interface SlovakiaIdBackRecognizerResult extends RecognizerResult { address: string; @@ -2181,7 +2176,7 @@ export interface SlovakiaIdBackRecognizerResult extends RecognizerResult { specialRemarks: string; surnameAtBirth: string; } -export interface SlovakiaIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type SlovakiaIdBackRecognizerResultCtor = RecognizerResultCtor; export interface SlovakiaIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -2190,7 +2185,7 @@ export interface SlovakiaIdBackRecognizer extends Recognizer {} +export type SlovakiaIdBackRecognizerCtor = RecognizerCtor; export interface SlovakiaIdFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -2207,7 +2202,7 @@ export interface SlovakiaIdFrontRecognizerResult extends RecognizerResult { sex: string; signatureImage: string; } -export interface SlovakiaIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type SlovakiaIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface SlovakiaIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -2222,7 +2217,7 @@ export interface SlovakiaIdFrontRecognizer extends Recognizer {} +export type SlovakiaIdFrontRecognizerCtor = RecognizerCtor; export interface SloveniaCombinedRecognizerResult extends RecognizerResult { address: string; @@ -2246,7 +2241,7 @@ export interface SloveniaCombinedRecognizerResult extends RecognizerResult { sex: string; signatureImage: string; } -export interface SloveniaCombinedRecognizerResultCtor extends RecognizerResultCtor {} +export type SloveniaCombinedRecognizerResultCtor = RecognizerResultCtor; export interface SloveniaCombinedRecognizer extends Recognizer { detectGlare: boolean; @@ -2255,7 +2250,7 @@ export interface SloveniaCombinedRecognizer extends Recognizer {} +export type SloveniaCombinedRecognizerCtor = RecognizerCtor; export interface SloveniaIdBackRecognizerResult extends RecognizerResult { address: string; @@ -2276,7 +2271,7 @@ export interface SloveniaIdBackRecognizerResult extends RecognizerResult { secondaryId: string; sex: string; } -export interface SloveniaIdBackRecognizerResultCtor extends RecognizerResultCtor {} +export type SloveniaIdBackRecognizerResultCtor = RecognizerResultCtor; export interface SloveniaIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -2284,7 +2279,7 @@ export interface SloveniaIdBackRecognizer extends Recognizer {} +export type SloveniaIdBackRecognizerCtor = RecognizerCtor; export interface SloveniaIdFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -2297,7 +2292,7 @@ export interface SloveniaIdFrontRecognizerResult extends RecognizerResult { sex: string; signatureImage: string; } -export interface SloveniaIdFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type SloveniaIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface SloveniaIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -2309,7 +2304,7 @@ export interface SloveniaIdFrontRecognizer extends Recognizer {} +export type SloveniaIdFrontRecognizerCtor = RecognizerCtor; export interface SpainDlFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -2325,7 +2320,7 @@ export interface SpainDlFrontRecognizerResult extends RecognizerResult { validFrom: Date; validUntil: Date; } -export interface SpainDlFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type SpainDlFrontRecognizerResultCtor = RecognizerResultCtor; export interface SpainDlFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -2345,7 +2340,7 @@ export interface SpainDlFrontRecognizer extends Recognizer {} +export type SpainDlFrontRecognizerCtor = RecognizerCtor; export interface SwedenDlFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -2361,7 +2356,7 @@ export interface SwedenDlFrontRecognizerResult extends RecognizerResult { signatureImage: string; surname: string; } -export interface SwedenDlFrontRecognizerResultCtor extends RecognizerResultCtor {} +export type SwedenDlFrontRecognizerResultCtor = RecognizerResultCtor; export interface SwedenDlFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -2379,7 +2374,7 @@ export interface SwedenDlFrontRecognizer extends Recognizer {} +export type SwedenDlFrontRecognizerCtor = RecognizerCtor; export interface SwitzerlandDlFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -2396,8 +2391,7 @@ export interface SwitzerlandDlFrontRecognizerResult extends RecognizerResult { signatureImage: string; vehicleCategories: string; } -export interface SwitzerlandDlFrontRecognizerResultCtor - extends RecognizerResultCtor {} +export type SwitzerlandDlFrontRecognizerResultCtor = RecognizerResultCtor; export interface SwitzerlandDlFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -2417,7 +2411,7 @@ export interface SwitzerlandDlFrontRecognizer extends Recognizer {} +export type SwitzerlandDlFrontRecognizerCtor = RecognizerCtor; export interface SwitzerlandDlBackRecognizerResult extends RecognizerResult { authority: string; @@ -2440,10 +2434,9 @@ export interface SwitzerlandDlBackRecognizerResult extends RecognizerResult { placeOfOrigin: string; primaryId: string; secondaryId: string; - sex: String; + sex: string; } -export interface SwitzerlandDlBackRecognizerResultCtor - extends RecognizerResultCtor {} +export type SwitzerlandDlBackRecognizerResultCtor = RecognizerResultCtor; export interface SwitzerlandDlBackRecognizer extends Recognizer { detectGlare: boolean; @@ -2455,7 +2448,7 @@ export interface SwitzerlandDlBackRecognizer extends Recognizer {} +export type SwitzerlandDlBackRecognizerCtor = RecognizerCtor; export interface SwitzerlandIdFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -2465,8 +2458,7 @@ export interface SwitzerlandIdFrontRecognizerResult extends RecognizerResult { signatureImage: string; surname: string; } -export interface SwitzerlandIdFrontRecognizerResultCtor - extends RecognizerResultCtor {} +export type SwitzerlandIdFrontRecognizerResultCtor = RecognizerResultCtor; export interface SwitzerlandIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -2480,7 +2472,7 @@ export interface SwitzerlandIdFrontRecognizer extends Recognizer {} +export type SwitzerlandIdFrontRecognizerCtor = RecognizerCtor; export interface SwitzerlandPassportRecognizerResult extends RecognizerResult { authority: string; @@ -2510,8 +2502,7 @@ export interface SwitzerlandPassportRecognizerResult extends RecognizerResult { sex: string; surname: string; } -export interface SwitzerlandPassportRecognizerResultCtor - extends RecognizerResultCtor {} +export type SwitzerlandPassportRecognizerResultCtor = RecognizerResultCtor; export interface SwitzerlandPassportRecognizer extends Recognizer { detectGlare: boolean; @@ -2528,7 +2519,7 @@ export interface SwitzerlandPassportRecognizer extends Recognizer {} +export type SwitzerlandPassportRecognizerCtor = RecognizerCtor; export interface UnitedArabEmiratesDlFrontRecognizerResult extends RecognizerResult { dateOfBirth: Date; @@ -2542,8 +2533,8 @@ export interface UnitedArabEmiratesDlFrontRecognizerResult extends RecognizerRes nationality: string; placeOfIssue: string; } -export interface UnitedArabEmiratesDlFrontRecognizerResultCtor - extends RecognizerResultCtor {} +export type UnitedArabEmiratesDlFrontRecognizerResultCtor = + RecognizerResultCtor; export interface UnitedArabEmiratesDlFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -2560,14 +2551,14 @@ export interface UnitedArabEmiratesDlFrontRecognizer extends Recognizer {} +export type UnitedArabEmiratesDlFrontRecognizerCtor = RecognizerCtor; export interface UnitedArabEmiratesIdBackRecognizerResult extends RecognizerResult { fullDocumentImage: string; mrzResult: MrzResult; } -export interface UnitedArabEmiratesIdBackRecognizerResultCtor - extends RecognizerResultCtor {} +export type UnitedArabEmiratesIdBackRecognizerResultCtor = + RecognizerResultCtor; export interface UnitedArabEmiratesIdBackRecognizer extends Recognizer { detectGlare: boolean; @@ -2575,7 +2566,7 @@ export interface UnitedArabEmiratesIdBackRecognizer extends Recognizer {} +export type UnitedArabEmiratesIdBackRecognizerCtor = RecognizerCtor; export interface UnitedArabEmiratesIdFrontRecognizerResult extends RecognizerResult { faceImage: string; @@ -2584,8 +2575,8 @@ export interface UnitedArabEmiratesIdFrontRecognizerResult extends RecognizerRes name: string; nationality: string; } -export interface UnitedArabEmiratesIdFrontRecognizerResultCtor - extends RecognizerResultCtor {} +export type UnitedArabEmiratesIdFrontRecognizerResultCtor = + RecognizerResultCtor; export interface UnitedArabEmiratesIdFrontRecognizer extends Recognizer { detectGlare: boolean; @@ -2597,15 +2588,15 @@ export interface UnitedArabEmiratesIdFrontRecognizer extends Recognizer {} +export type UnitedArabEmiratesIdFrontRecognizerCtor = RecognizerCtor; export interface VinRecognizerResult extends RecognizerResult { vin: string; } -export interface VinRecognizerResultCtor extends RecognizerResultCtor {} +export type VinRecognizerResultCtor = RecognizerResultCtor; -export interface VinRecognizer extends Recognizer {} -export interface VinRecognizerCtor extends RecognizerCtor {} +export type VinRecognizer = Recognizer; +export type VinRecognizerCtor = RecognizerCtor; export interface UsdlRecognizerResult extends RecognizerResult { optionalElements: any[]; @@ -2614,13 +2605,13 @@ export interface UsdlRecognizerResult extends RecognizerResult { uncertain: string; fields: any[]; } -export interface UsdlRecognizerResultCtor extends RecognizerResultCtor {} +export type UsdlRecognizerResultCtor = RecognizerResultCtor; export interface UsdlRecognizer extends Recognizer { nullQuietZoneAllowed: boolean; uncertainDecoding: boolean; } -export interface UsdlRecognizerCtor extends RecognizerCtor {} +export type UsdlRecognizerCtor = RecognizerCtor; export interface UsdlCombinedRecognizerResult extends RecognizerResult { digitalSignature: string; @@ -2635,7 +2626,7 @@ export interface UsdlCombinedRecognizerResult extends RecognizerResult { uncertain: boolean; fields: any[]; } -export interface UsdlCombinedRecognizerResultCtor extends RecognizerResultCtor {} +export type UsdlCombinedRecognizerResultCtor = RecognizerResultCtor; export interface UsdlCombinedRecognizer extends Recognizer { faceImageDpi: number; @@ -2644,9 +2635,9 @@ export interface UsdlCombinedRecognizer extends Recognizer {} +export type UsdlCombinedRecognizerCtor = RecognizerCtor; -export interface BlinkIdRecognizerCtor extends RecognizerCtor {} +export type BlinkIdRecognizerCtor = RecognizerCtor; export interface BlinkIdRecognizer extends Recognizer { returnFaceImage: boolean; @@ -2672,15 +2663,14 @@ export interface BlinkIdRecognizerResult extends RecognizerResult { export interface BlinkIdOverlaySettingsCtor { new (): BlinkIdOverlaySettings; } -export interface BlinkIdOverlaySettings extends OverlaySettings {} +export type BlinkIdOverlaySettings = OverlaySettings; -export interface BlinkIdRecognizerResultCtor extends RecognizerResultCtor {} +export type BlinkIdRecognizerResultCtor = RecognizerResultCtor; /** * @name BlinkId * @description * Microblink SDK wrapper for barcode and document scanning. See the * blinkid-phonegap repository for available recognizers and other settings - * * @usage * ```typescript * import { BlinkId, RecognizerResultState } from '@awesome-cordova-plugins/blinkid/ngx'; @@ -2768,8 +2758,10 @@ export interface BlinkIdRecognizerResultCtor extends RecognizerResultCtor} */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/bluetooth-classic-serial-port/index.ts b/src/@awesome-cordova-plugins/plugins/bluetooth-classic-serial-port/index.ts index 152d2298..606545b0 100644 --- a/src/@awesome-cordova-plugins/plugins/bluetooth-classic-serial-port/index.ts +++ b/src/@awesome-cordova-plugins/plugins/bluetooth-classic-serial-port/index.ts @@ -53,7 +53,6 @@ export interface BluetoothClassicSerialPortDevice { * * } * ``` - * */ @Plugin({ pluginName: 'BluetoothClassicSerialPort', @@ -66,6 +65,7 @@ export interface BluetoothClassicSerialPortDevice { export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Connect to a Bluetooth device + * * @param {string} deviceId Identifier of the remote device. * @param {string} deviceId this is the MAC address. * @param {string|string[]} interfaceId Identifier of the remote device @@ -82,6 +82,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Connect to a Bluetooth device + * * @deprecated * @param {string} deviceId Identifier of the remote device. * @param {number} deviceId this is the connection ID @@ -99,6 +100,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Connect insecurely to a Bluetooth device + * * @param {string} deviceId Identifier of the remote device. For Android this is the MAC address * @param {string | string[]} interfaceArray This identifies the serial port to connect to. For Android this is the SPP_UUID. * @returns {Promise} Subscribe to connect. @@ -113,6 +115,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Disconnect from the connected device + * * @param {string} interfaceId The interface to Disconnect * @returns {Promise} */ @@ -123,6 +126,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Disconnect from all the connected device + * * @returns {Promise} */ @Cordova({ @@ -134,6 +138,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Writes data to the serial port + * * @param {string} interfaceId The interface to send the data to * @param {ArrayBuffer | string | number[] | Uint8Array} data ArrayBuffer of data * @returns {Promise} returns a promise when data has been written @@ -147,6 +152,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Gets the number of bytes of data available + * * @param {string} interfaceId The interface to check * @returns {Promise} returns a promise that contains the available bytes */ @@ -159,6 +165,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Function read reads the data from the buffer. The data is passed to the success callback as a String. Calling read when no data is available will pass an empty String to the callback. + * * @param {string} interfaceId The interface to read * @returns {Promise} returns a promise with data from the buffer */ @@ -171,6 +178,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Reads data from the buffer until it reaches a delimiter + * * @param {string} interfaceId The interface to read * @param {string} delimiter string that you want to search until * @returns {Observable} returns a promise @@ -184,6 +192,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Subscribe to be notified when data is received + * * @param {string | string[]} interfaceId The interface to subscribe to * @param {string} delimiter the string you want to watch for * @returns {Observable} returns an observable. @@ -198,6 +207,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Unsubscribe from a subscription + * * @param {string | string[]} interfaceId The interface to unsubscribe from * @returns {Promise} returns an promise. */ @@ -210,6 +220,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Subscribe to be notified when data is received + * * @param {string | string[]} interfaceId The interface to subscribe to * @returns {Observable} returns an observable */ @@ -223,6 +234,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Unsubscribe from a subscription + * * @param {string | string[]} interfaceId The interface to unsubscribe from * @returns {Promise} returns an promise. */ @@ -235,6 +247,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Clears data in buffer + * * @param {string} interfaceId The interface to clear data * @returns {Promise} returns a promise when completed */ @@ -247,6 +260,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Lists bonded devices + * * @returns {Promise} returns a promise */ @Cordova({ @@ -258,6 +272,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Reports the connection status + * * @param {string} interfaceId The interface to check * @returns {Promise} returns a promise */ @@ -270,6 +285,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Reports if bluetooth is enabled + * * @returns {Promise} returns a promise */ @Cordova({ @@ -281,6 +297,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Show the Bluetooth settings on the device + * * @returns {Promise} returns a promise */ @Cordova({ @@ -292,6 +309,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Enable Bluetooth on the device + * * @returns {Promise} returns a promise */ @Cordova({ @@ -303,6 +321,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Discover unpaired devices + * * @returns {Promise} returns a promise */ @Cordova({ @@ -314,6 +333,7 @@ export class BluetoothClassicSerialPort extends AwesomeCordovaNativePlugin { /** * Subscribe to be notified on Bluetooth device discovery. Discovery process must be initiated with the `discoverUnpaired` function. + * * @returns {Observable} Returns an observable */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/bluetooth-le/index.ts b/src/@awesome-cordova-plugins/plugins/bluetooth-le/index.ts index 2f3e3684..6e747d41 100644 --- a/src/@awesome-cordova-plugins/plugins/bluetooth-le/index.ts +++ b/src/@awesome-cordova-plugins/plugins/bluetooth-le/index.ts @@ -426,7 +426,6 @@ export interface AdapterInfo { * This plugin has the most complete implementation for interacting with Bluetooth LE devices on Android, iOS and partially Windows. * It's a wrap around [randdusing/cordova-plugin-bluetoothle](https://github.com/randdusing/cordova-plugin-bluetoothle/blob/master/readme.md) cordova plugin for Ionic. * It supports peripheral **and** central modes and covers most of the API methods available on Android and iOS. - * * @usage * ```typescript * import { BluetoothLE } from '@awesome-cordova-plugins/bluetooth-le/ngx'; @@ -446,7 +445,6 @@ export interface AdapterInfo { * } * * ``` - * */ @Plugin({ pluginName: 'BluetoothLE', @@ -532,6 +530,8 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name retrieveConnected + * @param params + * @param params.services * Retrieved paired Bluetooth LE devices. In iOS, devices that are "paired" to will not return during a normal scan. * Callback is "instant" compared to a scan. * @param {{ services: string[] }} An array of service IDs to filter the retrieval by. If no service IDs are specified, no devices will be returned. @@ -544,6 +544,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name bond (Android) + * @param params.address * Bond with a device. * The device doesn't need to be connected to initiate bonding. Android support only. * @param {{ address: string }} params The address/identifier provided by the scan's return object @@ -562,6 +563,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name unbond (Android) + * @param params.address * Unbond with a device. The device doesn't need to be connected to initiate bonding. Android support only. * @param {{address: string}} params The address/identifier * @returns {Promise<{ status: DeviceInfo }>} @@ -579,7 +581,6 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { * @param connectSuccess The success callback that is passed with device object * @param connectError The callback that will be triggered when the connect operation fails * @param params The connection params - * * @param {ConnectionParams} params * @returns {(Observable<{ status: DeviceInfo }>)} * success: device object with status @@ -592,6 +593,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name reconnect + * @param params.address * Reconnect to a previously connected Bluetooth device * @param {{address: string}} params The address/identifier * @returns {(Observable)} @@ -603,6 +605,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name disconnect + * @param params.address * Disconnect from a Bluetooth LE device. * Note: It's simpler to just call close(). Starting with iOS 10, disconnecting before closing seems required! * @param {{address: string}} params The address/identifier @@ -615,6 +618,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name close + * @param params.address * Close/dispose a Bluetooth LE device. * Prior to 2.7.0, you needed to disconnect to the device before closing, but this is no longer the case. * Starting with iOS 10, disconnecting before closing seems required! @@ -628,6 +632,8 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name discover + * @param params.address + * @param params.clearCache * Discover all the devices services, characteristics and descriptors. * Doesn't need to be called again after disconnecting and then reconnecting. * If using iOS, you shouldn't use discover and services/characteristics/descriptors on the same device. @@ -647,6 +653,8 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name services (iOS) + * @param params.address + * @param params.services * Discover the device's services. * Not providing an array of services will return all services and take longer to discover. iOS support only. * @param {{address: string, services: string[]}} params @@ -764,6 +772,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name rssi + * @param params.address * Read RSSI of a connected device. RSSI is also returned with scanning. * @param {{ address: string }} params * @returns {Promise< RSSI >} @@ -775,6 +784,8 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name mtu (Android, Android 5+) + * @param params.address + * @param params.mtu * Set MTU of a connected device. Android only. * @param {{ address: string, mtu: number }} params * @returns {Promise< MTU >} @@ -786,6 +797,8 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name requestConnectionPriority (Android, Android 5+) + * @param params.address + * @param params.connectionPriority * Request a change in the connection priority to improve throughput when transfer large amounts of data via BLE. * Android support only. iOS will return error. * @param {{ address: string, connectionPriority: ConnectionPriority }} params @@ -828,6 +841,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name isBonded (Android) + * @param params.address * Determine whether the device is bonded or not, or error if not initialized. Android support only. * @param {{ address: string }} params * @returns {Promise} @@ -839,6 +853,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name wasConnected + * @param params.address * Determine whether the device was connected, or error if not initialized. * @param {{ address: string }} params * @returns {Promise} @@ -850,6 +865,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name isConnected + * @param params.address * Determine whether the device is connected, or error if not initialized or never connected to device * @param {{ address: string }} params * @returns {Promise} @@ -861,6 +877,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name isDiscovered + * @param params.address * Determine whether the device's characteristics and descriptors have been discovered, or error if not initialized or not connected to device. * @param {{ address: string }} params * @returns {Promise} @@ -926,6 +943,8 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name addService + * @param params.service + * @param params.characteristics * Add a service with characteristics and descriptors. If more than one service is added, add them sequentially * @param {{ service: string, characteristics: Characteristic[] }} params * @returns {Promise<{ service: string, status: Status }>} @@ -940,6 +959,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name removeService + * @param params.service * Remove a service * @param {{ service: string }} params * @returns {Promise<{ service: string, status: Status }>} @@ -1018,6 +1038,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name encodedStringToBytes + * @param value * Helper function to convert a base64 encoded string from a characteristic or descriptor value into a uint8Array object * @param {string} str * @returns {Uint8Array} @@ -1029,6 +1050,7 @@ export class BluetoothLE extends AwesomeCordovaNativePlugin { /** * @name bytesToEncodedString + * @param value * Helper function to convert a unit8Array to a base64 encoded string for a characteric or descriptor write * @param {Uint8Array} bytes * @returns {string} diff --git a/src/@awesome-cordova-plugins/plugins/bluetooth-serial/index.ts b/src/@awesome-cordova-plugins/plugins/bluetooth-serial/index.ts index c88a2594..56d93aa4 100644 --- a/src/@awesome-cordova-plugins/plugins/bluetooth-serial/index.ts +++ b/src/@awesome-cordova-plugins/plugins/bluetooth-serial/index.ts @@ -41,6 +41,7 @@ import { Observable } from 'rxjs'; export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Connect to a Bluetooth device + * * @param {string} macAddress_or_uuid Identifier of the remote device * @returns {Observable} Subscribe to connect, unsubscribe to disconnect. */ @@ -55,6 +56,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Connect insecurely to a Bluetooth device + * * @param {string} macAddress Identifier of the remote device * @returns {Observable} Subscribe to connect, unsubscribe to disconnect. */ @@ -69,6 +71,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Disconnect from the connected device + * * @returns {Promise} */ @Cordova() @@ -78,6 +81,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Writes data to the serial port + * * @param {any} data ArrayBuffer of data * @returns {Promise} returns a promise when data has been written */ @@ -90,6 +94,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Gets the number of bytes of data available + * * @returns {Promise} returns a promise that contains the available bytes */ @Cordova({ @@ -101,6 +106,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Reads data from the buffer + * * @returns {Promise} returns a promise with data from the buffer */ @Cordova({ @@ -112,6 +118,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Reads data from the buffer until it reaches a delimiter + * * @param {string} delimiter string that you want to search until * @returns {Promise} returns a promise */ @@ -124,6 +131,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Subscribe to be notified when data is received + * * @param {string} delimiter the string you want to watch for * @returns {Observable} returns an observable. */ @@ -138,6 +146,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Subscribe to be notified when data is received + * * @returns {Observable} returns an observable */ @Cordova({ @@ -151,6 +160,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Clears data in buffer + * * @returns {Promise} returns a promise when completed */ @Cordova({ @@ -162,6 +172,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Lists bonded devices + * * @returns {Promise} returns a promise */ @Cordova({ @@ -173,6 +184,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Reports if bluetooth is enabled + * * @returns {Promise} returns a promise */ @Cordova({ @@ -184,6 +196,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Reports the connection status + * * @returns {Promise} returns a promise */ @Cordova({ @@ -195,6 +208,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Reads the RSSI from the connected peripheral + * * @returns {Promise} returns a promise */ @Cordova({ @@ -206,6 +220,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Show the Bluetooth settings on the device + * * @returns {Promise} returns a promise */ @Cordova({ @@ -217,6 +232,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Enable Bluetooth on the device + * * @returns {Promise} returns a promise */ @Cordova({ @@ -228,6 +244,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Discover unpaired devices + * * @returns {Promise} returns a promise */ @Cordova({ @@ -239,6 +256,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Subscribe to be notified on Bluetooth device discovery. Discovery process must be initiated with the `discoverUnpaired` function. + * * @returns {Observable} Returns an observable */ @Cordova({ @@ -252,6 +270,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Sets the human readable device name that is broadcasted to other devices + * * @param {string} newName Desired name of device */ @Cordova({ @@ -262,6 +281,7 @@ export class BluetoothSerial extends AwesomeCordovaNativePlugin { /** * Makes the device discoverable by other devices + * * @param {number} discoverableDuration Desired number of seconds device should be discoverable for */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/branch-io/index.ts b/src/@awesome-cordova-plugins/plugins/branch-io/index.ts index 74b9ea3c..ff150b8b 100644 --- a/src/@awesome-cordova-plugins/plugins/branch-io/index.ts +++ b/src/@awesome-cordova-plugins/plugins/branch-io/index.ts @@ -51,7 +51,6 @@ export interface BranchUniversalObject { * @name BranchIo * @description * Branch.io is an attribution service for deeplinking and invitation links - * * @usage * ``` * import { BranchIo } from '@awesome-cordova-plugins/branch-io/ngx'; @@ -60,13 +59,11 @@ export interface BranchUniversalObject { * constructor(private branch: BranchIo) { } * * ``` - * * @interfaces * BranchIoPromise * BranchIoAnalytics * BranchIoProperties * BranchUniversalObject - * */ @Plugin({ pluginName: 'BranchIo', @@ -79,8 +76,9 @@ export interface BranchUniversalObject { export class BranchIo extends AwesomeCordovaNativePlugin { /** * for development and debugging only + * * @param {boolean} enable Enable debug - * @return {Promise} + * @returns {Promise} */ @Cordova({ otherPromise: true }) setDebug(enable: boolean): Promise { @@ -89,8 +87,9 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Disable tracking + * * @param {boolean} disable disable tracking - * @return {Promise} + * @returns {Promise} */ @Cordova({ otherPromise: true }) disableTracking(disable: boolean): Promise { @@ -99,7 +98,8 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Initializes Branch - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ otherPromise: true }) initSession(): Promise { @@ -108,7 +108,8 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Initializes Branch with callback - * @return {Observable} + * + * @returns {Observable} */ @Cordova({ observable: true }) initSessionWithCallback(): Observable { @@ -117,7 +118,8 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Set Request Metadata - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ otherPromise: true }) setRequestMetadata(): Promise { @@ -126,8 +128,9 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * for better Android matching + * * @param {string} linkDomain LinkDomain at branch - * @return {Promise} + * @returns {Promise} */ @Cordova({ otherPromise: true }) setCookieBasedMatching(linkDomain: string): Promise { @@ -136,7 +139,8 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * First data - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ otherPromise: true }) getFirstReferringParams(): Promise { @@ -145,7 +149,8 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Latest data - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ otherPromise: true }) getLatestReferringParams(): Promise { @@ -154,8 +159,9 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Set identy of user + * * @param {string} userId - * @return {Promise} + * @returns {Promise} */ @Cordova({ otherPromise: true }) setIdentity(userId: string): Promise { @@ -164,7 +170,8 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Logout user - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ otherPromise: true }) logout(): Promise { @@ -173,9 +180,10 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Registers a custom event + * * @param {string} eventName * @param {any} metaData - * @return {Promise} + * @returns {Promise} */ @Cordova({ otherPromise: true }) userCompletedAction(eventName: string, metaData: any): Promise { @@ -184,10 +192,11 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Send Commerce Event + * * @deprecated since v.3.1.0. As of https://help.branch.io/developers-hub/docs/cordova-phonegap-ionic#track-commerce * @param {string} event * @param {any} metaData - * @return {Promise} + * @returns {Promise} */ @Cordova({ otherPromise: true }) sendCommerceEvent(event: string, metaData: any): Promise { @@ -196,9 +205,10 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Send Branch Event + * * @param {string} event * @param {any} metaData - * @return {Promise} + * @returns {Promise} */ @Cordova({ otherPromise: true }) sendBranchEvent(event: string, metaData: any): Promise { @@ -207,8 +217,9 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * create a branchUniversalObj variable to reference with other Branch methods + * * @param {BranchIoProperties} properties - * @return {Promise} + * @returns {Promise} */ @Cordova({ otherPromise: true }) createBranchUniversalObject(properties: BranchIoProperties): Promise { @@ -217,8 +228,9 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Load credits + * * @param {any} bucket - * @return {Promise} + * @returns {Promise} */ @Cordova({ otherPromise: true }) loadRewards(bucket: any): Promise { @@ -227,9 +239,10 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Redeem Rewards + * * @param {string} value * @param {any} bucket - * @return {Promise} + * @returns {Promise} */ @Cordova({ otherPromise: true }) redeemRewards(value: string, bucket: any): Promise { @@ -238,7 +251,8 @@ export class BranchIo extends AwesomeCordovaNativePlugin { /** * Show credit history - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ otherPromise: true }) creditHistory(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/broadcaster/index.ts b/src/@awesome-cordova-plugins/plugins/broadcaster/index.ts index 497b3116..03332936 100644 --- a/src/@awesome-cordova-plugins/plugins/broadcaster/index.ts +++ b/src/@awesome-cordova-plugins/plugins/broadcaster/index.ts @@ -20,7 +20,6 @@ export type EventData = object | AndroidData | null; * @name Broadcaster * @description * This plugin adds exchanging events between native code and your app. - * * @usage * ```typescript * import { Broadcaster } from '@awesome-cordova-plugins/broadcaster/ngx'; @@ -48,9 +47,10 @@ export type EventData = object | AndroidData | null; export class Broadcaster extends AwesomeCordovaNativePlugin { /** * This function listen to an event sent from the native code + * * @param {string} eventName * @param {boolean} isGlobal Valid only for Android. It allows to listen for global messages(i.e. intents) - * @return {Observable} Returns an observable to watch when an event is received + * @returns {Observable} Returns an observable to watch when an event is received */ @Cordova({ observable: true, @@ -63,13 +63,14 @@ export class Broadcaster extends AwesomeCordovaNativePlugin { /** * This function sends data to the native code + * * @param {string} eventName * @param {boolean} isGlobalOrEventData means that message is global (valid only on Android) * @param {AndroidData} isGlobalOrEventData allows to specify 'flags` and 'category' (valid only on Android) * @param {object} isGlobalOrEventData allows to specify a generic object containing custom event data (all platform) * @param {AndroidData} [data] if isGlobal is set, allows to specify 'flags` and 'category' if isGlobal is set (valid only on Android) * @param {object} [data] if isGlobal is set, allows to specify a generic object containing custom event data (all platform) - * @return {Promise} Returns a promise that resolves when an event is successfully fired + * @returns {Promise} Returns a promise that resolves when an event is successfully fired */ @Cordova() fireNativeEvent(eventName: string, isGlobalOrEventData: boolean | EventData, data?: EventData): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/build-info/index.ts b/src/@awesome-cordova-plugins/plugins/build-info/index.ts index 8770666c..bafb3043 100644 --- a/src/@awesome-cordova-plugins/plugins/build-info/index.ts +++ b/src/@awesome-cordova-plugins/plugins/build-info/index.ts @@ -5,7 +5,6 @@ import { Plugin, CordovaProperty, AwesomeCordovaNativePlugin } from '@awesome-co * @name Build Info * @description * This plugin provides build information. - * * @usage * ``` * import { BuildInfo } from '@awesome-cordova-plugins/build-info/ngx'; diff --git a/src/@awesome-cordova-plugins/plugins/calendar/index.ts b/src/@awesome-cordova-plugins/plugins/calendar/index.ts index 1f2bc6e2..a4593af7 100644 --- a/src/@awesome-cordova-plugins/plugins/calendar/index.ts +++ b/src/@awesome-cordova-plugins/plugins/calendar/index.ts @@ -63,8 +63,6 @@ export interface NameOrOptions { * This plugin allows you to add events to the Calendar of the mobile device. * * Requires Cordova plugin: `cordova-plugin-calendar`. For more info, please see the [Calendar plugin docs](https://github.com/EddyVerbruggen/Calendar-PhoneGap-Plugin). - * - * * @usage * ```typescript * import { Calendar } from '@awesome-cordova-plugins/calendar/ngx'; @@ -99,6 +97,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { * - You've already granted permission * * If this returns false, you should call the `requestReadWritePermission` function + * * @returns {Promise} */ @Cordova() @@ -108,6 +107,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Check if we have read permission + * * @returns {Promise} */ @Cordova() @@ -117,6 +117,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Check if we have write permission + * * @returns {Promise} */ @Cordova() @@ -126,6 +127,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Request write permission + * * @returns {Promise} */ @Cordova() @@ -135,6 +137,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Request read permission + * * @returns {Promise} */ @Cordova() @@ -144,6 +147,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Requests read/write permissions + * * @returns {Promise} */ @Cordova() @@ -164,6 +168,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Delete a calendar. (iOS only) + * * @param {string} name Name of the calendar to delete. * @returns {Promise} Returns a Promise */ @@ -175,7 +180,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Returns the default calendar options. * - * @return {CalendarOptions} Returns an object with the default calendar options + * @returns {CalendarOptions} Returns an object with the default calendar options */ @Cordova({ sync: true, @@ -187,7 +192,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Returns options for a custom calender with specific color * - * @return {NameOrOptions} Returns an object with the default options + * @returns {NameOrOptions} Returns an object with the default options */ @Cordova({ sync: true, @@ -198,6 +203,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Silently create an event. + * * @param {string} [title] The event title * @param {string} [location] The event location * @param {string} [notes] The event notes @@ -294,6 +300,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Find an event with additional options. + * * @param {string} [title] The event title * @param {string} [location] The event location * @param {string} [notes] The event notes @@ -330,6 +337,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Get a list of all calendars. + * * @returns {Promise} A Promise that resolves with the list of calendars, or rejects with an error. */ @Cordova() @@ -339,6 +347,8 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Get a list of all future events in the specified calendar. (iOS only) + * + * @param calendarName * @returns {Promise} Returns a Promise that resolves with the list of events, or rejects with an error. */ @Cordova({ @@ -361,7 +371,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { * @param {string} [newNotes] The new event notes * @param {Date} [newStartDate] The new event start date * @param {Date} [newEndDate] The new event end date - * @return Returns a Promise + * @returns Returns a Promise */ @Cordova({ platforms: ['iOS'], @@ -396,7 +406,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { * @param {Date} [newEndDate] The new event end date * @param {CalendarOptions} [filterOptions] Event Options, see `getCalendarOptions` * @param {CalendarOptions} [newOptions] New event options, see `getCalendarOptions` - * @return Returns a Promise + * @returns Returns a Promise */ @Cordova({ platforms: ['iOS'], @@ -426,7 +436,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { * @param {string} [notes] The event notes * @param {Date} [startDate] The event start date * @param {Date} [endDate] The event end date - * @return Returns a Promise + * @returns Returns a Promise */ @Cordova() deleteEvent(title?: string, location?: string, notes?: string, startDate?: Date, endDate?: Date): Promise { @@ -442,7 +452,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { * @param {Date} [startDate] The event start date * @param {Date} [endDate] The event end date * @param {string} calendarName - * @return Returns a Promise + * @returns Returns a Promise */ @Cordova({ platforms: ['iOS'], @@ -463,7 +473,7 @@ export class Calendar extends AwesomeCordovaNativePlugin { * * @param {string} [id] The event id * @param {Date} [fromDate] The date where it start deleting from - * @return Returns a Promise + * @returns Returns a Promise */ @Cordova() deleteEventById(id: string, fromDate?: Date): Promise { @@ -472,8 +482,9 @@ export class Calendar extends AwesomeCordovaNativePlugin { /** * Open the calendar at the specified date. + * * @param {Date} date The date you want to open the calendar on - * @return {Promise} Promise returns a promise + * @returns {Promise} Promise returns a promise */ @Cordova() openCalendar(date: Date): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/call-directory/index.ts b/src/@awesome-cordova-plugins/plugins/call-directory/index.ts index 083b33aa..20c9d5c6 100644 --- a/src/@awesome-cordova-plugins/plugins/call-directory/index.ts +++ b/src/@awesome-cordova-plugins/plugins/call-directory/index.ts @@ -16,7 +16,6 @@ export interface CallDirectoryLog { * @description * This plugin can add phone numbers to an Callkit call directory extension. Call `reloadExtension` after using `addIdentification` and `removeIdentification` * to process the changes in the call directory extension. - * * @usage * ```typescript * import { CallDirectory } from '@awesome-cordova-plugins/call-directory/ngx'; @@ -34,7 +33,6 @@ export interface CallDirectoryLog { * .then(res: string) => console.log(res)) * .catch((error: any) => console.error(error)); * ``` - * * @Interfaces * CallDirectoryItem * CallDirectoryLog @@ -53,7 +51,8 @@ export interface CallDirectoryLog { export class CallDirectory extends AwesomeCordovaNativePlugin { /** * Check if the call directory extension is available and enabled - * @return {Promise} Returns a promise with result + * + * @returns {Promise} Returns a promise with result */ @Cordova() isAvailable(): Promise { @@ -62,8 +61,9 @@ export class CallDirectory extends AwesomeCordovaNativePlugin { /** * Add identification numbers + * * @param {CallDirectoryItem[]} items Set of numbers with labels - * @return {Promise} Returns a promise that resolves when numbers are added + * @returns {Promise} Returns a promise that resolves when numbers are added */ @Cordova() addIdentification(items: CallDirectoryItem[]): Promise { @@ -72,8 +72,9 @@ export class CallDirectory extends AwesomeCordovaNativePlugin { /** * Remove identification numbers + * * @param {CallDirectoryItem[]} items Set of numbers with arbitrary label - * @return {Promise} Returns a promise that resolves when numbers are removed + * @returns {Promise} Returns a promise that resolves when numbers are removed */ @Cordova() removeIdentification(items: CallDirectoryItem[]): Promise { @@ -82,7 +83,8 @@ export class CallDirectory extends AwesomeCordovaNativePlugin { /** * Remove all items from call directory. Refreshes immediately. - * @return {Promise} Returns a promise after refresh with message + * + * @returns {Promise} Returns a promise after refresh with message */ @Cordova() removeAllIdentification(): Promise { @@ -91,7 +93,8 @@ export class CallDirectory extends AwesomeCordovaNativePlugin { /** * Get all numbers and labels in call directory - * @return {CallDirectoryItem[]} Returns a promise that resolves with an array of all items + * + * @returns {CallDirectoryItem[]} Returns a promise that resolves with an array of all items */ @Cordova() getAllItems(): Promise { @@ -100,7 +103,8 @@ export class CallDirectory extends AwesomeCordovaNativePlugin { /** * Reload extension to process queued changes - * @return {Promise} Returns a promise after refresh with message + * + * @returns {Promise} Returns a promise after refresh with message */ @Cordova() reloadExtension(): Promise { @@ -109,7 +113,8 @@ export class CallDirectory extends AwesomeCordovaNativePlugin { /** * Get log from plugin and call directory extension - * @return {Promise} Returns a promise with an object of log messages + * + * @returns {Promise} Returns a promise with an object of log messages */ @Cordova() getLog(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/call-number/index.ts b/src/@awesome-cordova-plugins/plugins/call-number/index.ts index e02a3118..b1cc7596 100644 --- a/src/@awesome-cordova-plugins/plugins/call-number/index.ts +++ b/src/@awesome-cordova-plugins/plugins/call-number/index.ts @@ -5,8 +5,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Call Number * @description * Call a number directly from your Cordova/Ionic application. - * **NOTE**: The iOS Simulator (and maybe Android Simulators) do not provide access to the phone subsystem. - * + * NOTE**: The iOS Simulator (and maybe Android Simulators) do not provide access to the phone subsystem. * @usage * ```typescript * import { CallNumber } from '@awesome-cordova-plugins/call-number/ngx'; @@ -33,9 +32,10 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class CallNumber extends AwesomeCordovaNativePlugin { /** * Calls a phone number + * * @param {string} numberToCall The phone number to call as a string * @param {boolean} bypassAppChooser Set to true to bypass the app chooser and go directly to dialer - * @return {Promise} + * @returns {Promise} */ @Cordova({ callbackOrder: 'reverse', @@ -46,7 +46,8 @@ export class CallNumber extends AwesomeCordovaNativePlugin { /** * Check if call feature is available - * @return {Promise} + * + * @returns {Promise} */ @Cordova() isCallSupported(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/camera-preview/index.ts b/src/@awesome-cordova-plugins/plugins/camera-preview/index.ts index f0eb6793..9bb91328 100644 --- a/src/@awesome-cordova-plugins/plugins/camera-preview/index.ts +++ b/src/@awesome-cordova-plugins/plugins/camera-preview/index.ts @@ -60,7 +60,6 @@ export interface CameraPreviewPictureOptions { * Showing camera preview in HTML * * Requires Cordova plugin: `https://github.com/cordova-plugin-camera-preview/cordova-plugin-camera-preview.git`. For more info, please see the [Cordova Camera Preview docs](https://github.com/cordova-plugin-camera-preview/cordova-plugin-camera-preview). - * * @usage * ```typescript * import { CameraPreview, CameraPreviewPictureOptions, CameraPreviewOptions, CameraPreviewDimensions } from '@awesome-cordova-plugins/camera-preview/ngx'; @@ -132,7 +131,6 @@ export interface CameraPreviewPictureOptions { * this.cameraPreview.stopCamera(); * * ``` - * * @interfaces * CameraPreviewOptions * CameraPreviewPictureOptions @@ -192,8 +190,9 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Starts the camera preview instance. + * * @param {CameraPreviewOptions} options - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 1, @@ -205,8 +204,9 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Starts the camera video instance. + * * @param {any} options - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 1, @@ -218,7 +218,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Stops the camera preview instance. (iOS & Android) - * @return {Promise} + * + * @returns {Promise} */ @Cordova() stopCamera(): Promise { @@ -227,7 +228,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Stops the camera video instance. (iOS & Android) - * @return {Promise} + * + * @returns {Promise} */ @Cordova() stopRecordVideo(): Promise { @@ -236,7 +238,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Switch from the rear camera and front camera, if available. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() switchCamera(): Promise { @@ -245,7 +248,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Hide the camera preview box. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() hide(): Promise { @@ -254,7 +258,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Show the camera preview box. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() show(): Promise { @@ -263,8 +268,9 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Take the picture (base64) + * * @param {CameraPreviewPictureOptions} [options] size and quality of the picture to take - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 1, @@ -276,8 +282,9 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Take a snapshot of preview window (size specified in startCamera options) + * * @param {CameraPreviewPictureOptions} [options] quality of the picture to take - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 1, @@ -290,9 +297,10 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * * Set camera color effect. + * * @static * @param {string} effect name : 'none' (iOS & Android), 'aqua' (Android), 'blackboard' (Android), 'mono' (iOS & Android), 'negative' (iOS & Android), 'posterize' (iOS & Android), 'sepia' (iOS & Android), 'solarize' (Android) or 'whiteboard' (Android) - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 1, @@ -304,8 +312,9 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Set the zoom (Android) + * * @param [zoom] {number} Zoom value - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 1, @@ -317,7 +326,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Get the maximum zoom (Android) - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getMaxZoom(): Promise { @@ -326,7 +336,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Get current zoom (Android) - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getZoom(): Promise { @@ -335,8 +346,9 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Set the preview Size + * * @param {CameraPreviewDimensions} [dimensions] - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 1, @@ -348,7 +360,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Get focus mode - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getFocusMode(): Promise { @@ -357,8 +370,9 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Set the focus mode + * * @param {string} [focusMode] 'fixed', 'auto', 'continuous-picture', 'continuous-video' (iOS & Android), 'edof', 'infinity', 'macro' (Android Only) - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 1, @@ -370,7 +384,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Get supported focus modes - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getSupportedFocusModes(): Promise { @@ -379,7 +394,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Get the current flash mode - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getFlashMode(): Promise { @@ -388,8 +404,9 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Set the flash mode + * * @param {string} [flashMode] 'off' (iOS & Android), 'on' (iOS & Android), 'auto' (iOS & Android), 'torch' (Android) - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 1, @@ -401,7 +418,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Get supported flash modes - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getSupportedFlashModes(): Promise { @@ -410,7 +428,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Get supported picture sizes - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getSupportedPictureSizes(): Promise { @@ -419,7 +438,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Get exposure mode - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getExposureMode(): Promise { @@ -428,7 +448,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Get exposure modes - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getExposureModes(): Promise { @@ -437,8 +458,9 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Set exposure mode + * * @param {string} [lock] - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 1, @@ -450,7 +472,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Get exposure compensation (Android) - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getExposureCompensation(): Promise { @@ -459,8 +482,9 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Set exposure compensation (Android) + * * @param {number} [exposureCompensation] - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 1, @@ -472,7 +496,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Get exposure compensation range (Android) - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getExposureCompensationRange(): Promise { @@ -481,9 +506,10 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Set specific focus point. Note, this assumes the camera is full-screen. + * * @param {number} xPoint * @param {number} yPoint - * @return {Promise} + * @returns {Promise} */ @Cordova() tapToFocus(xPoint: number, yPoint: number): Promise { @@ -492,7 +518,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Add a listener for the back event for the preview - * @return {Promise} if back button pressed + * + * @returns {Promise} if back button pressed */ @Cordova() onBackButton(): Promise { @@ -501,7 +528,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Return in use device camera fov - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getHorizontalFOV(): Promise { @@ -510,7 +538,8 @@ export class CameraPreview extends AwesomeCordovaNativePlugin { /** * Get the characteristics of all available cameras - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getCameraCharacteristics(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/camera/index.ts b/src/@awesome-cordova-plugins/plugins/camera/index.ts index 385ded3f..69f1a023 100644 --- a/src/@awesome-cordova-plugins/plugins/camera/index.ts +++ b/src/@awesome-cordova-plugins/plugins/camera/index.ts @@ -136,7 +136,6 @@ export enum Direction { * * ``` * inside of the } Returns a Promise that resolves with Base64 encoding of the image data, or the image file URI, depending on cameraOptions, otherwise rejects with an error. */ @@ -256,6 +256,7 @@ export class Camera extends AwesomeCordovaNativePlugin { /** * Remove intermediate image files that are kept in temporary storage after calling camera.getPicture. * Applies only when the value of Camera.sourceType equals Camera.PictureSourceType.CAMERA and the Camera.destinationType equals Camera.DestinationType.FILE_URI. + * * @returns {Promise} */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/checkout/index.ts b/src/@awesome-cordova-plugins/plugins/checkout/index.ts index a18b6d8c..58c3ae6d 100644 --- a/src/@awesome-cordova-plugins/plugins/checkout/index.ts +++ b/src/@awesome-cordova-plugins/plugins/checkout/index.ts @@ -145,7 +145,6 @@ export interface Phone { * @name Checkout * @description * Checkout.com cordova plugin - * * @usage * ```typescript * import { Checkout } from '@awesome-cordova-plugins/checkout/ngx'; @@ -191,8 +190,9 @@ export interface Phone { export class Checkout extends AwesomeCordovaNativePlugin { /** * Initialize Frames plugin in Sandbox mode + * * @param publicKey {string} Merchant's sandbox public key - * @return {Promise} Returns a promise that resolves when Frames initiation is completed + * @returns {Promise} Returns a promise that resolves when Frames initiation is completed */ @Cordova() initSandboxClient(publicKey: string): Promise { @@ -201,8 +201,9 @@ export class Checkout extends AwesomeCordovaNativePlugin { /** * Initialize Frames plugin in Live mode + * * @param publicKey {string} Merchant's live public key - * @return {Promise} Returns a promise that resolves when Frames initiation is completed + * @returns {Promise} Returns a promise that resolves when Frames initiation is completed */ @Cordova() initLiveClient(publicKey: string): Promise { @@ -211,8 +212,9 @@ export class Checkout extends AwesomeCordovaNativePlugin { /** * Exchange card details for a reference token that can be used later to request a card payment from your backend. Tokens are single use and expire after 15 minutes. + * * @param ckoCardTokenRequest {CkoCardTokenRequest} Card tokenization request object - * @return {Promise} Returns a promise that resolves when Token response object + * @returns {Promise} Returns a promise that resolves when Token response object */ @Cordova() generateToken(ckoCardTokenRequest: CkoCardTokenRequest): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/chooser/index.ts b/src/@awesome-cordova-plugins/plugins/chooser/index.ts index 5bbad48d..41ce98e6 100644 --- a/src/@awesome-cordova-plugins/plugins/chooser/index.ts +++ b/src/@awesome-cordova-plugins/plugins/chooser/index.ts @@ -25,7 +25,6 @@ export interface ChooserResult { * * * ``` - * * @usage * ```typescript * import { Chooser } from '@awesome-cordova-plugins/chooser/ngx'; @@ -41,7 +40,6 @@ export interface ChooserResult { * .catch((error: any) => console.error(error)); * * ``` - * * @interfaces * ChooserResult */ @@ -56,8 +54,9 @@ export interface ChooserResult { export class Chooser extends AwesomeCordovaNativePlugin { /** * Displays native prompt for user to select a file. + * * @param {string} [accept] Optional MIME type filter (e.g. 'image/gif,video/*'). - * @return {Promise} Promise containing selected file's raw binary data, + * @returns {Promise} Promise containing selected file's raw binary data, * base64-encoded data: URI, MIME type, display name, and original URI. */ @Cordova() @@ -66,6 +65,7 @@ export class Chooser extends AwesomeCordovaNativePlugin { } /** * Displays native prompt for user to select a file. + * * @param {string} [accept] Optional MIME type filter (e.g. 'image/gif,video/*'). * @returns {Promise} Promise containing selected file's MIME type, display name, and original URI. * If user cancels, promise will be resolved as undefined. diff --git a/src/@awesome-cordova-plugins/plugins/clevertap/index.ts b/src/@awesome-cordova-plugins/plugins/clevertap/index.ts index d9e101e3..897a1960 100644 --- a/src/@awesome-cordova-plugins/plugins/clevertap/index.ts +++ b/src/@awesome-cordova-plugins/plugins/clevertap/index.ts @@ -1,13 +1,12 @@ import { Injectable } from '@angular/core'; import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-plugins/core'; -declare var clevertap: any; +declare let clevertap: any; /** * @name CleverTap * @description * Cordova Plugin that wraps CleverTap SDK for Android and iOS - * * @usage * ```typescript * import { CleverTap } from '@awesome-cordova-plugins/clevertap/ngx'; @@ -29,6 +28,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { * notify device ready * NOTE: in iOS use to be notified of launch Push Notification or Deep Link * in Android use only in android phonegap build projects + * * @returns {Promise} */ @Cordova() @@ -43,6 +43,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Personalization * Enables the Personalization API + * * @returns {Promise} */ @Cordova() @@ -53,6 +54,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Personalization * Disables the Personalization API + * * @returns {Promise} */ @Cordova() @@ -62,6 +64,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Enables tracking opt out for the currently active user. + * * @param optOut {boolean} * @returns {Promise} */ @@ -72,6 +75,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Sets CleverTap SDK to offline mode. + * * @param offline {boolean} * @returns {Promise} */ @@ -82,6 +86,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Enables the reporting of device network related information, including IP address. This reporting is disabled by default. + * * @param enable {boolean} * @returns {Promise} */ @@ -96,6 +101,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Registers for push notifications + * * @returns {Promise} */ @Cordova() @@ -105,6 +111,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Sets the device's push token + * * @param token {string} * @returns {Promise} */ @@ -115,6 +122,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Sets the device's Xiaomi push token + * * @param token {string} * @returns {Promise} */ @@ -125,6 +133,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Sets the device's Baidu push token + * * @param token {string} * @returns {Promise} */ @@ -135,6 +144,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Sets the device's Huawei push token + * * @param token {string} * @returns {Promise} */ @@ -145,6 +155,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Create Notification Channel for Android O+ + * * @param extras {any} * @returns {Promise} */ @@ -155,6 +166,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Create Notification Channel for Android O+ + * * @param channelID {string} * @param channelName {string} * @param channelDescription {string} @@ -175,6 +187,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Create Notification Channel for Android O+ + * * @param channelID {string} * @param channelName {string} * @param channelDescription {string} @@ -197,6 +210,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Create Notification Channel with Group ID for Android O+ + * * @param channelID {string} * @param channelName {string} * @param channelDescription {string} @@ -220,12 +234,14 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Create Notification Channel with Group ID for Android O+ + * * @param channelID {string} * @param channelName {string} * @param channelDescription {string} * @param importance {number} * @param groupId {string} * @param showBadge {boolean} + * @param sound * @returns {Promise} */ @Cordova() @@ -243,6 +259,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Create Notification Channel Group for Android O+ + * * @param groupID {string} * @param groupName {string} * @returns {Promise} @@ -254,6 +271,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Delete Notification Channel for Android O+ + * * @param channelID {string} * @returns {Promise} */ @@ -264,6 +282,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Delete Notification Group for Android O+ + * * @param groupID {string} * @returns {Promise} */ @@ -278,6 +297,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Record Screen View + * * @param screenName {string} * @returns {Promise} */ @@ -288,6 +308,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Record Event with Name + * * @param eventName {string} * @returns {Promise} */ @@ -298,6 +319,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Record Event with Name and Event properties + * * @param eventName {string} * @param eventProps {any} * @returns {Promise} @@ -309,6 +331,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Record Charged Event with Details and Items + * * @param details {any} object with transaction details * @param items {any} array of items purchased * @returns {Promise} @@ -320,6 +343,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get Event First Time + * * @param eventName {string} * callback returns epoch seconds or -1 * @returns {Promise} @@ -331,6 +355,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get Event Last Time + * * @param eventName {string} * callback returns epoch seconds or -1 * @returns {Promise} @@ -342,6 +367,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get Event Number of Occurrences + * * @param eventName {string} * calls back with int or -1 * @returns {Promise} @@ -353,6 +379,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get Event Details + * * @param eventName {string} * calls back with object {"eventName": , "firstTime":, "lastTime": , "count": } or empty object * @returns {Promise} @@ -365,6 +392,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get Event History * calls back with object {"eventName1":, "eventName2":} + * * @returns {Promise} */ @Cordova() @@ -389,6 +417,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { * for, among other things, more fine-grained geo-targeting and segmentation purposes. * Note: on iOS the call to CleverTapSDK must be made on the main thread due to LocationManager restrictions, but the CleverTapSDK method itself is non-blocking. * calls back with {lat:lat, lon:lon} lat and lon are floats + * * @returns {Promise} */ @Cordova() @@ -398,6 +427,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Set location + * * @param lat {number} * @param lon {number} * @returns {Promise} @@ -424,6 +454,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { * and data relating to the old user removed, and a new session is started * for the new user and data for that user refreshed via a network call to CleverTap. * In addition, any global frequency caps are reset as part of the switch. + * * @param profile {any} object * @returns {Promise} */ @@ -434,6 +465,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Set profile attributes + * * @param profile {any} object * @returns {Promise} */ @@ -444,6 +476,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Set profile attributes from facebook user + * * @param profile {any} facebook graph user object * @returns {Promise} */ @@ -454,6 +487,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Set profile attributes rom google plus user + * * @param profile {any} google plus user object * @returns {Promise} */ @@ -464,6 +498,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get User Profile Property + * * @param propertyName {string} * calls back with value of propertyName or false * @returns {Promise} @@ -476,6 +511,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get a unique CleverTap identifier suitable for use with install attribution providers. * calls back with unique CleverTap attribution identifier + * * @returns {Promise} */ @Cordova() @@ -486,6 +522,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get User Profile CleverTapID * calls back with CleverTapID or false + * * @returns {Promise} */ @Cordova() @@ -495,6 +532,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Remove the property specified by key from the user profile + * * @param key {string} * @returns {Promise} */ @@ -505,6 +543,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Method for setting a multi-value user profile property + * * @param key {string} * @param values {any} array of strings * @returns {Promise} @@ -516,6 +555,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Method for adding a value to a multi-value user profile property + * * @param key {string} * @param value {string} * @returns {Promise} @@ -527,6 +567,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Method for adding values to a multi-value user profile property + * * @param key {string} * @param values {any} array of strings * @returns {Promise} @@ -538,6 +579,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Method for removing a value from a multi-value user profile property + * * @param key {string} * @param value {string} * @returns {Promise} @@ -549,6 +591,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Method for removing a value from a multi-value user profile property + * * @param key {string} * @param values {any} array of strings * @returns {Promise} @@ -565,6 +608,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get Session Elapsed Time * calls back with seconds + * * @returns {Promise} */ @Cordova() @@ -575,6 +619,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get Session Total Visits * calls back with with int or -1 + * * @returns {Promise} */ @Cordova() @@ -585,6 +630,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get Session Screen Count * calls back with with int + * * @returns {Promise} */ @Cordova() @@ -595,6 +641,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get Session Previous Visit Time * calls back with with epoch seconds or -1 + * * @returns {Promise} */ @Cordova() @@ -605,6 +652,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Get Sesssion Referrer UTM details * object {"source": , "medium": , "campaign": } or empty object + * * @returns {Promise} */ @Cordova() @@ -614,6 +662,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to manually track the utm details for an incoming install referrer + * * @param source {string} * @param medium {string} * @param campaign {string} @@ -653,6 +702,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this method to open the App Inbox + * * @param styleConfig : any or empty object */ @Cordova() @@ -662,6 +712,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Fetch all Inbox Messages + * * @returns {Promise} */ @Cordova() @@ -671,6 +722,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Fetch all Unread Inbox Messages + * * @returns {Promise} */ @Cordova() @@ -680,6 +732,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Fetch Inbox Message For Id + * * @param messageId {string} * @returns {Promise} */ @@ -690,6 +743,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Delete Inbox Message For Id + * * @param messageId {string} * @returns {Promise} */ @@ -700,6 +754,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Mark Read Inbox Message For Id + * * @param messageId {string} * @returns {Promise} */ @@ -710,6 +765,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Mark Push Inbox Notification Viewed Event for Id + * * @param messageId {string} * @returns {Promise} */ @@ -720,6 +776,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Mark Push Inbox Notification Clicked Event for Id + * * @param messageId {string} * @returns {Promise} */ @@ -730,6 +787,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to SetUIEditor Connection + * * @param enabled {boolean} * @returns {Promise} */ @@ -740,6 +798,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Register Boolean Variable + * * @param varName {string} * @returns {Promise} */ @@ -750,6 +809,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Register Double Variable + * * @param varName {string} * @returns {Promise} */ @@ -760,6 +820,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Register Integer Variable + * * @param varName {string} * @returns {Promise} */ @@ -770,6 +831,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Register String Variable + * * @param varName {string} * @returns {Promise} */ @@ -780,6 +842,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Register List of Boolean Variable + * * @param varName {string} * @returns {Promise} */ @@ -790,6 +853,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Register List of Double Variable + * * @param varName {string} * @returns {Promise} */ @@ -800,6 +864,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Register List of Integer Variable + * * @param varName {string} * @returns {Promise} */ @@ -810,6 +875,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Register List of String Variable + * * @param varName {string} * @returns {Promise} */ @@ -820,6 +886,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Register Map of Boolean Variable + * * @param varName {string} * @returns {Promise} */ @@ -830,6 +897,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Register Map of Double Variable + * * @param varName {string} * @returns {Promise} */ @@ -840,6 +908,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Register Map of Integer Variable + * * @param varName {string} * @returns {Promise} */ @@ -850,6 +919,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Register Map of String Variable + * * @param varName {string} * @returns {Promise} */ @@ -860,6 +930,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get Boolean Variable + * * @param varName {string} * @param defaultValue {boolean} * @returns {Promise} @@ -871,6 +942,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get Double Variable + * * @param varName {string} * @param defaultValue {number} * @returns {Promise} @@ -882,6 +954,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get Integer Variable + * * @param varName {string} * @param defaultValue {number} * @returns {Promise} @@ -893,6 +966,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get String Variable + * * @param varName {string} * @param defaultValue {string} * @returns {Promise} @@ -904,6 +978,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get List of Boolean Variable + * * @param varName {string} * @param defaultValue {any} * @returns {Promise} @@ -915,6 +990,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get List of Double Variable + * * @param varName {string} * @param defaultValue {any} * @returns {Promise} @@ -926,6 +1002,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get List of Integer Variable + * * @param varName {string} * @param defaultValue {any} * @returns {Promise} @@ -937,6 +1014,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get List of String Variable + * * @param varName {string} * @param defaultValue {any} * @returns {Promise} @@ -948,6 +1026,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to get Map of Boolean Variable + * * @param varName {string} * @param defaultValue {any} * @returns {Promise} @@ -959,6 +1038,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get Map of Double Variable + * * @param varName {string} * @param defaultValue {any} * @returns {Promise} @@ -970,6 +1050,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get Map of Integer Variable + * * @param varName {string} * @param defaultValue {any} * @returns {Promise} @@ -981,6 +1062,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get Map of String Variable + * * @param varName {string} * @param defaultValue {any} * @returns {Promise} @@ -992,6 +1074,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get All Display Units + * * @returns {Promise} */ @Cordova() @@ -1001,6 +1084,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get Display Unit For Id + * * @param id {string} * @returns {Promise} */ @@ -1011,6 +1095,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Push DisplayUnit Viewed Event for ID + * * @param id {string} * @returns {Promise} */ @@ -1021,6 +1106,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Push DisplayUnit Clicked Event for ID + * * @param id {string} * @returns {Promise} */ @@ -1031,6 +1117,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get Feature Flag for key + * * @param key {string} * @param defaultValue {string} * @returns {Promise} @@ -1042,6 +1129,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Set Defaults for Product Config + * * @param defaults {any} * @returns {Promise} */ @@ -1052,6 +1140,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this for Product Config Fetch + * * @param defaults {any} * @returns {Promise} */ @@ -1062,6 +1151,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this for Product Config Fetch with Min Interval + * * @param timeInterval {number} * @returns {Promise} */ @@ -1072,6 +1162,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this for Product Config Activate + * * @returns {Promise} */ @Cordova() @@ -1081,6 +1172,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this for Product Config Fetch and Activate + * * @returns {Promise} */ @Cordova() @@ -1090,6 +1182,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to set Product Config Fetch with Min Interval + * * @param timeInterval {number} * @returns {Promise} */ @@ -1100,6 +1193,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get Last Fetch Time Interval + * * @returns {Promise} */ @Cordova() @@ -1109,6 +1203,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get String + * * @param key {string} * @returns {Promise} */ @@ -1119,6 +1214,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get Boolean + * * @param key {string} * @returns {Promise} */ @@ -1129,6 +1225,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get Long + * * @param key {string} * @returns {Promise} */ @@ -1139,6 +1236,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Get Double + * * @param key {string} * @returns {Promise} */ @@ -1149,6 +1247,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { /** * Call this to Reset Product Config + * * @returns {Promise} */ @Cordova() @@ -1161,6 +1260,7 @@ export class CleverTap extends AwesomeCordovaNativePlugin { ******************/ /** * 0 is off, 1 is info, 2 is debug, default is 1 + * * @param level {number} * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/clipboard/index.ts b/src/@awesome-cordova-plugins/plugins/clipboard/index.ts index 0d66b2ea..146ac45a 100644 --- a/src/@awesome-cordova-plugins/plugins/clipboard/index.ts +++ b/src/@awesome-cordova-plugins/plugins/clipboard/index.ts @@ -5,8 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @premier clipboard * @description * Clipboard management plugin for Cordova that supports iOS, Android, and Windows Phone 8. - * - * * @usage * ```typescript * import { Clipboard } from '@awesome-cordova-plugins/clipboard/ngx'; @@ -41,6 +39,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class Clipboard extends AwesomeCordovaNativePlugin { /** * Copies the given text + * * @param {string} text Text that gets copied on the system clipboard * @returns {Promise} Returns a promise after the text has been copied */ @@ -51,6 +50,7 @@ export class Clipboard extends AwesomeCordovaNativePlugin { /** * Pastes the text stored in clipboard + * * @returns {Promise} Returns a promise after the text has been pasted */ @Cordova() @@ -60,6 +60,7 @@ export class Clipboard extends AwesomeCordovaNativePlugin { /** * Clear the text stored in clipboard + * * @returns {Promise} Returns a promise after the text has been cleaned */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/cloud-settings/index.ts b/src/@awesome-cordova-plugins/plugins/cloud-settings/index.ts index f621565f..f0a48d52 100644 --- a/src/@awesome-cordova-plugins/plugins/cloud-settings/index.ts +++ b/src/@awesome-cordova-plugins/plugins/cloud-settings/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Cloud Settings * @description * Stores app settings in cloud storage so if the user re-installs the app or installs it on a different device, the settings will be restored and available in the new installation. - * * @usage * ```typescript * import { CloudSettings } from '@awesome-cordova-plugins/cloud-settings/ngx'; @@ -41,7 +40,8 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class CloudSettings extends AwesomeCordovaNativePlugin { /** * Indicates if any stored cloud settings currently exist for the current user. - * @return {Promise} Will be passed a boolean flag which indicates whether an store settings exist for the user. + * + * @returns {Promise} Will be passed a boolean flag which indicates whether an store settings exist for the user. */ @Cordova() exists(): Promise { @@ -50,10 +50,11 @@ export class CloudSettings extends AwesomeCordovaNativePlugin { /** * Saves the settings to cloud backup. + * * @param {object} settings - a JSON structure representing the user settings to save to cloud backup. * @param {boolean} [overwrite] - (optional) if true, existing settings will be replaced rather than updated. Defaults to false. * If false, existing settings will be merged with the new settings passed to this function. - * @return {Promise} Will be passed a single object argument which contains the saved settings as a JSON object. + * @returns {Promise} Will be passed a single object argument which contains the saved settings as a JSON object. */ @Cordova({ successIndex: 1, @@ -65,7 +66,8 @@ export class CloudSettings extends AwesomeCordovaNativePlugin { /** * Loads the current settings. - * @return {Promise} Will be passed a single object argument which contains the saved settings as a JSON object. + * + * @returns {Promise} Will be passed a single object argument which contains the saved settings as a JSON object. */ @Cordova() load(): Promise { @@ -74,6 +76,7 @@ export class CloudSettings extends AwesomeCordovaNativePlugin { /** * Registers a function which will be called if/when settings on the device have been updated from the cloud. + * * @param {Function} handler - callback function to invoke when device settings have been updated from the cloud. */ @Cordova({ sync: true }) @@ -81,7 +84,8 @@ export class CloudSettings extends AwesomeCordovaNativePlugin { /** * Outputs verbose log messages from the native plugin components to the JS console. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() enableDebug(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/code-push/index.ts b/src/@awesome-cordova-plugins/plugins/code-push/index.ts index 765770f5..5d4b9fa8 100644 --- a/src/@awesome-cordova-plugins/plugins/code-push/index.ts +++ b/src/@awesome-cordova-plugins/plugins/code-push/index.ts @@ -249,7 +249,6 @@ interface CodePushCordovaPlugin { * The callback will be called only once, and the possible statuses are defined by the SyncStatus enum. * @param {SyncOptions} [syncOptions] Optional SyncOptions parameter configuring the behavior of the sync operation. * @param {SuccessCallback} [downloadProgress] Optional callback invoked during the download process. It is called several times with one DownloadProgress parameter. - * */ sync( syncCallback?: SuccessCallback, @@ -441,7 +440,6 @@ export interface DownloadProgress { * CodePush plugin for Cordova by Microsoft that supports iOS and Android. * * For more info, please see https://github.com/Dellos7/example-cordova-code-push-plugin - * * @usage * ```typescript * import { CodePush } from '@awesome-cordova-plugins/code-push/ngx'; @@ -481,6 +479,7 @@ export class CodePush extends AwesomeCordovaNativePlugin { /** * Gets the pending package information, if any. A pending package is one that has been installed but the application still runs the old code. * This happens only after a package has been installed using ON_NEXT_RESTART or ON_NEXT_RESUME mode, but the application was not restarted/resumed yet. + * * @returns {Promise} */ @Cordova() @@ -516,6 +515,7 @@ export class CodePush extends AwesomeCordovaNativePlugin { /** * Reloads the application. If there is a pending update package installed using ON_NEXT_RESTART or ON_NEXT_RESUME modes, the update * will be immediately visible to the user. Otherwise, calling this function will simply reload the current version of the application. + * * @returns {Promise} */ @Cordova() @@ -541,7 +541,6 @@ export class CodePush extends AwesomeCordovaNativePlugin { * @param {SyncOptions} [syncOptions] Optional SyncOptions parameter configuring the behavior of the sync operation. * @param {SuccessCallback} [downloadProgress] Optional callback invoked during the download process. It is called several times with one DownloadProgress parameter. * @returns {Observable} - * */ @Cordova({ observable: true, diff --git a/src/@awesome-cordova-plugins/plugins/custom-uisdk/index.ts b/src/@awesome-cordova-plugins/plugins/custom-uisdk/index.ts index 03cc1e2a..c3171f43 100755 --- a/src/@awesome-cordova-plugins/plugins/custom-uisdk/index.ts +++ b/src/@awesome-cordova-plugins/plugins/custom-uisdk/index.ts @@ -12,7 +12,6 @@ import { * @name CustomUISDK * @description * This plugin is used to access Paytm's native CustomUISDK framework's apis. - * * @usage * ```typescript * import { CustomUISDK } from '@awesome-cordova-plugins/custom-uisdk/ngx'; @@ -38,9 +37,10 @@ import { export class CustomUISDK extends AwesomeCordovaNativePlugin { /** * This function show dialog to ask user permision to fetch authcode + * * @param clientId {string} unique id give to each merchant * @param mid {string} merchant id - * @return {Promise} Returns authcode + * @returns {Promise} Returns authcode */ @Cordova() fetchAuthCode(clientId: string, mid: string): Promise { @@ -49,7 +49,8 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { /** * This function check that paytm app is installed or not - * @return {Promise} Returns installed - true or not -false + * + * @returns {Promise} Returns installed - true or not -false */ @Cordova() isPaytmAppInstalled(): Promise { @@ -58,7 +59,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { /** * @param mid {string} merchant id - * @return {Promise} Returns if has payment methods - true or not -false + * @returns {Promise} Returns if has payment methods - true or not -false */ @Cordova() checkHasInstrument(mid: string): Promise { @@ -87,7 +88,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { /** * @param paymentFlow {string} payment type NONE, ADDANDPAY - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() goForWalletTransaction(paymentFlow: string): Promise { @@ -95,7 +96,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { } /** - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() appInvoke(): Promise { @@ -113,7 +114,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { * @param emiChannelId {string} emi plan id * @param authMode {string} authentication mode 'otp' 'pin' * @param saveCard {boolean} save card for next time - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() goForNewCardTransaction( @@ -140,7 +141,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { * @param issuingBankCode {string} issuing bank code * @param emiChannelId {string} emi plan id * @param authMode {string} authentication mode 'otp' 'pin' - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() goForSavedCardTransaction( @@ -159,7 +160,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { /** * @param netBankingCode {string} bank channel code * @param paymentFlow {string} payment type NONE, ADDANDPAY - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() goForNetBankingTransaction(netBankingCode: string, paymentFlow: string): Promise { @@ -170,7 +171,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { * @param upiCode {string} upi code * @param paymentFlow {string} payment type NONE, ADDANDPAY * @param saveVPA {boolean} save vpa for future transaction - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() goForUpiCollectTransaction(upiCode: string, paymentFlow: string, saveVPA: boolean): Promise { @@ -178,7 +179,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { } /** - * @return {Promise} Returns upi app list names + * @returns {Promise} Returns upi app list names */ @Cordova() getUpiIntentList(): Promise { @@ -188,7 +189,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { /** * @param appName {string} upi app name * @param paymentFlow {string} payment type NONE, ADDANDPAY - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() goForUpiIntentTransaction(appName: string, paymentFlow: string): Promise { @@ -200,7 +201,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { * @param paymentFlow {string} payment type NONE, ADDANDPAY * @param bankAccountJson {{}} bank account json object * @param merchantDetailsJson {{}} merchant detail json - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() goForUpiPushTransaction( @@ -215,7 +216,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { /** * @param vpaName {string} vpa name * @param bankAccountJson {{}} bank account json object - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() fetchUpiBalance(bankAccountJson: {}, vpaName: string): Promise { @@ -225,7 +226,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { /** * @param vpaName {string} vpa name * @param bankAccountJson {{}} bank account json object - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() setUpiMpin(bankAccountJson: {}, vpaName: string): Promise { @@ -238,7 +239,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { * @param token {string} token fetch from api * @param mid {string} merchant id * @param referenceId {string} reference id - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() getBin(cardSixDigit: string, tokenType: string, token: string, mid: string, referenceId: string): Promise { @@ -251,7 +252,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { * @param mid {string} merchant id * @param orderId {string} order id required only if token type is TXN_TOKEN * @param referenceId {string} reference id required only if token type is ACCESS - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() fetchNBList(tokenType: string, token: string, mid: string, orderId: string, referenceId: string): Promise { @@ -261,7 +262,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { /** * @param channelCode {string} bank channel code * @param cardType {string} card type debit or credit - * @return {Promise} Returns object of response + * @returns {Promise} Returns object of response */ @Cordova() fetchEmiDetails(channelCode: string, cardType: string): Promise { @@ -269,7 +270,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { } /** - * @return {Promise} Returns last successfully used net backing code + * @returns {Promise} Returns last successfully used net backing code */ @Cordova() @@ -278,7 +279,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { } /** - * @return {Promise} Returns last successfully used vpa code + * @returns {Promise} Returns last successfully used vpa code */ @Cordova() @@ -289,7 +290,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { /** * @param clientId {string} unique id give to each merchant * @param authCode {string} fetched auth code - * @return {Promise} Returns last successfully used vpa code + * @returns {Promise} Returns last successfully used vpa code */ @Cordova() isAuthCodeValid(clientId: string, authCode: string): Promise { @@ -297,7 +298,7 @@ export class CustomUISDK extends AwesomeCordovaNativePlugin { } /** - * @return {Promise} Returns current environment + * @returns {Promise} Returns current environment */ @Cordova() getEnvironment(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/deeplinks/index.ts b/src/@awesome-cordova-plugins/plugins/deeplinks/index.ts index c280cb3d..932057e7 100644 --- a/src/@awesome-cordova-plugins/plugins/deeplinks/index.ts +++ b/src/@awesome-cordova-plugins/plugins/deeplinks/index.ts @@ -36,7 +36,6 @@ export interface DeeplinkOptions { * * Please read the [ionic plugin deeplinks docs](https://github.com/ionic-team/ionic-plugin-deeplinks) for iOS and Android integration. * You must add `universal-links` to your `config.xml` and set up Apple App Site Association (AASA) for iOS and Asset Links for Android. - * * @usage * ```typescript * import { Deeplinks } from '@awesome-cordova-plugins/deeplinks/ngx'; @@ -78,7 +77,6 @@ export interface DeeplinkOptions { * * See the [Ionic Deeplinks Demo](https://github.com/ionic-team/ionic2-deeplinks-demo/blob/master/app/app.ts) for an example of how to * retrieve the `NavController` reference at runtime. - * * @interfaces * DeeplinkMatch */ @@ -125,11 +123,8 @@ export class Deeplinks extends AwesomeCordovaNativePlugin { * paths takes an object of the form { 'path': data }. If a deeplink * matches the path, the resulting path-data pair will be returned in the * promise result which you can then use to navigate in the app as you see fit. - * * @param {Object} paths - * * @param {DeeplinkOptions} options - * * @returns {Observable} Returns an Observable that resolves each time a deeplink comes through, and * errors if a deeplink comes through that does not match a given path. */ diff --git a/src/@awesome-cordova-plugins/plugins/device-accounts/index.ts b/src/@awesome-cordova-plugins/plugins/device-accounts/index.ts index 1312779d..49d19393 100644 --- a/src/@awesome-cordova-plugins/plugins/device-accounts/index.ts +++ b/src/@awesome-cordova-plugins/plugins/device-accounts/index.ts @@ -16,7 +16,6 @@ export interface AndroidAccount { * @name Device Accounts * @description * Gets the Google accounts associated with the Android device - * * @usage * ```typescript * import { DeviceAccounts } from '@awesome-cordova-plugins/device-accounts/ngx'; @@ -44,6 +43,7 @@ export interface AndroidAccount { export class DeviceAccounts extends AwesomeCordovaNativePlugin { /** * Gets all accounts registered on the Android Device + * * @returns {Promise} */ @Cordova() @@ -53,6 +53,7 @@ export class DeviceAccounts extends AwesomeCordovaNativePlugin { /** * Get all accounts registered on Android device for requested type + * * @param {string} type * @returns {Promise} */ @@ -63,6 +64,7 @@ export class DeviceAccounts extends AwesomeCordovaNativePlugin { /** * Get all emails registered on Android device (accounts with 'com.google' type) + * * @returns {Promise} */ @Cordova() @@ -72,6 +74,7 @@ export class DeviceAccounts extends AwesomeCordovaNativePlugin { /** * Get the first email registered on Android device + * * @returns {Promise} */ @Cordova() @@ -81,6 +84,7 @@ export class DeviceAccounts extends AwesomeCordovaNativePlugin { /** * Get permissions for access to email registered on Android device 8.0+ + * * @returns {Promise} */ @Cordova() @@ -90,6 +94,7 @@ export class DeviceAccounts extends AwesomeCordovaNativePlugin { /** * Get permissions for access to email registered on Android device 8.0+ for requested type + * * @param {string} type * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/device-motion/index.ts b/src/@awesome-cordova-plugins/plugins/device-motion/index.ts index 15bc36c8..833346f2 100644 --- a/src/@awesome-cordova-plugins/plugins/device-motion/index.ts +++ b/src/@awesome-cordova-plugins/plugins/device-motion/index.ts @@ -35,7 +35,6 @@ export interface DeviceMotionAccelerometerOptions { * @name Device Motion * @description * Requires Cordova plugin: `cordova-plugin-device-motion`. For more info, please see the [Device Motion docs](https://github.com/apache/cordova-plugin-device-motion). - * * @usage * ```typescript * import { DeviceMotion, DeviceMotionAccelerationData } from '@awesome-cordova-plugins/device-motion/ngx'; @@ -84,6 +83,7 @@ export interface DeviceMotionAccelerometerOptions { export class DeviceMotion extends AwesomeCordovaNativePlugin { /** * Get the current acceleration along the x, y, and z axes. + * * @returns {Promise} Returns object with x, y, z, and timestamp properties */ @Cordova() @@ -93,6 +93,7 @@ export class DeviceMotion extends AwesomeCordovaNativePlugin { /** * Watch the device acceleration. Clear the watch by unsubscribing from the observable. + * * @param {AccelerometerOptions} options list of options for the accelerometer. * @returns {Observable} Observable returns an observable that you can subscribe to */ diff --git a/src/@awesome-cordova-plugins/plugins/device-orientation/index.ts b/src/@awesome-cordova-plugins/plugins/device-orientation/index.ts index 0669b854..c12db8b0 100644 --- a/src/@awesome-cordova-plugins/plugins/device-orientation/index.ts +++ b/src/@awesome-cordova-plugins/plugins/device-orientation/index.ts @@ -40,7 +40,6 @@ export interface DeviceOrientationCompassOptions { * @name Device Orientation * @description * Requires Cordova plugin: `cordova-plugin-device-orientation`. For more info, please see the [Device Orientation docs](https://github.com/apache/cordova-plugin-device-orientation). - * * @usage * ```typescript * // DeviceOrientationCompassHeading is an interface for compass @@ -90,6 +89,7 @@ export interface DeviceOrientationCompassOptions { export class DeviceOrientation extends AwesomeCordovaNativePlugin { /** * Get the current compass heading. + * * @returns {Promise} */ @Cordova() @@ -101,6 +101,7 @@ export class DeviceOrientation extends AwesomeCordovaNativePlugin { * Get the device current heading at a regular interval * * Stop the watch by unsubscribing from the observable + * * @param {DeviceOrientationCompassOptions} [options] Options for compass. Frequency and Filter. Optional * @returns {Observable} Returns an observable that contains the compass heading */ diff --git a/src/@awesome-cordova-plugins/plugins/device/index.ts b/src/@awesome-cordova-plugins/plugins/device/index.ts index 974d7ee0..e4707d59 100644 --- a/src/@awesome-cordova-plugins/plugins/device/index.ts +++ b/src/@awesome-cordova-plugins/plugins/device/index.ts @@ -8,7 +8,6 @@ declare const window: any; * @premier device * @description * Access information about the underlying device and platform. - * * @usage * ```typescript * import { Device } from '@awesome-cordova-plugins/device/ngx'; diff --git a/src/@awesome-cordova-plugins/plugins/dfu-update/index.ts b/src/@awesome-cordova-plugins/plugins/dfu-update/index.ts index aace83d7..170df85e 100644 --- a/src/@awesome-cordova-plugins/plugins/dfu-update/index.ts +++ b/src/@awesome-cordova-plugins/plugins/dfu-update/index.ts @@ -23,7 +23,6 @@ export interface UpdateOptions { * @name Dfu Update * @description * This plugin is a Wrapper to use Nordic Semiconductor's Device Firmware Update (DFU) service to update a Bluetooth LE device. - * * @usage * ```typescript * import { DfuUpdate } from '@awesome-cordova-plugins/dfu-update/ngx'; @@ -53,8 +52,9 @@ export interface UpdateOptions { export class DfuUpdate extends AwesomeCordovaNativePlugin { /** * Start the Firmware-Update-Process + * * @param options - Options for the process - * @return {Observable} Returns a Observable that emits when something happens + * @returns {Observable} Returns a Observable that emits when something happens */ @Cordova({ observable: true, diff --git a/src/@awesome-cordova-plugins/plugins/diagnostic/index.ts b/src/@awesome-cordova-plugins/plugins/diagnostic/index.ts index 83297666..dbdf0258 100644 --- a/src/@awesome-cordova-plugins/plugins/diagnostic/index.ts +++ b/src/@awesome-cordova-plugins/plugins/diagnostic/index.ts @@ -5,7 +5,6 @@ import { Cordova, CordovaProperty, AwesomeCordovaNativePlugin, Plugin } from '@a * @name Diagnostic * @description * Checks whether device hardware features are enabled or available to the app, e.g. camera, GPS, wifi - * * @usage * ```typescript * import { Diagnostic } from '@awesome-cordova-plugins/diagnostic/ngx'; @@ -32,7 +31,6 @@ import { Cordova, CordovaProperty, AwesomeCordovaNativePlugin, Plugin } from '@a * }).catch(e => console.error(e)); * * ``` - * */ @Plugin({ pluginName: 'Diagnostic', @@ -158,6 +156,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if app is able to access device location. + * * @returns {Promise} */ @Cordova() @@ -168,6 +167,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if Wifi is connected/enabled. On iOS this returns true if the device is connected to a network by WiFi. On Android and Windows 10 Mobile this returns true if the WiFi setting is set to enabled. * On Android this requires permission. `` + * * @returns {Promise} */ @Cordova() @@ -178,6 +178,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the device has a camera. On Android this returns true if the device has a camera. On iOS this returns true if both the device has a camera AND the application is authorized to use it. On Windows 10 Mobile this returns true if both the device has a rear-facing camera AND the * application is authorized to use it. + * * @param {boolean} [externalStorage] Android only: If true, checks permission for READ_EXTERNAL_STORAGE in addition to CAMERA run-time permission. * cordova-plugin-camera@2.2+ requires both of these permissions. Defaults to true. * @returns {Promise} @@ -190,6 +191,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the device has Bluetooth capabilities and if so that Bluetooth is switched on (same on Android, iOS and Windows 10 Mobile) * On Android this requires permission + * * @returns {Promise} */ @Cordova() @@ -223,6 +225,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns true if the WiFi setting is set to enabled, and is the same as `isWifiAvailable()` + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'Windows 10'] }) @@ -233,6 +236,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Enables/disables WiFi on the device. * Requires `ACCESS_WIFI_STATE` and `CHANGE_WIFI_STATE` permissions on Android + * * @param {boolean} state * @returns {Promise} */ @@ -244,6 +248,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Enables/disables Bluetooth on the device. * Requires `BLUETOOTH` and `BLUETOOTH_ADMIN` permissions on Android + * * @param {boolean} state * @returns {Promise} */ @@ -256,6 +261,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns true if the device setting for location is on. On Android this returns true if Location Mode is switched on. On iOS this returns true if Location Services is switched on. + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'] }) @@ -266,6 +272,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the application is authorized to use location. * Note for Android: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return GRANTED status as permissions are already granted at installation time. + * * @returns {Promise} */ @Cordova() @@ -275,6 +282,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns the location authorization status for the application. + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'] }) @@ -296,6 +304,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if camera hardware is present on device. + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'] }) @@ -306,6 +315,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the application is authorized to use the camera. * Note for Android: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return TRUE as permissions are already granted at installation time. + * * @param {boolean} [externalStorage] Android only: If true, checks permission for READ_EXTERNAL_STORAGE in addition to CAMERA run-time permission. * cordova-plugin-camera@2.2+ requires both of these permissions. Defaults to true. * @returns {Promise} @@ -317,6 +327,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns the camera authorization status for the application. + * * @param {boolean} [externalStorage] Android only: If true, checks permission for READ_EXTERNAL_STORAGE in addition to CAMERA run-time permission. * cordova-plugin-camera@2.2+ requires both of these permissions. Defaults to true. * @returns {Promise} @@ -328,6 +339,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Requests camera authorization for the application. + * * @param {boolean} [externalStorage] Android only: If true, requests permission for READ_EXTERNAL_STORAGE in addition to CAMERA run-time permission. * cordova-plugin-camera@2.2+ requires both of these permissions. Defaults to true. * @returns {Promise} @@ -339,6 +351,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the application is authorized to use the microphone. + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'] }) @@ -348,6 +361,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns the microphone authorization status for the application. + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'] }) @@ -357,6 +371,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Requests microphone authorization for the application. + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'] }) @@ -366,6 +381,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the application is authorized to use contacts (address book). + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'] }) @@ -375,6 +391,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns the contacts authorization status for the application. + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'] }) @@ -384,6 +401,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Requests contacts authorization for the application. + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'] }) @@ -399,6 +417,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * * Notes for iOS: * - This relates to Calendar Events (not Calendar Reminders) + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'] }) @@ -445,6 +464,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * Opens settings page for this app. * On Android, this opens the "App Info" page in the Settings app. * On iOS, this opens the app settings page in the Settings app. This works only on iOS 8+ - iOS 7 and below will invoke the errorCallback. + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'] }) @@ -454,6 +474,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns the state of Bluetooth on the device. + * * @returns {Promise} */ @Cordova({ platforms: ['Android', 'iOS'] }) @@ -463,6 +484,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Registers a function to be called when a change in Bluetooth state occurs. + * * @param {Function} handler */ @Cordova({ platforms: ['Android', 'iOS'], sync: true }) @@ -470,6 +492,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Registers a function to be called when a change in Location state occurs. + * * @param {Function} handler */ @Cordova({ platforms: ['Android', 'iOS'], sync: true }) @@ -480,6 +503,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if high-accuracy locations are available to the app from GPS hardware. * Returns true if Location mode is enabled and is set to "Device only" or "High accuracy" AND if the app is authorized to use location. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -492,6 +516,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * Returns true if Location mode is enabled and is set to either: * - Device only = GPS hardware only (high accuracy) * - High accuracy = GPS hardware, network triangulation and Wifi network IDs (high and low accuracy) + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -502,6 +527,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if low-accuracy locations are available to the app from network triangulation/WiFi access points. * Returns true if Location mode is enabled and is set to "Battery saving" or "High accuracy" AND if the app is authorized to use location. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -514,6 +540,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * Returns true if Location mode is enabled and is set to either: * - Battery saving = network triangulation and Wifi network IDs (low accuracy) * - High accuracy = GPS hardware, network triangulation and Wifi network IDs (high and low accuracy) + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -523,6 +550,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns the current location mode setting for the device. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -533,6 +561,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns the current authorization status for a given permission. * Note: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return GRANTED status as permissions are already granted at installation time. + * * @param permission * @returns {Promise} */ @@ -544,6 +573,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns the current authorization status for multiple permissions. * Note: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return GRANTED status as permissions are already granted at installation time. + * * @param {any[]} permissions * @returns {Promise} */ @@ -555,6 +585,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Requests app to be granted authorization for a runtime permission. * Note: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will have no effect as the permissions are already granted at installation time. + * * @param permission * @returns {Promise} */ @@ -566,6 +597,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Requests app to be granted authorization for multiple runtime permissions. * Note: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return GRANTED status as permissions are already granted at installation time. + * * @param {any[]} permissions * @returns {Promise} */ @@ -579,6 +611,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * Note that only one request can be made concurrently because the native API cannot handle concurrent requests, * so the plugin will invoke the error callback if attempting to make more than one simultaneous request. * Multiple permission requests should be grouped into a single call since the native API is setup to handle batch requests of multiple permission groups. + * * @returns {boolean} */ @Cordova({ sync: true }) @@ -589,6 +622,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Registers a function to be called when a runtime permission request has completed. * Pass in a falsy value to de-register the currently registered function. + * * @param {Function} handler */ @Cordova({ sync: true }) @@ -599,6 +633,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the device setting for Bluetooth is switched on. * This requires `BLUETOOTH` permission on Android + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -608,6 +643,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the device has Bluetooth capabilities. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -617,6 +653,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the device has Bluetooth Low Energy (LE) capabilities. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -626,6 +663,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the device supports Bluetooth Low Energy (LE) Peripheral mode. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -635,6 +673,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the application is authorized to use external storage. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -644,6 +683,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * CReturns the external storage authorization status for the application. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -653,6 +693,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Requests external storage authorization for the application. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -695,6 +736,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if NFC hardware is present on device. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -705,6 +747,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the device setting for NFC is switched on. * Note: this operation does not require NFC permission in the manifest. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -715,6 +758,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if NFC is available to the app. Returns true if the device has NFC capabilities AND if NFC setting is switched on. * Note: this operation does not require NFC permission in the manifest. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -724,7 +768,9 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Registers a function to be called when a change in NFC state occurs. Pass in a falsy value to de-register the currently registered function. + * * @param {Function} hander callback function to be called when NFC state changes + * @param handler * @returns {Promise} */ @Cordova({ @@ -735,6 +781,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the device data roaming setting is enabled. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -744,6 +791,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the device setting for ADB(debug) is switched on. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -753,6 +801,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the device is rooted. + * * @returns {Promise} */ @Cordova({ platforms: ['Android'] }) @@ -764,6 +813,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the application is authorized to use the Camera Roll in Photos app. + * * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) @@ -773,6 +823,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns the authorization status for the application to use the Camera Roll in Photos app. + * * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) @@ -784,6 +835,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * Requests camera roll authorization for the application. * Should only be called if authorization status is NOT_REQUESTED. * Calling it when in any other state will have no effect. + * * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) @@ -793,6 +845,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if remote (push) notifications are enabled. + * * @returns {Promise} */ @Cordova({ platforms: ['iOS', 'Android'] }) @@ -802,6 +855,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Indicates if the app is registered for remote (push) notifications on the device. + * * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) @@ -812,6 +866,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns the authorization status for the application to use Remote Notifications. * Note: Works on iOS 10+ only (iOS 9 and below will invoke the error callback). + * * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) @@ -821,6 +876,9 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Requests reminders authorization for the application. + * + * @param types + * @param omitRegistration * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) @@ -831,6 +889,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Indicates the current setting of notification types for the app in the Settings app. * Note: on iOS 8+, if "Allow Notifications" switch is OFF, all types will be returned as disabled. + * * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) @@ -840,6 +899,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the application is authorized to use reminders. + * * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) @@ -849,6 +909,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns the reminders authorization status for the application. + * * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) @@ -858,6 +919,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Requests reminders authorization for the application. + * * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) @@ -867,6 +929,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if the application is authorized for background refresh. + * * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) @@ -876,6 +939,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Returns the background refresh authorization status for the application. + * * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) @@ -887,7 +951,8 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * Requests Bluetooth authorization for the application. * * Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#requestbluetoothauthorization) - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) requestBluetoothAuthorization(): Promise { @@ -896,7 +961,8 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { /** * Checks if motion tracking is available on the current device. - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) isMotionAvailable(): Promise { @@ -908,7 +974,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * There's no direct way to determine if authorization was granted or denied, so the Pedometer API must be used to indirectly determine this: * therefore, if the device supports motion tracking but not Pedometer Event Tracking, the outcome of requesting motion detection cannot be determined. * - * @return {Promise} + * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) isMotionRequestOutcomeAvailable(): Promise { @@ -920,7 +986,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * * Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#requestmotionauthorization) * - * @return {Promise} + * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) requestMotionAuthorization(): Promise { @@ -932,7 +998,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * * Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#getmotionauthorizationstatus) * - * @return {Promise} + * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) getMotionAuthorizationStatus(): Promise { @@ -944,7 +1010,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * * Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#getlocationaccuracyauthorization) * - * @return {Promise} + * @returns {Promise} */ @Cordova({ platform: ['iOS'] }) getLocationAccuracyAuthorization(): Promise { @@ -956,7 +1022,8 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * * Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#requesttemporaryfullaccuracyauthorization) * - * @return {Promise} + * @param purpose + * @returns {Promise} */ @Cordova({ platforms: ['iOS'] }) requestTemporaryFullAccuracyAuthorization(purpose: string): Promise { @@ -967,6 +1034,8 @@ export class Diagnostic extends AwesomeCordovaNativePlugin { * Registers a function to be called when a change in location accuracy authorization occurs on iOS 14+. * * Learn more about this method [here](https://github.com/dpa99c/cordova-diagnostic-plugin#registerLocationAccuracyAuthorizationChangeHandler) + * + * @param handler */ @Cordova({ platforms: ['iOS'], sync: true }) registerLocationAccuracyAuthorizationChangeHandler(handler: Function): void {} diff --git a/src/@awesome-cordova-plugins/plugins/dialogs/index.ts b/src/@awesome-cordova-plugins/plugins/dialogs/index.ts index 469234ca..fe1dc870 100644 --- a/src/@awesome-cordova-plugins/plugins/dialogs/index.ts +++ b/src/@awesome-cordova-plugins/plugins/dialogs/index.ts @@ -20,7 +20,6 @@ export interface DialogsPromptCallback { * This plugin gives you ability to access and customize the device native dialogs. * * Requires Cordova plugin: `cordova-plugin-dialogs`. For more info, please see the [Dialogs plugin docs](https://github.com/apache/cordova-plugin-dialogs). - * * @usage * ```typescript * import { Dialogs } from '@awesome-cordova-plugins/dialogs/ngx'; @@ -49,6 +48,7 @@ export interface DialogsPromptCallback { export class Dialogs extends AwesomeCordovaNativePlugin { /** * Shows a custom alert or dialog box. + * * @param {string} message Dialog message. * @param {string} [title] Dialog title. (Optional, defaults to Alert) * @param {string} [buttonName] Button name. (Optional, defaults to OK) @@ -64,6 +64,7 @@ export class Dialogs extends AwesomeCordovaNativePlugin { /** * Displays a customizable confirmation dialog box. + * * @param {string} message Dialog message. * @param {string} [title] Dialog title. (Optional, defaults to Confirm) * @param {string[]} [buttonLabels] Array of strings specifying button labels. (Optional, defaults to [OK,Cancel]) @@ -79,6 +80,7 @@ export class Dialogs extends AwesomeCordovaNativePlugin { /** * Displays a native dialog box that is more customizable than the browser's prompt function. + * * @param {string} [message] Dialog message. * @param {string} [title] Dialog title. (Optional, defaults to Prompt) * @param {string[]} [buttonLabels] Array of strings specifying button labels. (Optional, defaults to ["OK","Cancel"]) @@ -100,6 +102,7 @@ export class Dialogs extends AwesomeCordovaNativePlugin { /** * The device plays a beep sound. + * * @param {numbers} times The number of times to repeat the beep. */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/dns/index.ts b/src/@awesome-cordova-plugins/plugins/dns/index.ts index d0a5c3d3..30e3c54e 100644 --- a/src/@awesome-cordova-plugins/plugins/dns/index.ts +++ b/src/@awesome-cordova-plugins/plugins/dns/index.ts @@ -4,7 +4,6 @@ import { Injectable } from '@angular/core'; /** * @name DNS * @description A plugin for Apache Cordova that enables applications to manually resolve hostnames into an underlying network address. This is mostly useful for determining whether there is a problem with the device's DNS server configuration. - * * @usage * ```typescript * import { DNS } from '@awesome-cordova-plugins/dns/ngx'; @@ -32,6 +31,7 @@ import { Injectable } from '@angular/core'; export class DNS extends AwesomeCordovaNativePlugin { /** * Resolve hostnames into an underlying network address. + * * @param hostname * @returns {Promise} Returns a promise that resolves with the resolution. */ diff --git a/src/@awesome-cordova-plugins/plugins/document-picker/index.ts b/src/@awesome-cordova-plugins/plugins/document-picker/index.ts index 5a447d44..557998f3 100644 --- a/src/@awesome-cordova-plugins/plugins/document-picker/index.ts +++ b/src/@awesome-cordova-plugins/plugins/document-picker/index.ts @@ -7,7 +7,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * * Opens the file picker on iOS for the user to select a file, returns a file URI. * Allows the user to upload files from iCloud - * * @usage * ```typescript * import { DocumentPicker } from '@awesome-cordova-plugins/document-picker/ngx'; @@ -33,6 +32,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class DocumentPicker extends AwesomeCordovaNativePlugin { /** * Open a file + * * @param {string} [option] files between 'image', 'pdf' or 'all' * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/document-scanner/index.ts b/src/@awesome-cordova-plugins/plugins/document-scanner/index.ts index 2d420137..f7fa0d56 100644 --- a/src/@awesome-cordova-plugins/plugins/document-scanner/index.ts +++ b/src/@awesome-cordova-plugins/plugins/document-scanner/index.ts @@ -48,7 +48,6 @@ export interface DocumentScannerOptions { * @name Document Scanner * @description * This plugin processes images of documents, compensating for perspective. - * * @usage * ```typescript * import { DocumentScanner, DocumentScannerOptions } from '@awesome-cordova-plugins/document-scanner'; @@ -64,7 +63,6 @@ export interface DocumentScannerOptions { * .catch((error: any) => console.error(error)); * * ``` - * * @interfaces * DocumentScannerOptions * @enums @@ -81,8 +79,9 @@ export interface DocumentScannerOptions { export class DocumentScanner extends AwesomeCordovaNativePlugin { /** * Scan a document + * * @param opts {DocumentScannerOptions} optional parameter for controlling scanning - * @return {Promise} file URL of scanned document image + * @returns {Promise} file URL of scanned document image */ @Cordova({ callbackOrder: 'reverse', diff --git a/src/@awesome-cordova-plugins/plugins/document-viewer/index.ts b/src/@awesome-cordova-plugins/plugins/document-viewer/index.ts index f28c3663..14acec1c 100644 --- a/src/@awesome-cordova-plugins/plugins/document-viewer/index.ts +++ b/src/@awesome-cordova-plugins/plugins/document-viewer/index.ts @@ -33,7 +33,6 @@ export interface DocumentViewerOptions { * @name Document Viewer * @description * This plugin offers a slim API to view PDF files which are either stored in the apps assets folder (/www/*) or in any other file system directory available via the cordova file plugin. - * * @usage * ```typescript * import { DocumentViewer } from '@awesome-cordova-plugins/document-viewer/ngx'; @@ -49,7 +48,6 @@ export interface DocumentViewerOptions { * this.document.viewDocument('assets/myFile.pdf', 'application/pdf', options) * * ``` - * * @interfaces * DocumentViewerOptions */ diff --git a/src/@awesome-cordova-plugins/plugins/email-composer/index.ts b/src/@awesome-cordova-plugins/plugins/email-composer/index.ts index 64164a21..4e748bb3 100644 --- a/src/@awesome-cordova-plugins/plugins/email-composer/index.ts +++ b/src/@awesome-cordova-plugins/plugins/email-composer/index.ts @@ -54,8 +54,6 @@ export interface EmailComposerOptions { * @description * * Requires Cordova plugin: cordova-plugin-email-composer. For more info, please see the [Email Composer plugin docs](https://github.com/hypery2k/cordova-email-plugin). - * - * * @usage * ```typescript * import { EmailComposer } from '@awesome-cordova-plugins/email-composer/ngx'; @@ -133,7 +131,8 @@ export interface EmailComposerOptions { export class EmailComposer extends AwesomeCordovaNativePlugin { /** * Checks if the app has a permission to access email accounts information - * @return {Promise} returns a promise that resolves with a boolean that indicates if the permission was granted + * + * @returns {Promise} returns a promise that resolves with a boolean that indicates if the permission was granted */ @Cordova({ successIndex: 0, @@ -145,7 +144,8 @@ export class EmailComposer extends AwesomeCordovaNativePlugin { /** * Request permission to access email accounts information - * @return {Promise} returns a promise that resolves with a boolean that indicates if the permission was granted + * + * @returns {Promise} returns a promise that resolves with a boolean that indicates if the permission was granted */ @Cordova({ successIndex: 0, diff --git a/src/@awesome-cordova-plugins/plugins/fabric/index.ts b/src/@awesome-cordova-plugins/plugins/fabric/index.ts index 2eefb85e..d5e1044e 100644 --- a/src/@awesome-cordova-plugins/plugins/fabric/index.ts +++ b/src/@awesome-cordova-plugins/plugins/fabric/index.ts @@ -2,7 +2,7 @@ import { Injectable } from '@angular/core'; import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-plugins/core'; export interface Attributes { - [index: string]: String; + [index: string]: string; } /** @@ -11,7 +11,6 @@ export interface Attributes { * API for interacting with the Crashlytics kit. * * https://docs.fabric.io/crashlytics/index.html - * * @usage * ```typescript * import { Crashlytics } from '@awesome-cordova-plugins/fabric/ngx'; @@ -45,6 +44,7 @@ export class Crashlytics extends AwesomeCordovaNativePlugin { /** * Add logging that will be sent with your crash data. This logging will not show up * in the system.log and will only be visible in your Crashlytics dashboard. + * * @param message {string} */ @Cordova({ sync: true }) @@ -62,6 +62,9 @@ export class Crashlytics extends AwesomeCordovaNativePlugin { /** * Used to log a non-fatal error message (Android only). + * + * @param message + * @param stacktrace */ @Cordova({ sync: true }) sendNonFatalCrash(message: string, stacktrace?: any): void { @@ -70,6 +73,9 @@ export class Crashlytics extends AwesomeCordovaNativePlugin { /** * Used to record a non-fatal error message (iOS only). + * + * @param message + * @param code */ @Cordova({ sync: true }) recordError(message: string, code: number): void { @@ -78,6 +84,8 @@ export class Crashlytics extends AwesomeCordovaNativePlugin { /** * Sets the user's identifier for logging to Crashlytics backend. + * + * @param userId */ @Cordova({ sync: true }) setUserIdentifier(userId: string): void { @@ -86,6 +94,8 @@ export class Crashlytics extends AwesomeCordovaNativePlugin { /** * Sets the user's name for logging to Crashlytics backend. + * + * @param userName */ @Cordova({ sync: true }) setUserName(userName: string): void { @@ -94,6 +104,8 @@ export class Crashlytics extends AwesomeCordovaNativePlugin { /** * Sets the user's email address for logging to Crashlytics backend. + * + * @param email */ @Cordova({ sync: true }) setUserEmail(email: string): void { @@ -102,6 +114,9 @@ export class Crashlytics extends AwesomeCordovaNativePlugin { /** * Sets a custom key/value pair for logging to Crashlytics backend. + * + * @param value + * @param key */ @Cordova({ sync: true }) setStringValueForKey(value: string, key: string): void { @@ -110,6 +125,9 @@ export class Crashlytics extends AwesomeCordovaNativePlugin { /** * Sets a custom key/value pair for logging to Crashlytics backend. + * + * @param value + * @param key */ @Cordova({ sync: true }) setIntValueForKey(value: number, key: string): void { @@ -118,6 +136,9 @@ export class Crashlytics extends AwesomeCordovaNativePlugin { /** * Sets a custom key/value pair for logging to Crashlytics backend. + * + * @param value + * @param key */ @Cordova({ sync: true }) setBoolValueForKey(value: boolean, key: string): void { @@ -126,6 +147,9 @@ export class Crashlytics extends AwesomeCordovaNativePlugin { /** * Sets a custom key/value pair for logging to Crashlytics backend. + * + * @param value + * @param key */ @Cordova({ sync: true }) setFloatValueForKey(value: number, key: string): void { @@ -139,7 +163,6 @@ export class Crashlytics extends AwesomeCordovaNativePlugin { * API for interacting with the Answers kit. * * https://docs.fabric.io/crashlytics/index.html - * * @usage * ```typescript * import { Answers } from '@awesome-cordova-plugins/fabric/ngx'; @@ -380,6 +403,11 @@ export class Answers extends AwesomeCordovaNativePlugin { * Send the Content View tracking event. * * https://docs.fabric.io/android/answers/answers-events.html#content-view + * + * @param name + * @param type + * @param id + * @param attributes */ @Cordova({ sync: true }) sendContentView(name: string, type?: string, id?: string, attributes?: Attributes): void { @@ -388,6 +416,10 @@ export class Answers extends AwesomeCordovaNativePlugin { /** * Shortcut for sendContentView(...) using type of "Screen". + * + * @param name + * @param id + * @param attributes */ @Cordova({ sync: true }) sendScreenView(name: string, id: string, attributes?: Attributes): void { @@ -398,6 +430,9 @@ export class Answers extends AwesomeCordovaNativePlugin { * Send a custom tracking event with the given name. * * https://docs.fabric.io/android/answers/answers-events.html#custom-event + * + * @param name + * @param attributes */ @Cordova({ sync: true }) sendCustomEvent(name: string, attributes?: Attributes): void { diff --git a/src/@awesome-cordova-plugins/plugins/facebook/index.ts b/src/@awesome-cordova-plugins/plugins/facebook/index.ts index 06d723d0..80918db5 100644 --- a/src/@awesome-cordova-plugins/plugins/facebook/index.ts +++ b/src/@awesome-cordova-plugins/plugins/facebook/index.ts @@ -82,7 +82,6 @@ export interface FacebookLoginResponse { * Events are listed on the [insights page](https://www.facebook.com/insights/). * * For tracking events, see `logEvent` and `logPurchase`. - * * @usage * ```typescript * import { Facebook, FacebookLoginResponse } from '@awesome-cordova-plugins/facebook/ngx'; @@ -99,7 +98,6 @@ export interface FacebookLoginResponse { * this.fb.logEvent(this.fb.EVENTS.EVENT_NAME_ADDED_TO_CART); * * ``` - * */ @Plugin({ pluginName: 'Facebook', @@ -270,6 +268,7 @@ export class Facebook extends AwesomeCordovaNativePlugin { * Logout of Facebook. * * For more info see the [Facebook docs](https://developers.facebook.com/docs/reference/javascript/FB.logout) + * * @returns {Promise} Returns a Promise that resolves on a successful logout, and rejects if logout fails. */ @Cordova() @@ -338,6 +337,7 @@ export class Facebook extends AwesomeCordovaNativePlugin { * ``` * * For more options see the [Cordova plugin docs](https://github.com/cordova-plugin-facebook-connect/cordova-plugin-facebook-connect#show-a-dialog) and the [Facebook docs](https://developers.facebook.com/docs/javascript/reference/FB.ui) + * * @param {Object} options The dialog options * @returns {Promise} Returns a Promise that resolves with success data, or rejects with an error */ @@ -459,6 +459,7 @@ export class Facebook extends AwesomeCordovaNativePlugin { /** * Returns the deferred app link + * * @returns {Promise} Returns a Promise that resolves with the deep link */ @Cordova() @@ -468,6 +469,7 @@ export class Facebook extends AwesomeCordovaNativePlugin { /** * Manually log activation events + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/fcm/index.ts b/src/@awesome-cordova-plugins/plugins/fcm/index.ts index 001abe01..50981762 100644 --- a/src/@awesome-cordova-plugins/plugins/fcm/index.ts +++ b/src/@awesome-cordova-plugins/plugins/fcm/index.ts @@ -75,7 +75,6 @@ export interface IChannelConfiguration { * @capacitorincompatible true * @description * Provides basic functionality for Firebase Cloud Messaging - * * @usage * ```typescript * import { FCM } from '@awesome-cordova-plugins/fcm/ngx'; @@ -163,7 +162,6 @@ export class FCM extends AwesomeCordovaNativePlugin { * Subscribes you to a [topic](https://firebase.google.com/docs/notifications/android/console-topics) * * @param {string} topic Topic to be subscribed to - * * @returns {Promise} Returns a promise resolving in result of subscribing to a topic */ @Cordova() @@ -175,7 +173,6 @@ export class FCM extends AwesomeCordovaNativePlugin { * Unsubscribes you from a [topic](https://firebase.google.com/docs/notifications/android/console-topics) * * @param {string} topic Topic to be unsubscribed from - * * @returns {Promise} Returns a promise resolving in result of unsubscribing from a topic */ @Cordova() @@ -224,7 +221,6 @@ export class FCM extends AwesomeCordovaNativePlugin { * Request push notification permission, alerting the user if it not have yet decided * * @param {IRequestPushPermissionIOSOptions} options Options for push request - * * @returns {Promise} Returns a Promise that resolves with the permission status */ @Cordova() @@ -240,7 +236,6 @@ export class FCM extends AwesomeCordovaNativePlugin { * Once a channel is created, it stays unchangeable until the user uninstalls the app. * * @param channelConfig - * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/file-opener/index.ts b/src/@awesome-cordova-plugins/plugins/file-opener/index.ts index 432d8b23..46a4f3fd 100644 --- a/src/@awesome-cordova-plugins/plugins/file-opener/index.ts +++ b/src/@awesome-cordova-plugins/plugins/file-opener/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name File Opener * @description * This plugin will open a file on your device file system with its default application. - * * @usage * ```typescript * import { FileOpener } from '@awesome-cordova-plugins/file-opener/ngx'; @@ -35,6 +34,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class FileOpener extends AwesomeCordovaNativePlugin { /** * Open an file + * * @param {string} filePath File Path * @param {string} fileMIMEType File MIME Type * @returns {Promise} @@ -50,6 +50,7 @@ export class FileOpener extends AwesomeCordovaNativePlugin { /** * Uninstalls a package + * * @param {string} packageId Package ID * @returns {Promise} */ @@ -64,6 +65,7 @@ export class FileOpener extends AwesomeCordovaNativePlugin { /** * Check if an app is already installed + * * @param {string} packageId Package ID * @returns {Promise} */ @@ -78,6 +80,7 @@ export class FileOpener extends AwesomeCordovaNativePlugin { /** * Opens with system modal to open file with an already installed app. + * * @param {string} filePath File Path * @param {string} fileMIMEType File MIME Type * @returns {Promise} diff --git a/src/@awesome-cordova-plugins/plugins/file-path/index.ts b/src/@awesome-cordova-plugins/plugins/file-path/index.ts index c40e8935..cd6fa096 100644 --- a/src/@awesome-cordova-plugins/plugins/file-path/index.ts +++ b/src/@awesome-cordova-plugins/plugins/file-path/index.ts @@ -9,7 +9,6 @@ declare const window: any; * @description * * This plugin allows you to resolve the native filesystem path for Android content URIs and is based on code in the aFileChooser library. - * * @usage * ```typescript * import { FilePath } from '@awesome-cordova-plugins/file-path/ngx'; @@ -35,6 +34,7 @@ declare const window: any; export class FilePath extends AwesomeCordovaNativePlugin { /** * Resolve native path for given content URL/path. + * * @param {string} path Content URL/path. * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/file-transfer/index.ts b/src/@awesome-cordova-plugins/plugins/file-transfer/index.ts index 364bb8ec..8b4488a8 100644 --- a/src/@awesome-cordova-plugins/plugins/file-transfer/index.ts +++ b/src/@awesome-cordova-plugins/plugins/file-transfer/index.ts @@ -108,10 +108,8 @@ export interface FileTransferError { /** * @name File Transfer - * * @description * This plugin allows you to upload and download files. - * * @usage * ```typescript * import { FileTransfer, FileUploadOptions, FileTransferObject } from '@awesome-cordova-plugins/file-transfer/ngx'; @@ -162,7 +160,6 @@ export interface FileTransferError { * * To store files in a different/publicly accessible directory, please refer to the following link * https://github.com/apache/cordova-plugin-file#where-to-store-files - * * @interfaces * FileUploadOptions * FileUploadResult @@ -187,6 +184,7 @@ export class FileTransfer extends AwesomeCordovaNativePlugin { * CONNECTION_ERR: 3, Return on connection error * ABORT_ERR: 4, Return on aborting * NOT_MODIFIED_ERR: 5 Return on '304 Not Modified' HTTP response + * * @enum {number} */ FileTransferErrorCode = { @@ -199,7 +197,8 @@ export class FileTransfer extends AwesomeCordovaNativePlugin { /** * Creates a new FileTransfer object - * @return {FileTransferObject} + * + * @returns {FileTransferObject} */ create(): FileTransferObject { return new FileTransferObject(); @@ -263,6 +262,7 @@ export class FileTransferObject { /** * Registers a listener that gets called whenever a new chunk of data is transferred. + * * @param {Function} listener Listener that takes a progress event. */ @InstanceCheck({ sync: true }) diff --git a/src/@awesome-cordova-plugins/plugins/file/index.ts b/src/@awesome-cordova-plugins/plugins/file/index.ts index b33cdd91..fcd08f0c 100644 --- a/src/@awesome-cordova-plugins/plugins/file/index.ts +++ b/src/@awesome-cordova-plugins/plugins/file/index.ts @@ -36,6 +36,7 @@ export interface IFile extends Blob { * Returns a "slice" of the file. Since Cordova Files don't contain the actual * content, this really returns a File with adjusted start and end. * Slices of slices are supported. + * * @param start {Number} The index at which to start the slice (inclusive). * @param end {Number} The index at which to end the slice (exclusive). */ @@ -55,6 +56,7 @@ export interface LocalFileSystem { /** * Requests a filesystem in which to store application data. + * * @param type Whether the filesystem requested should be persistent, as defined above. Use one of TEMPORARY or * PERSISTENT. * @param size This is an indicator of how much storage space, in bytes, the application expects to need. @@ -71,6 +73,7 @@ export interface LocalFileSystem { /** * Allows the user to look up the Entry for a file or directory referred to by a local URL. + * * @param url A URL referring to a local file in a filesystem accessable via this API. * @param successCallback A callback that is called to report the FileEntry to which the supplied URL refers. * @param errorCallback A callback that is called when errors happen, or when the request to obtain the Entry is @@ -92,12 +95,14 @@ export interface LocalFileSystem { export interface Metadata { /** * This is the time at which the file or directory was last modified. + * * @readonly */ modificationTime: Date; /** * The size of the file, in bytes. This must return 0 for directories. + * * @readonly */ size: number; @@ -123,12 +128,14 @@ export interface FileSystem { /** * This is the name of the file system. The specifics of naming filesystems is unspecified, but a name must be unique * across the list of exposed file systems. + * * @readonly */ name: string; /** * The root directory of the file system. + * * @readonly */ root: DirectoryEntry; @@ -151,6 +158,7 @@ export interface Entry { /** * Look up metadata about this entry. + * * @param successCallback A callback that is called with the time of the last modification. * @param errorCallback ErrorCallback A callback that is called when errors happen. */ @@ -158,6 +166,7 @@ export interface Entry { /** * Set the metadata of the entry. + * * @param successCallback {Function} is called with a Metadata object * @param errorCallback {Function} is called with a FileError * @param metadataObject {Metadata} keys and values to set @@ -181,21 +190,6 @@ export interface Entry { */ nativeURL: string; - /** - * Look up metadata about this entry. - * @param successCallback A callback that is called with the time of the last modification. - * @param errorCallback ErrorCallback A callback that is called when errors happen. - */ - getMetadata(successCallback: MetadataCallback, errorCallback?: ErrorCallback): void; - - /** - * Set the metadata of the entry. - * @param successCallback {Function} is called with a Metadata object - * @param errorCallback {Function} is called with a FileError - * @param metadataObject {Metadata} keys and values to set - */ - setMetadata(successCallback: MetadataCallback, errorCallback: ErrorCallback, metadataObject: Metadata): void; - /** * Move an entry to a different location on the file system. It is an error to try to: * @@ -248,13 +242,15 @@ export interface Entry { /** * Return a URL that can be passed across the bridge to identify this entry. - * @return string URL that can be passed across the bridge to identify this entry + * + * @returns string URL that can be passed across the bridge to identify this entry */ toInternalURL(): string; /** * Deletes a file or directory. It is an error to attempt to delete a directory that is not empty. It is an error to * attempt to delete the root directory of a filesystem. + * * @param successCallback A callback that is called on success. * @param errorCallback A callback that is called when errors happen. */ @@ -263,6 +259,7 @@ export interface Entry { /** * Look up the parent DirectoryEntry containing this Entry. If this Entry is the root of its filesystem, its parent * is itself. + * * @param successCallback A callback that is called to return the parent Entry. * @param errorCallback A callback that is called when errors happen. */ @@ -280,6 +277,7 @@ export interface DirectoryEntry extends Entry { /** * Creates or looks up a file. + * * @param path Either an absolute path or a relative path from this DirectoryEntry to the file to be looked up or * created. It is an error to attempt to create a file whose immediate parent does not yet exist. * @param options @@ -298,6 +296,7 @@ export interface DirectoryEntry extends Entry { /** * Creates or looks up a directory. + * * @param path Either an absolute path or a relative path from this DirectoryEntry to the directory to be looked up * or created. It is an error to attempt to create a directory whose immediate parent does not yet exist. * @param options @@ -311,7 +310,6 @@ export interface DirectoryEntry extends Entry { * * @param successCallback A callback that is called to return the DirectoryEntry selected or created. * @param errorCallback A callback that is called when errors happen. - * */ getDirectory( path: string, @@ -324,6 +322,7 @@ export interface DirectoryEntry extends Entry { * Deletes a directory and all of its contents, if any. In the event of an error [e.g. trying to delete a directory * that contains a file that cannot be removed], some of the contents of the directory may be deleted. It is an error * to attempt to delete the root directory of a filesystem. + * * @param successCallback A callback that is called on success. * @param errorCallback A callback that is called when errors happen. */ @@ -346,6 +345,7 @@ export interface DirectoryReader { /** * Read the next block of entries from this directory. + * * @param successCallback Called once per successful call to readEntries to deliver the next previously-unreported * set of Entries in the associated Directory. If all Entries have already been returned from previous invocations * of readEntries, successCallback must be called with a zero-length array as an argument. @@ -360,6 +360,7 @@ export interface DirectoryReader { export interface FileEntry extends Entry { /** * Creates a new FileWriter associated with the file that this FileEntry represents. + * * @param successCallback A callback that is called with the new FileWriter. * @param errorCallback A callback that is called when errors happen. */ @@ -367,6 +368,7 @@ export interface FileEntry extends Entry { /** * Returns a File that represents the current state of the file that this FileEntry represents. + * * @param successCallback A callback that is called with the File. * @param errorCallback A callback that is called when errors happen. */ @@ -456,17 +458,20 @@ export declare class FileSaver extends EventTarget { /** * The blob is being written. + * * @readonly */ INIT: number; /** * The object has been constructed, but there is no pending write. + * * @readonly */ WRITING: number; /** * The entire Blob has been written to the file, an error occurred during the write, or the write was aborted using * abort(). The FileSaver is no longer writing the blob. + * * @readonly */ DONE: number; @@ -478,11 +483,13 @@ export declare class FileSaver extends EventTarget { *
  • WRITING
  • *
  • DONE
  • *
      + * * @readonly */ readyState: number; /** * The last error that occurred on the FileSaver. + * * @readonly */ error: Error; @@ -510,30 +517,6 @@ export declare class FileSaver extends EventTarget { * Handler for write end events. */ onwriteend: (event: ProgressEvent) => void; - - /** - * When the FileSaver constructor is called, the user agent must return a new FileSaver object with readyState set to - * INIT. This constructor must be visible when the script's global object is either a Window object or an object - * implementing the WorkerUtils interface. - */ - constructor(data: Blob); - - /** - * When the abort method is called, user agents must run the steps below: - *
        - *
      1. If readyState == DONE or readyState == INIT, terminate this overall series of steps without doing anything - * else.
      2. - *
      3. Set readyState to DONE.
      4. - *
      5. If there are any tasks from the object's FileSaver task source in one of the task queues, then remove those - * tasks.
      6. - *
      7. Terminate the write algorithm being processed.
      8. - *
      9. Set the error attribute to a DOMError object of type "AbortError".
      10. - *
      11. Fire a progress event called abort
      12. - *
      13. Fire a progress event called writeend
      14. - *
      15. Terminate this algorithm.
      16. - *
      - */ - abort(): void; } /** @@ -556,12 +539,14 @@ export declare class FileWriter extends FileSaver { /** * Write the supplied data to the file at position. + * * @param data The blob to write. */ write(data: ArrayBuffer | Blob | string): void; /** * Seek sets the file position at which the next write will occur. + * * @param offset If nonnegative, an absolute byte offset into the file. If negative, an offset back from the end of * the file. */ @@ -570,6 +555,7 @@ export declare class FileWriter extends FileSaver { /** * Changes the length of the file to that specified. If shortening the file, data beyond the new length must be * discarded. If extending the file, the existing data must be zero-padded up to the new length. + * * @param size The size to which the length of the file is to be adjusted, measured in bytes. */ truncate(size: number): void; @@ -636,7 +622,7 @@ export declare class FileReader { [key: string]: any; } -interface Window extends LocalFileSystem {} +type Window = LocalFileSystem; declare const window: Window; @@ -762,6 +748,7 @@ export class File extends AwesomeCordovaNativePlugin { /** * Get free disk space in Bytes + * * @returns {Promise} Returns a promise that resolves with the remaining free disk space in Bytes */ @CordovaCheck() @@ -1042,10 +1029,12 @@ export class File extends AwesomeCordovaNativePlugin { /** * Write a new file to the desired location. + * * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above * @param {string} fileName path relative to base path * @param {string | Blob | ArrayBuffer} text content, blob or ArrayBuffer to write * @param {IWriteOptions} whether to replace/append to an existing file. See IWriteOptions for more information. + * @param options * @returns {Promise} Returns a Promise that resolves to updated file entry or rejects with an error. */ @CordovaCheck() @@ -1077,6 +1066,7 @@ export class File extends AwesomeCordovaNativePlugin { /** * Write content to FileEntry. + * * @hidden * Write to an existing file. * @param {FileEntry} fe file entry object @@ -1102,6 +1092,7 @@ export class File extends AwesomeCordovaNativePlugin { /** * Write to an existing file. + * * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above * @param {string} fileName path relative to base path * @param {string | Blob} text content or blob to write @@ -1114,6 +1105,7 @@ export class File extends AwesomeCordovaNativePlugin { /** * Read the contents of a file as text. + * * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above * @param {string} file Name of file, relative to path. * @returns {Promise} Returns a Promise that resolves with the contents of the file as string or rejects with @@ -1141,6 +1133,7 @@ export class File extends AwesomeCordovaNativePlugin { /** * Read file and return data as a binary data. + * * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above * @param {string} file Name of file, relative to path. * @returns {Promise} Returns a Promise that resolves with the contents of the file as string rejects with an @@ -1153,6 +1146,7 @@ export class File extends AwesomeCordovaNativePlugin { /** * Read file and return data as an ArrayBuffer. + * * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystem above * @param {string} file Name of file, relative to path. * @returns {Promise} Returns a Promise that resolves with the contents of the file as ArrayBuffer or @@ -1224,6 +1218,7 @@ export class File extends AwesomeCordovaNativePlugin { } /** + * @param err * @hidden */ private fillErrorMessage(err: FileError): void { @@ -1234,6 +1229,7 @@ export class File extends AwesomeCordovaNativePlugin { /** * Resolves a local file system URL + * * @param fileUrl {string} file system url * @returns {Promise} */ @@ -1260,6 +1256,7 @@ export class File extends AwesomeCordovaNativePlugin { /** * Resolves a local directory url + * * @param directoryUrl {string} directory system url * @returns {Promise} */ @@ -1278,6 +1275,7 @@ export class File extends AwesomeCordovaNativePlugin { /** * Get a directory + * * @param directoryEntry {DirectoryEntry} Directory entry, obtained by resolveDirectoryUrl method * @param directoryName {string} Directory name * @param flags {Flags} Options @@ -1307,6 +1305,7 @@ export class File extends AwesomeCordovaNativePlugin { /** * Get a file + * * @param directoryEntry {DirectoryEntry} Directory entry, obtained by resolveDirectoryUrl method * @param fileName {string} File name * @param flags {Flags} Options @@ -1368,6 +1367,7 @@ export class File extends AwesomeCordovaNativePlugin { } /** + * @param fe * @hidden */ private remove(fe: Entry): Promise { @@ -1385,6 +1385,9 @@ export class File extends AwesomeCordovaNativePlugin { } /** + * @param srce + * @param destdir + * @param newName * @hidden */ private move(srce: Entry, destdir: DirectoryEntry, newName: string): Promise { @@ -1404,6 +1407,9 @@ export class File extends AwesomeCordovaNativePlugin { } /** + * @param srce + * @param destdir + * @param newName * @hidden */ private copy(srce: Entry, destdir: DirectoryEntry, newName: string): Promise { @@ -1423,6 +1429,7 @@ export class File extends AwesomeCordovaNativePlugin { } /** + * @param dr * @hidden */ private readEntries(dr: DirectoryReader): Promise { @@ -1440,6 +1447,7 @@ export class File extends AwesomeCordovaNativePlugin { } /** + * @param de * @hidden */ private rimraf(de: DirectoryEntry): Promise { @@ -1457,6 +1465,7 @@ export class File extends AwesomeCordovaNativePlugin { } /** + * @param fe * @hidden */ private createWriter(fe: FileEntry): Promise { @@ -1474,6 +1483,8 @@ export class File extends AwesomeCordovaNativePlugin { } /** + * @param writer + * @param gu * @hidden */ private write(writer: FileWriter, gu: string | Blob | ArrayBuffer): Promise { @@ -1494,12 +1505,17 @@ export class File extends AwesomeCordovaNativePlugin { } /** + * @param writer + * @param file * @hidden */ private writeFileInChunks(writer: FileWriter, file: Blob) { const BLOCK_SIZE = 1024 * 1024; let writtenSize = 0; + /** + * + */ function writeNextChunk() { const size = Math.min(BLOCK_SIZE, file.size - writtenSize); const chunk = file.slice(writtenSize, writtenSize + size); diff --git a/src/@awesome-cordova-plugins/plugins/fingerprint-aio/index.ts b/src/@awesome-cordova-plugins/plugins/fingerprint-aio/index.ts index 18b0b5fd..8e5baefc 100644 --- a/src/@awesome-cordova-plugins/plugins/fingerprint-aio/index.ts +++ b/src/@awesome-cordova-plugins/plugins/fingerprint-aio/index.ts @@ -4,36 +4,42 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export interface FingerprintOptions { /** * Title in biometric prompt (android only) + * * @default {APP_NAME} Biometric Sign On */ title?: string; /** * Subtitle in biometric Prompt (android only) + * * @default null */ subtitle?: string; /** * Description in biometric Prompt + * * @default null */ description?: string; /** * Title of fallback button. + * * @default "Use Pin" */ fallbackButtonTitle?: string; /** * Title for cancel button on Android + * * @default "Cancel" */ cancelButtonTitle?: string; /** * Disable 'use backup' option. + * * @default false */ disableBackup?: boolean; @@ -47,6 +53,7 @@ export interface FingerprintSecretOptions extends FingerprintOptions { /** * If `true` secret will be deleted when biometry items are deleted or enrolled + * * @default false */ invalidateOnEnrollment?: boolean; @@ -57,7 +64,6 @@ export interface FingerprintSecretOptions extends FingerprintOptions { * @description * Use simple fingerprint authentication on Android and iOS. * Requires Cordova plugin: cordova-plugin-fingerprint-aio. For more info about plugin, vist: https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio - * * @usage * ```typescript * import { FingerprintAIO } from '@awesome-cordova-plugins/fingerprint-aio/ngx'; @@ -117,78 +123,93 @@ export interface FingerprintSecretOptions extends FingerprintOptions { export class FingerprintAIO extends AwesomeCordovaNativePlugin { /** * Convenience constant + * * @type {number} */ BIOMETRIC_UNKNOWN_ERROR = -100; /** * Convenience constant + * * @type {number} */ BIOMETRIC_UNAVAILABLE = -101; /** * Convenience constant + * * @type {number} */ BIOMETRIC_AUTHENTICATION_FAILED = -102; /** * Convenience constant + * * @type {number} */ BIOMETRIC_SDK_NOT_SUPPORTED = -103; /** * Convenience constant + * * @type {number} */ BIOMETRIC_HARDWARE_NOT_SUPPORTED = -104; /** * Convenience constant + * * @type {number} */ BIOMETRIC_PERMISSION_NOT_GRANTED = -105; /** * Convenience constant + * * @type {number} */ BIOMETRIC_NOT_ENROLLED = -106; /** * Convenience constant + * * @type {number} */ BIOMETRIC_INTERNAL_PLUGIN_ERROR = -107; /** * Convenience constant + * * @type {number} */ BIOMETRIC_DISMISSED = -108; /** * Convenience constant + * * @type {number} */ BIOMETRIC_PIN_OR_PATTERN_DISMISSED = -109; /** * Convenience constant + * * @type {number} */ BIOMETRIC_SCREEN_GUARD_UNSECURED = -110; /** * Convenience constant + * * @type {number} */ BIOMETRIC_LOCKED_OUT = -111; /** * Convenience constant + * * @type {number} */ BIOMETRIC_LOCKED_OUT_PERMANENT = -112; /** * Convenience constant + * * @type {number} */ BIOMETRIC_SECRET_NOT_FOUND = -113; /** * Check if fingerprint authentication is available - * @return {Promise} Returns a promise with result + * + * @returns {Promise} Returns a promise with result */ @Cordova() isAvailable(): Promise { @@ -197,8 +218,9 @@ export class FingerprintAIO extends AwesomeCordovaNativePlugin { /** * Show authentication dialogue and register secret + * * @param {FingerprintSecretOptions} options Options for platform specific fingerprint API - * @return {Promise} Returns a promise that resolves when authentication was successful + * @returns {Promise} Returns a promise that resolves when authentication was successful */ @Cordova() registerBiometricSecret(options: FingerprintSecretOptions): Promise { @@ -207,8 +229,9 @@ export class FingerprintAIO extends AwesomeCordovaNativePlugin { /** * Show authentication dialogue and load secret + * * @param {FingerprintOptions} options Options for platform specific fingerprint API - * @return {Promise} Returns a promise that resolves when authentication was successful + * @returns {Promise} Returns a promise that resolves when authentication was successful */ @Cordova() loadBiometricSecret(options: FingerprintOptions): Promise { @@ -217,8 +240,9 @@ export class FingerprintAIO extends AwesomeCordovaNativePlugin { /** * Show authentication dialogue + * * @param {FingerprintOptions} options Options for platform specific fingerprint API - * @return {Promise} Returns a promise that resolves when authentication was successful + * @returns {Promise} Returns a promise that resolves when authentication was successful */ @Cordova() show(options: FingerprintOptions): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/firebase-analytics/index.ts b/src/@awesome-cordova-plugins/plugins/firebase-analytics/index.ts index 1fc65a25..c883a302 100644 --- a/src/@awesome-cordova-plugins/plugins/firebase-analytics/index.ts +++ b/src/@awesome-cordova-plugins/plugins/firebase-analytics/index.ts @@ -26,7 +26,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * ``` * * And in the same file, you'll have to add `xmlns:tools="http://schemas.android.com/tools"` to your _manifest_ tag. - * * @usage * ```typescript * import { FirebaseAnalytics } from '@awesome-cordova-plugins/firebase-analytics/ngx'; @@ -54,9 +53,10 @@ export class FirebaseAnalytics extends AwesomeCordovaNativePlugin { /** * Logs an app event. * Be aware of automatically collected events. + * * @param {string} name The name of the event * @param {any} params Some param to configure something - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova({ sync: true }) logEvent(name: string, params: any): Promise { @@ -66,8 +66,9 @@ export class FirebaseAnalytics extends AwesomeCordovaNativePlugin { /** * Sets the user ID property. * This feature must be used in accordance with Google's Privacy Policy. + * * @param {string} id The user ID - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova({ sync: true }) setUserId(id: string): Promise { @@ -77,9 +78,10 @@ export class FirebaseAnalytics extends AwesomeCordovaNativePlugin { /** * This feature must be used in accordance with Google's Privacy Policy. * Be aware of automatically collected user properties. + * * @param {string} name The property name * @param {string} value The property value - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova({ sync: true }) setUserProperty(name: string, value: string): Promise { @@ -88,8 +90,9 @@ export class FirebaseAnalytics extends AwesomeCordovaNativePlugin { /** * Sets whether analytics collection is enabled for this app on this device. + * * @param {boolean} enabled - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova({ sync: true }) setEnabled(enabled: boolean): Promise { @@ -99,8 +102,9 @@ export class FirebaseAnalytics extends AwesomeCordovaNativePlugin { /** * Sets the current screen name, which specifies the current visual context in your app. * This helps identify the areas in your app where users spend their time and how they interact with your app. + * * @param {string} name The name of the screen - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova({ sync: true }) setCurrentScreen(name: string): Promise { @@ -109,7 +113,8 @@ export class FirebaseAnalytics extends AwesomeCordovaNativePlugin { /** * Clears all analytics data for this instance from the device and resets the app instance ID - * @return {Promise} Returns a promise + * + * @returns {Promise} Returns a promise */ @Cordova({ sync: true }) resetAnalyticsData(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/firebase-authentication/index.ts b/src/@awesome-cordova-plugins/plugins/firebase-authentication/index.ts index dd308b41..8541a810 100644 --- a/src/@awesome-cordova-plugins/plugins/firebase-authentication/index.ts +++ b/src/@awesome-cordova-plugins/plugins/firebase-authentication/index.ts @@ -6,7 +6,6 @@ import { Observable } from 'rxjs'; * @name Firebase Authentication * @description * Cordova plugin for Firebase Authentication - * * @usage * ```typescript * import { FirebaseAuthentication } from '@awesome-cordova-plugins/firebase-authentication/ngx'; @@ -36,7 +35,8 @@ import { Observable } from 'rxjs'; export class FirebaseAuthentication extends AwesomeCordovaNativePlugin { /** * Returns the current user logged in Firebase service - * @return {Promise} Returns the user info + * + * @returns {Promise} Returns the user info */ @Cordova({ sync: true }) getCurrentUser(): Promise { @@ -45,8 +45,9 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin { /** * Returns a JWT token used to identify the user to a Firebase service. + * * @param forceRefresh {boolean} Force Refresh - * @return {Promise} Returns the id token + * @returns {Promise} Returns the id token */ @Cordova({ sync: true }) getIdToken(forceRefresh: boolean): Promise { @@ -55,6 +56,7 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin { /** * Tries to create a new user account with the given email address and password. + * * @param email Email * @param password Password */ @@ -74,6 +76,7 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin { /** * Triggers the Firebase Authentication backend to send a password-reset email to the given email address, * which must correspond to an existing user of your app. + * * @param email Email */ @Cordova({ sync: true }) @@ -83,6 +86,7 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin { /** * Asynchronously signs in using an email and password. + * * @param email Email * @param password Password */ @@ -99,6 +103,7 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin { * timeout [milliseconds] is the maximum amount of time you are willing to wait for SMS auto-retrieval * to be completed by the library. Maximum allowed value is 2 minutes. Use 0 to disable SMS-auto-retrieval. * If you specify a positive value less than 30 seconds, library will default to 30 seconds. + * * @param phoneNumber Phone number * @param timeout {number} Timeout */ @@ -109,6 +114,7 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin { /** * Asynchronously signs in using verificationId and 6-digit SMS code. + * * @param verificationId Verification ID * @param smsCode SMS code */ @@ -127,6 +133,7 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin { /** * Uses Google's idToken and accessToken to sign-in into firebase account. In order to retrieve those tokens follow instructions for Android and iOS + * * @param idToken ID Token * @param accessToken Access Token */ @@ -137,7 +144,9 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin { /** * Uses Apples's idToken and rawNonce (optional) to sign-in into firebase account. In order to retrieve those tokens follow instructions for Android and iOS + * * @param idToken ID Token + * @param identityToken * @param rawNonce Access Token */ @Cordova({ sync: true }) @@ -147,6 +156,7 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin { /** * Uses Facebook's accessToken to sign-in into firebase account. In order to retrieve those tokens follow instructions for Android and iOS. + * * @param accessToken Access Token */ @Cordova({ sync: true }) @@ -156,6 +166,7 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin { /** * Uses Twitter's token and secret to sign-in into firebase account. In order to retrieve those tokens follow instructions for Android and iOS. + * * @param token Token * @param secret Secret */ @@ -177,6 +188,7 @@ export class FirebaseAuthentication extends AwesomeCordovaNativePlugin { /** * Set's the current user language code. The string used to set this property must be a language code that follows BCP 47. + * * @param languageCode Language Code */ @Cordova({ sync: true }) diff --git a/src/@awesome-cordova-plugins/plugins/firebase-config/index.ts b/src/@awesome-cordova-plugins/plugins/firebase-config/index.ts index 3c769a65..16b28265 100644 --- a/src/@awesome-cordova-plugins/plugins/firebase-config/index.ts +++ b/src/@awesome-cordova-plugins/plugins/firebase-config/index.ts @@ -6,7 +6,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Firebase Config * @description * Cordova plugin for Firebase Config - * * @usage * ```typescript * import { FirebaseConfig } from '@awesome-cordova-plugins/firebase-config/ngx'; diff --git a/src/@awesome-cordova-plugins/plugins/firebase-crash/index.ts b/src/@awesome-cordova-plugins/plugins/firebase-crash/index.ts index 5c62f612..1bb3b4cb 100644 --- a/src/@awesome-cordova-plugins/plugins/firebase-crash/index.ts +++ b/src/@awesome-cordova-plugins/plugins/firebase-crash/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name FirebaseCrash * @description * This plugin brings crash reporting from Google Firebase to your Cordova project! Android and iOS supported. - * * @usage * ```typescript * import { FirebaseCrash } from '@awesome-cordova-plugins/firebase-crash'; @@ -32,8 +31,9 @@ export class FirebaseCrash extends AwesomeCordovaNativePlugin { /** * Add logging that will be sent with your crash data in case of app crash. * https://firebase.google.com/docs/crashlytics/customize-crash-reports?authuser=0#add_custom_logs + * * @param {string} message - * @return {Promise} + * @returns {Promise} */ @Cordova({ sync: true }) log(message: string): Promise { @@ -43,8 +43,9 @@ export class FirebaseCrash extends AwesomeCordovaNativePlugin { /** * Log non-fatal exceptions in addition to automatically reported app crashes. * https://firebase.google.com/docs/crashlytics/customize-crash-reports?authuser=0#log_non-fatal_exceptions + * * @param {string} message - * @return {Promise} + * @returns {Promise} */ @Cordova({ sync: true }) logError(message: string): Promise { @@ -54,6 +55,7 @@ export class FirebaseCrash extends AwesomeCordovaNativePlugin { /** * Sets the user identifier property for crashlytics reporting. * https://firebase.google.com/docs/crashlytics/customize-crash-reports?authuser=0#set_user_ids + * * @param {string} userId value to set the userId * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/firebase-crashlytics/index.ts b/src/@awesome-cordova-plugins/plugins/firebase-crashlytics/index.ts index c67a5c94..990d664a 100644 --- a/src/@awesome-cordova-plugins/plugins/firebase-crashlytics/index.ts +++ b/src/@awesome-cordova-plugins/plugins/firebase-crashlytics/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Firebase Crashlytics * @description * A Google Firebase Crashlytics plugin to enable capture of crash reports. - * * @usage * ```typescript * import { FirebaseCrashlytics } from '@awesome-cordova-plugins/firebase-crashlytics/ngx'; diff --git a/src/@awesome-cordova-plugins/plugins/firebase-dynamic-links/index.ts b/src/@awesome-cordova-plugins/plugins/firebase-dynamic-links/index.ts index dc3f94d4..b341e929 100644 --- a/src/@awesome-cordova-plugins/plugins/firebase-dynamic-links/index.ts +++ b/src/@awesome-cordova-plugins/plugins/firebase-dynamic-links/index.ts @@ -81,7 +81,6 @@ export interface ILinkOptions { * this.firebaseDynamicLinks.onDynamicLink() * .subscribe((res: any) => console.log(res), (error:any) => console.log(error)); * ``` - * * @interfaces * DynamicLinksOptions */ @@ -99,7 +98,8 @@ export interface ILinkOptions { export class FirebaseDynamicLinks extends AwesomeCordovaNativePlugin { /** * Determines if the app has a pending dynamic link and provides access to the dynamic link parameters. - * @return {Promise} Returns a promise + * + * @returns {Promise} Returns a promise */ @Cordova({ otherPromise: true, @@ -110,7 +110,8 @@ export class FirebaseDynamicLinks extends AwesomeCordovaNativePlugin { /** * Registers callback that is triggered on each dynamic link click. - * @return {Observable} Returns an observable + * + * @returns {Observable} Returns an observable */ @Cordova({ callbackOrder: 'reverse', @@ -122,8 +123,10 @@ export class FirebaseDynamicLinks extends AwesomeCordovaNativePlugin { /** * Creates a Dynamic Link from the parameters. Returns a promise fulfilled with the new dynamic link url. + * * @param {ILinkOptions} opt [Dynamic Link Parameters](https://github.com/chemerisuk/cordova-plugin-firebase-dynamiclinks#dynamic-link-parameters) - * @return {Promise} Returns a promise with the url + * @param opts + * @returns {Promise} Returns a promise with the url */ @Cordova({ otherPromise: true, @@ -134,8 +137,10 @@ export class FirebaseDynamicLinks extends AwesomeCordovaNativePlugin { /** * Creates a shortened Dynamic Link from the parameters. Shorten the path to a string that is only as long as needed to be unique, with a minimum length of 4 characters. Use this method if sensitive information would not be exposed if a short Dynamic Link URL were guessed. + * * @param {ILinkOptions} opt [Dynamic Link Parameters](https://github.com/chemerisuk/cordova-plugin-firebase-dynamiclinks#dynamic-link-parameters) - * @return {Promise} Returns a promise with the url + * @param opts + * @returns {Promise} Returns a promise with the url */ @Cordova({ otherPromise: true, @@ -146,8 +151,10 @@ export class FirebaseDynamicLinks extends AwesomeCordovaNativePlugin { /** * Creates a Dynamic Link from the parameters. Shorten the path to an unguessable string. Such strings are created by base62-encoding randomly generated 96-bit numbers, and consist of 17 alphanumeric characters. Use unguessable strings to prevent your Dynamic Links from being crawled, which can potentially expose sensitive information. + * * @param {ILinkOptions} opt [Dynamic Link Parameters](https://github.com/chemerisuk/cordova-plugin-firebase-dynamiclinks#dynamic-link-parameters) - * @return {Promise} Returns a promise with the url + * @param opts + * @returns {Promise} Returns a promise with the url */ @Cordova({ otherPromise: true, diff --git a/src/@awesome-cordova-plugins/plugins/firebase-messaging/index.ts b/src/@awesome-cordova-plugins/plugins/firebase-messaging/index.ts index 1c1b1dd7..595ffb3a 100644 --- a/src/@awesome-cordova-plugins/plugins/firebase-messaging/index.ts +++ b/src/@awesome-cordova-plugins/plugins/firebase-messaging/index.ts @@ -42,7 +42,6 @@ export type FirebaseMessagingTokenType = 'apns-buffer' | 'apns-string'; * @name Firebase Messaging * @description * Cordova plugin for Firebase Messaging - * * @usage * ```typescript * import { FirebaseMessaging } from '@awesome-cordova-plugins/firebase-messaging/ngx'; @@ -94,6 +93,7 @@ export class FirebaseMessaging extends AwesomeCordovaNativePlugin { * Grant permission to receive push notifications (will trigger prompt on iOS). * * @param {IRequestPermissionOptions} [options] + * @param options.forceShow * @returns {Promise} */ @Cordova({ sync: true }) diff --git a/src/@awesome-cordova-plugins/plugins/firebase-vision/index.ts b/src/@awesome-cordova-plugins/plugins/firebase-vision/index.ts index 8a10f5e1..21382b42 100644 --- a/src/@awesome-cordova-plugins/plugins/firebase-vision/index.ts +++ b/src/@awesome-cordova-plugins/plugins/firebase-vision/index.ts @@ -225,7 +225,6 @@ export interface ImageLabel { * @name Firebase Vision * @description * Cordova plugin for Firebase MLKit Vision - * * @usage * ```typescript * import { FirebaseVision } from '@awesome-cordova-plugins/firebase-vision/ngx'; @@ -261,8 +260,9 @@ export interface ImageLabel { export class FirebaseVision extends AwesomeCordovaNativePlugin { /** * Recognize text in image + * * @param file_uri {string} Image URI - * @return {Promise} Returns a promise that fulfills with the text in the image + * @returns {Promise} Returns a promise that fulfills with the text in the image */ @Cordova() onDeviceTextRecognizer(file_uri: string): Promise { @@ -270,8 +270,9 @@ export class FirebaseVision extends AwesomeCordovaNativePlugin { } /** * Read data from Barcode + * * @param file_uri {string} Image URI - * @return {Promise} Returns a promise that fulfills with the data in barcode + * @returns {Promise} Returns a promise that fulfills with the data in barcode */ @Cordova() barcodeDetector(file_uri: string): Promise { @@ -279,8 +280,9 @@ export class FirebaseVision extends AwesomeCordovaNativePlugin { } /** * Recognize object in image + * * @param file_uri {string} Image URI - * @return {Promise} Returns a promise that fulfills with the information about entities in an image + * @returns {Promise} Returns a promise that fulfills with the information about entities in an image */ @Cordova() imageLabeler(file_uri: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/firebase-x/index.ts b/src/@awesome-cordova-plugins/plugins/firebase-x/index.ts index 3a6dab9d..1e9f8ec7 100644 --- a/src/@awesome-cordova-plugins/plugins/firebase-x/index.ts +++ b/src/@awesome-cordova-plugins/plugins/firebase-x/index.ts @@ -118,7 +118,6 @@ export interface FirebaseUser { * @description * This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported. * It is a maintained fork from unmaintained ionic-navite plugin called Firebase. - * * @usage * ```typescript * import { FirebaseX } from '@awesome-cordova-plugins/firebase-x/ngx'; @@ -141,7 +140,6 @@ export interface FirebaseUser { * ``` * @interfaces * IChannelOptions - * */ @Plugin({ pluginName: 'FirebaseX', @@ -154,7 +152,8 @@ export interface FirebaseUser { export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Get the current FCM token. - * @return {Promise} Note that token will be null if it has not been established yet + * + * @returns {Promise} Note that token will be null if it has not been established yet */ @Cordova() getToken(): Promise { @@ -163,7 +162,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Get the app instance ID (an constant ID which persists as long as the app is not uninstalled/reinstalled) - * @return {Promise} Note that ID will be null if it has not been established yet + * + * @returns {Promise} Note that ID will be null if it has not been established yet */ @Cordova() getId(): Promise { @@ -172,7 +172,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Get the current FCM user. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getCurrentUser(): Promise { @@ -181,7 +182,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Reload the current FCM user. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() reloadCurrentUser(): Promise { @@ -190,7 +192,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Get notified when a token is refreshed. - * @return {Observable} + * + * @returns {Observable} */ @Cordova({ observable: true, @@ -202,7 +205,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * iOS only. * Get the APNS token allocated for this app install. - * @return {Promise} Note that token will be null if it has not been established yet + * + * @returns {Promise} Note that token will be null if it has not been established yet */ @Cordova() getAPNSToken(): Promise { @@ -213,7 +217,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { * iOS only. * Registers a handler to call when the APNS token is allocated. * This will be called once when remote notifications permission has been granted by the user at runtime. - * @return {Observable} + * + * @returns {Observable} */ @Cordova({ observable: true, @@ -226,7 +231,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { * Registers a callback function to invoke when: * - a notification or data message is received by the app * - a system notification is tapped by the user - * @return {Observable} + * + * @returns {Observable} */ @Cordova({ observable: true, @@ -237,7 +243,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Grant permission to receive push notifications (will trigger prompt) and return hasPermission: true. iOS only (Android will always return true). - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ platforms: ['iOS'], @@ -248,7 +255,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Check permission to receive push notifications and return hasPermission: true. iOS only (Android will always return true). - * @return {Promise} + * + * @returns {Promise} */ @Cordova() hasPermission(): Promise { @@ -265,8 +273,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Set a number on the icon badge. Set 0 to clear the badge + * * @param {number} badgeNumber - * @return {Promise} + * @returns {Promise} */ @Cordova() setBadgeNumber(badgeNumber: number): Promise { @@ -275,7 +284,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Get icon badge number. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getBadgeNumber(): Promise { @@ -284,7 +294,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Clear all pending notifications from the drawer. - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ platforms: ['Android'], @@ -295,8 +306,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Subscribe to a topic. Topic messaging allows you to send a message to multiple devices that have opted in to a particular topic. + * * @param {string} topic - * @return {Promise} + * @returns {Promise} */ @Cordova() subscribe(topic: string): Promise { @@ -305,8 +317,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Unsubscribe from a topic. This will stop you receiving messages for that topic. + * * @param {string} topic - * @return {Promise} + * @returns {Promise} */ @Cordova() unsubscribe(topic: string): Promise { @@ -324,6 +337,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Sets whether to autoinit new FCM tokens. By default, a new token will be generated as soon as the old one is removed. * To prevent a new token being generated, by sure to disable autoinit using setAutoInitEnabled() before calling unregister(). + * + * @param enabled */ @Cordova() setAutoInitEnabled(enabled: boolean): Promise { @@ -336,8 +351,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { * - for foreground/data notifications: data.notification_android_channel_id * * Calling on Android 7 or below or another platform will have no effect. + * * @param {IChannelOptions} channelOptions - * @return {Promise} + * @returns {Promise} */ @Cordova() createChannel(channelOptions: IChannelOptions): Promise { @@ -349,8 +365,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { * The default channel is used if no other channel exists or is specified in the notification. * Any options not specified will not be overridden. Should be called as soon as possible (on app start) so default notifications will work as expected. * Calling on Android 7 or below or another platform will have no effect. + * * @param {IChannelOptions} channelOptions - * @return {Promise} + * @returns {Promise} */ @Cordova() setDefaultChannel(channelOptions: IChannelOptions): Promise { @@ -360,8 +377,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Android 8+ only. Removes a previously defined channel. * Calling on Android 7 or below or another platform will have no effect. + * * @param {string} channelID - * @return {Promise} + * @returns {Promise} */ @Cordova() deleteChannel(channelID: string): Promise { @@ -371,7 +389,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Android 8+ only. Gets a list of all channels. * Calling on Android 7 or below or another platform will have no effect. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() listChannels(): Promise { @@ -380,6 +399,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Enable/disable analytics collection (useful for GDPR/privacy settings). + * * @param {boolean} enabled * @returns {Promise} */ @@ -390,6 +410,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Enable/disable Crashlytics collection. + * * @param {boolean} enabled * @returns {Promise} */ @@ -400,6 +421,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Enable/disable performance collection. + * * @param {boolean} enabled * @returns {Promise} */ @@ -410,9 +432,10 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Log an event using Analytics + * * @param {string} type * @param {Object} data - * @return {Promise} + * @returns {Promise} */ @Cordova() logEvent(type: string, data: any): Promise { @@ -421,8 +444,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Set the name of the current screen in Analytics + * * @param {string} name Screen name - * @return {Promise} + * @returns {Promise} */ @Cordova() setScreenName(name: string): Promise { @@ -431,8 +455,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Set a user id for use in Analytics + * * @param {string} userId - * @return {Promise} + * @returns {Promise} */ @Cordova() setUserId(userId: string): Promise { @@ -441,9 +466,10 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Set a user property for use in Analytics + * * @param {string} name * @param {string} value - * @return {Promise} + * @returns {Promise} */ @Cordova() setUserProperty(name: string, value: string): Promise { @@ -457,6 +483,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { * To add user IDs to your reports, assign each user a unique identifier in the form of an ID number, token, or hashed value. * * More info https://firebase.google.com/docs/crashlytics/customize-crash-reports?authuser=0#set_user_ids + * * @param {string} userId * @returns {Promise} */ @@ -469,7 +496,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { * Simulates (causes) a fatal native crash which causes a crash event to be sent to Crashlytics (useful for testing). * See the Firebase documentation regarding crash testing. * Crashes will appear under Event type = "Crashes" in the Crashlytics console. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() sendCrash(): Promise { @@ -479,8 +507,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Sends a crash-related log message that will appear in the Logs section of the next native crash event. * Note: if you don't then crash, the message won't be sent! Also logs the message to the native device console. + * * @param {string} message - * @return {Promise} + * @returns {Promise} */ @Cordova() logMessage(message: string): Promise { @@ -492,9 +521,11 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { * The event will appear under Event type = "Non-fatals" in the Crashlytics console. * The error message will appear in the Logs section of the non-fatal error event. * Also logs the error message to the native device console. + * * @param {string} error * @param {object} (optional) a stack trace generated by stacktrace.js - * @return {Promise} + * @param stackTrace + * @returns {Promise} */ @Cordova() logError(error: string, stackTrace?: object): Promise { @@ -534,6 +565,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Switch current authentification system language, for example, the phone sms code. + * * @param lang - language to change, ex: 'fr' for french */ @Cordova() @@ -544,6 +576,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Signs the user into Firebase with credentials obtained using verifyPhoneNumber(). * See the Android- and iOS-specific Firebase documentation for more info. + * * @param {object} credential - a credential object returned by the success callback of an authentication method */ @Cordova() @@ -553,6 +586,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Creates a new email/password-based user account. If account creation is successful, user will be automatically signed in. + * * @param email * @param password */ @@ -563,6 +597,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Signs in to an email/password-based user account. + * * @param email * @param password */ @@ -573,6 +608,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Signs in user with custom token. + * * @param customToken */ @Cordova() @@ -590,6 +626,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Authenticates the user with a Google account to obtain a credential that can be used to sign the user in/link to an existing user account/reauthenticate the user. + * * @param clientId */ @Cordova() @@ -599,6 +636,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Authenticates the user with an Apple account using Sign In with Apple to obtain a credential that can be used to sign the user in/link to an existing user account/reauthenticate the user. + * * @param locale */ @Cordova({ @@ -611,9 +649,10 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Links the user account to an existing Firebase user account with credentials obtained using verifyPhoneNumber(). * See the Android- and iOS-specific Firebase documentation for more info. + * * @param {object} credential - a credential object returned by the success callback of an authentication method - * @param {function} success - callback function to call on successful sign-in using credentials - * @param {function} error - callback function which will be passed a {string} error message as an argument + * @param {Function} success - callback function to call on successful sign-in using credentials + * @param {Function} error - callback function which will be passed a {string} error message as an argument */ @Cordova() linkUserWithCredential(credential: object, success: () => void, error: (err: string) => void): Promise { @@ -622,9 +661,10 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Reauthenticates the currently signed in user with credentials obtained via an authentication method such as verifyPhoneNumber() or authenticateUserWithGoogle(). + * * @param {Object} credential - a credential object returned by the success callback of an authentication method - * @param {function} success - callback function to call on successful sign-in using credentials - * @param {function} error - callback function which will be passed a {string} error message as an argument + * @param {Function} success - callback function to call on successful sign-in using credentials + * @param {Function} error - callback function which will be passed a {string} error message as an argument */ @Cordova() reauthenticateWithCredential(credential: any, success: () => void, error: (err: string) => void): Promise { @@ -649,7 +689,10 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Updates the display name and/or photo URL of the current Firebase user signed into the app. + * * @param profile + * @param profile.name + * @param profile.photoUri */ @Cordova() updateUserProfile(profile: { name: string; photoUri: string }): Promise { @@ -658,6 +701,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Updates/sets the email address of the current Firebase user signed into the app. + * * @param email */ @Cordova() @@ -676,6 +720,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Updates/sets the account password for the current Firebase user signed into the app. + * * @param password */ @Cordova() @@ -686,6 +731,7 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Sends a password reset email to the specified user email address. * Note: doesn't require the Firebase user to be signed in to the app. + * * @param email */ @Cordova() @@ -703,7 +749,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Registers a Javascript function to invoke when Firebase Authentication state changes between user signed in/signed out. - * @param {function} fn - callback function to invoke when authentication state changes + * + * @param {Function} fn - callback function to invoke when authentication state changes */ @Cordova() registerAuthStateChangeListener(fn: any): Promise { @@ -712,8 +759,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Fetch Remote Config parameter values for your app. + * * @param {number} cacheExpirationSeconds specify the cacheExpirationSeconds - * @return {Promise} + * @returns {Promise} */ @Cordova() fetch(cacheExpirationSeconds?: number): Promise { @@ -722,7 +770,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Activate the Remote Config fetched config. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() activateFetched(): Promise { @@ -731,8 +780,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Retrieve a Remote Config value. + * * @param {string} key - * @return {Promise} + * @returns {Promise} */ @Cordova() getValue(key: string): Promise { @@ -741,8 +791,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Android only. Retrieve a Remote Config byte array. + * * @param {string} key - * @return {Promise} + * @returns {Promise} */ @Cordova() getByteArray(key: string): Promise { @@ -751,7 +802,8 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Android only. Get the current state of the FirebaseRemoteConfig singleton object. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getInfo(): Promise { @@ -760,8 +812,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Android only. Change the settings for the FirebaseRemoteConfig object's operations. + * * @param {Object} settings - * @return {Promise} + * @returns {Promise} */ @Cordova() setConfigSettings(settings: any): Promise { @@ -770,8 +823,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Android only. Set defaults in the Remote Config. + * * @param {Object} settings - * @return {Promise} + * @returns {Promise} */ @Cordova() setDefaults(settings: any): Promise { @@ -780,8 +834,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Start a trace. + * * @param {string} name - * @return {Promise} + * @returns {Promise} */ @Cordova() startTrace(name: string): Promise { @@ -792,8 +847,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { * To count the performance-related events that occur in your app (such as cache hits or retries), * add a line of code similar to the following whenever the event occurs, * using a string other than retry to name that event if you are counting a different type of event. + * * @param {string} name - * @return {Promise} + * @returns {Promise} */ @Cordova() incrementCounter(name: string): Promise { @@ -802,8 +858,9 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Stop the trace. + * * @param {string} name - * @return {Promise} + * @returns {Promise} */ @Cordova() stopTrace(name: string): Promise { @@ -812,10 +869,11 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Adds a new document to a Firestore collection, which will be allocated an auto-generated document ID. + * * @param {object} document - document object to add to collection * @param {string} collection - name of top-level collection to add document to. - * @param {function} success - callback function to call on successfully adding the document. Will be passed a {string} argument containing the auto-generated document ID that the document was stored against. - * @param {function} error - callback function which will be passed a {string} error message as an argument. + * @param {Function} success - callback function to call on successfully adding the document. Will be passed a {string} argument containing the auto-generated document ID that the document was stored against. + * @param {Function} error - callback function which will be passed a {string} error message as an argument. */ @Cordova() addDocumentToFirestoreCollection( @@ -829,11 +887,12 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Sets (adds/replaces) a document with the given ID in a Firestore collection. + * * @param {string} documentId - document ID to use when setting document in the collection. * @param {object} document - document object to set in collection. * @param {string} collection - name of top-level collection to set document in. - * @param {function} success - callback function to call on successfully setting the document. - * @param {function} error - callback function which will be passed a {string} error message as an argument. + * @param {Function} success - callback function to call on successfully setting the document. + * @param {Function} error - callback function which will be passed a {string} error message as an argument. */ @Cordova() setDocumentInFirestoreCollection( @@ -850,11 +909,12 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { * Updates an existing document with the given ID in a Firestore collection. This is a non-destructive update that will only * overwrite existing keys in the existing document or add new ones if they don't already exist. If the no document with the * specified ID exists in the collection, an error will be raised. + * * @param {string} documentId - document ID of the document to update. * @param {object} document - entire document or document fragment to update existing document with. * @param {string} collection - name of top-level collection to update document in. - * @param {function} success - callback function to call on successfully updating the document. - * @param {function} error - callback function which will be passed a {string} error message as an argument. + * @param {Function} success - callback function to call on successfully updating the document. + * @param {Function} error - callback function which will be passed a {string} error message as an argument. */ @Cordova() updateDocumentInFirestoreCollection( @@ -870,10 +930,11 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Deletes an existing document with the given ID in a Firestore collection. * - Note: If the no document with the specified ID exists in the collection, the Firebase SDK will still return a successful outcome. + * * @param {string} documentId - document ID of the document to delete. * @param {string} collection - name of top-level collection to delete document in. - * @param {function} success - callback function to call on successfully deleting the document. - * @param {function} error - callback function which will be passed a {string} error message as an argument. + * @param {Function} success - callback function to call on successfully deleting the document. + * @param {Function} error - callback function which will be passed a {string} error message as an argument. */ @Cordova() deleteDocumentFromFirestoreCollection( @@ -888,10 +949,11 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Fetches an existing document with the given ID from a Firestore collection. * -Note: If the no document with the specified ID exists in the collection, the error callback will be invoked. + * * @param {string} documentId - document ID of the document to fetch. * @param {string} collection - name of top-level collection to fetch document from. - * @param {function} success - callback function to call on successfully fetching the document. Will be passed an {object} contain the document contents. - * @param {function} error - callback function which will be passed a {string} error message as an argument. + * @param {Function} success - callback function to call on successfully fetching the document. Will be passed an {object} contain the document contents. + * @param {Function} error - callback function which will be passed a {string} error message as an argument. */ @Cordova() fetchDocumentInFirestoreCollection( @@ -905,10 +967,11 @@ export class FirebaseX extends AwesomeCordovaNativePlugin { /** * Fetches all the documents in the specific collection. + * * @param {string} collection - name of top-level collection to fetch. - * @param {function} success - callback function to call on successfully deleting the document. Will be passed an {object} containing all the documents in the collection, + * @param {Function} success - callback function to call on successfully deleting the document. Will be passed an {object} containing all the documents in the collection, * indexed by document ID. If a Firebase collection with that name does not exist or it contains no documents, the object will be empty. - * @param {function} error - callback function which will be passed a {string} error message as an argument. + * @param {Function} error - callback function which will be passed a {string} error message as an argument. */ @Cordova() fetchFirestoreCollection( diff --git a/src/@awesome-cordova-plugins/plugins/firebase/index.ts b/src/@awesome-cordova-plugins/plugins/firebase/index.ts index c5f39282..8c910756 100644 --- a/src/@awesome-cordova-plugins/plugins/firebase/index.ts +++ b/src/@awesome-cordova-plugins/plugins/firebase/index.ts @@ -7,7 +7,6 @@ import { Observable } from 'rxjs'; * @capacitorincompatible true * @description * This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported (including iOS 10). - * * @usage * ```typescript * import { Firebase } from '@awesome-cordova-plugins/firebase/ngx'; @@ -39,7 +38,8 @@ import { Observable } from 'rxjs'; export class Firebase extends AwesomeCordovaNativePlugin { /** * Get the device token - * @return {Promise} Note that token will be null if it has not been established yet + * + * @returns {Promise} Note that token will be null if it has not been established yet */ @Cordova() getToken(): Promise { @@ -48,7 +48,8 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Get notified when a token is refreshed - * @return {Observable} + * + * @returns {Observable} */ @Cordova({ observable: true, @@ -59,7 +60,8 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Get notified when the user opens a notification - * @return {Observable} + * + * @returns {Observable} */ @Cordova({ observable: true, @@ -70,7 +72,8 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Grant permission to receive push notifications - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ platforms: ['iOS'], @@ -81,7 +84,8 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Check permission to receive push notifications - * @return {Promise<{isEnabled: boolean}>} + * + * @returns {Promise<{isEnabled: boolean}>} */ @Cordova() hasPermission(): Promise<{ isEnabled: boolean }> { @@ -90,8 +94,9 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Set icon badge number. Set to 0 to clear the badge. + * * @param {number} badgeNumber - * @return {Promise} + * @returns {Promise} */ @Cordova() setBadgeNumber(badgeNumber: number): Promise { @@ -100,7 +105,8 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Get icon badge number - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getBadgeNumber(): Promise { @@ -109,8 +115,9 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Subscribe to a topic + * * @param {string} topic - * @return {Promise} + * @returns {Promise} */ @Cordova() subscribe(topic: string): Promise { @@ -119,8 +126,9 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Unsubscribe from a topic + * * @param {string} topic - * @return {Promise} + * @returns {Promise} */ @Cordova() unsubscribe(topic: string): Promise { @@ -138,9 +146,10 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Log an event using Analytics + * * @param {string} type * @param {Object} data - * @return {Promise} + * @returns {Promise} */ @Cordova() logEvent(type: string, data: any): Promise { @@ -149,8 +158,9 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Log an Error using FirebaseCrash + * * @param {string} message - * @return {Promise} + * @returns {Promise} */ @Cordova() logError(message: string): Promise { @@ -159,8 +169,9 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Set the name of the current screen in Analytics + * * @param {string} name Screen name - * @return {Promise} + * @returns {Promise} */ @Cordova() setScreenName(name: string): Promise { @@ -169,8 +180,9 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Set a user id for use in Analytics + * * @param {string} userId - * @return {Promise} + * @returns {Promise} */ @Cordova() setUserId(userId: string): Promise { @@ -179,9 +191,10 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Set a user property for use in Analytics + * * @param {string} name * @param {string} value - * @return {Promise} + * @returns {Promise} */ @Cordova() setUserProperty(name: string, value: string): Promise { @@ -190,8 +203,9 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Fetch Remote Config parameter values for your app + * * @param {number} [cacheExpirationSeconds] - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 1, @@ -203,7 +217,8 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Activate the Remote Config fetched config - * @return {Promise} + * + * @returns {Promise} */ @Cordova() activateFetched(): Promise { @@ -212,9 +227,10 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Retrieve a Remote Config value + * * @param {string} key * @param {string} [namespace] - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 2, @@ -226,9 +242,10 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Retrieve a Remote Config byte array + * * @param {string} key * @param {string} [namespace] - * @return {Promise} + * @returns {Promise} */ @Cordova({ platforms: ['Android'], @@ -239,7 +256,8 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Get the current state of the FirebaseRemoteConfig singleton object - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ platforms: ['Android'], @@ -250,8 +268,9 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Change the settings for the FirebaseRemoteConfig object's operations + * * @param {Object} settings - * @return {Promise} + * @returns {Promise} */ @Cordova({ platforms: ['Android'], @@ -262,9 +281,10 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Set defaults in the Remote Config + * * @param {Object} defaults * @param {string} [namespace] - * @return {Promise} + * @returns {Promise} */ @Cordova({ platforms: ['Android'], @@ -275,6 +295,7 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Start a trace. + * * @param {string} trace Trace name */ @Cordova() @@ -286,6 +307,7 @@ export class Firebase extends AwesomeCordovaNativePlugin { * To count the performance-related events that occur in your app (such as cache hits or retries), add a line of code * similar to the following whenever the event occurs, using a string other than retry to name that event if you are * counting a different type of event: + * * @param {string} trace Trace name * @param {string} counter Counter */ @@ -296,6 +318,7 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Stop the trace + * * @param {string} trace Trace name */ @Cordova() @@ -303,6 +326,7 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Allows the user to enable/disable analytics collection + * * @param {boolean} enabled value to set collection * @returns {Promise} */ @@ -314,6 +338,7 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Allows the user to set User Identifier for crashlytics reporting * https://firebase.google.com/docs/crashlytics/customize-crash-reports?authuser=0#set_user_ids + * * @param {string} userId value to set the userId * @returns {Promise} */ @@ -324,6 +349,7 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Sends an SMS to the user with the SMS verification code and returns the Verification ID required to sign in using phone authentication + * * @param {string} phoneNumber The phone number, including '+' and country code * @param {number} timeoutDuration (Android only) The timeout in sec - no more SMS will be sent to this number until this timeout expires * @returns {Promise} @@ -339,7 +365,8 @@ export class Firebase extends AwesomeCordovaNativePlugin { /** * Clear all pending notifications from the drawer - * @return {Promise} + * + * @returns {Promise} */ @Cordova({ platforms: ['Android'], diff --git a/src/@awesome-cordova-plugins/plugins/flashlight/index.ts b/src/@awesome-cordova-plugins/plugins/flashlight/index.ts index baef0714..3aa7f8f2 100644 --- a/src/@awesome-cordova-plugins/plugins/flashlight/index.ts +++ b/src/@awesome-cordova-plugins/plugins/flashlight/index.ts @@ -6,7 +6,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @description This plugin allows you to switch the flashlight / torch of the device on and off. * * Requires Cordova plugin: `cordova-plugin-flashlight`. For more info, please see the [Flashlight plugin docs](https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin). - * * @usage * ```typescript * import { Flashlight } from '@awesome-cordova-plugins/flashlight/ngx'; @@ -30,6 +29,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class Flashlight extends AwesomeCordovaNativePlugin { /** * Checks if the flashlight is available + * * @returns {Promise} Returns a promise that resolves with a boolean stating if the flashlight is available. */ @Cordova() @@ -39,6 +39,7 @@ export class Flashlight extends AwesomeCordovaNativePlugin { /** * Switches the flashlight on + * * @returns {Promise} */ @Cordova() @@ -48,6 +49,7 @@ export class Flashlight extends AwesomeCordovaNativePlugin { /** * Switches the flashlight off + * * @returns {Promise} */ @Cordova() @@ -57,6 +59,7 @@ export class Flashlight extends AwesomeCordovaNativePlugin { /** * Toggles the flashlight + * * @returns {Promise} */ @Cordova() @@ -66,6 +69,7 @@ export class Flashlight extends AwesomeCordovaNativePlugin { /** * Checks if the flashlight is turned on. + * * @returns {boolean} */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/foreground-service/index.ts b/src/@awesome-cordova-plugins/plugins/foreground-service/index.ts index 6f9e2a30..c9acc2ad 100644 --- a/src/@awesome-cordova-plugins/plugins/foreground-service/index.ts +++ b/src/@awesome-cordova-plugins/plugins/foreground-service/index.ts @@ -69,9 +69,7 @@ export class ForegroundService extends AwesomeCordovaNativePlugin { * 1|IMPORTANCE_LOW|Does not make a sound or heads-up display (plugin's default)|New content the user has subscribed to, social network invitations * 2|IMPORTANCE_DEFAULT|Makes a sound, but no heads-up display|Traffic alerts, task reminders * 3|IMPORTANCE_HIGH|Makes a sound and heads-up display|Text messages, alarms, phone calls - * * @param {number} id The notification id is a customizable integer that is used to reference the notification that will be launched. This is customizable to avoid conflicting with any other notifications. If this is not included, a [*unique*] default id will be used. - * * @see https://material.io/design/platform-guidance/android-notifications.html */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/ftp/index.ts b/src/@awesome-cordova-plugins/plugins/ftp/index.ts index 91c272f3..e1ff6180 100644 --- a/src/@awesome-cordova-plugins/plugins/ftp/index.ts +++ b/src/@awesome-cordova-plugins/plugins/ftp/index.ts @@ -6,7 +6,6 @@ import { Observable } from 'rxjs'; * @name FTP * @description * This cordova plugin is created to use ftp (client) in web/js. - * * @usage * ```typescript * import { FTP } from '@awesome-cordova-plugins/ftp/ngx'; @@ -36,10 +35,11 @@ export class FTP extends AwesomeCordovaNativePlugin { * Connect to one ftp server. * * Just need to init the connection once. If success, you can do any ftp actions later. + * * @param {string} hostname The ftp server url. Like ip without protocol prefix, e.g. "192.168.1.1". * @param {string} username The ftp login username. If it and `password` are all blank/undefined, the default username "anonymous" is used. * @param {string} password The ftp login password. If it and `username` are all blank/undefined, the default password "anonymous@" is used. - * @return {Promise} The success callback. Notice: For iOS, if triggered, means `init` success, but NOT means the later action, e.g. `ls`... `download` will success! + * @returns {Promise} The success callback. Notice: For iOS, if triggered, means `init` success, but NOT means the later action, e.g. `ls`... `download` will success! */ @Cordova() connect(hostname: string, username: string, password: string): Promise { @@ -58,7 +58,7 @@ export class FTP extends AwesomeCordovaNativePlugin { * - modifiedDate: modified date of this file. date format is `yyyy-MM-dd HH:mm:ss zzz`, e.g "2015-12-01 20:45:00 GMT+8". * * @param {string} path The path on the ftp server. e.g. "/adf/123/". - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() ls(path: string): Promise { @@ -69,7 +69,7 @@ export class FTP extends AwesomeCordovaNativePlugin { * Create one directory on the ftp server. * * @param {string} path The path on the ftp server. e.g. "/adf/123/". - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() mkdir(path: string): Promise { @@ -82,7 +82,7 @@ export class FTP extends AwesomeCordovaNativePlugin { * Tip: As many ftp server could not rm dir when it's not empty, so rm all files under the dir at first is recommended. * * @param {string} path The file (with full path) you want to delete. e.g. "/adf/123/newDir/myFile". - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() rmdir(path: string): Promise { @@ -93,7 +93,7 @@ export class FTP extends AwesomeCordovaNativePlugin { * Delete one file on the ftp server. * * @param {string} file The file (with full path) you want to delete. e.g. "/adf/123/newDir/myFile". - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() rm(file: string): Promise { @@ -105,7 +105,7 @@ export class FTP extends AwesomeCordovaNativePlugin { * * @param {string} localFile The file (with full path) you want to upload. e.g. "/local/path/to/localFile". * @param {string} remoteFile The file (with full path) you want to located on the ftp server. e.g. "/adf/123/newDir/remoteFile". - * @return {Observable} Returns an observable. + * @returns {Observable} Returns an observable. * It will be triggered many times according the file's size. * The arg `0`, `0.1xx`, `0.2xx` ... `1` means the upload percent. When it reach `1`, means success. */ @@ -121,7 +121,7 @@ export class FTP extends AwesomeCordovaNativePlugin { * * @param {string} localFile The file (with full path) you want to upload. e.g. "/local/path/to/localFile". * @param {string} remoteFile The file (with full path) you want to located on the ftp server. e.g. "/adf/123/newDir/remoteFile". - * @return {Observable} Returns an observable. + * @returns {Observable} Returns an observable. * It will be triggered many times according the file's size. * The arg `0`, `0.1xx`, `0.2xx` ... `1` means the upload percent. When it reach `1`, means success. */ @@ -135,7 +135,7 @@ export class FTP extends AwesomeCordovaNativePlugin { /** * Cancel all requests. Always success. * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() cancel(): Promise { @@ -145,7 +145,7 @@ export class FTP extends AwesomeCordovaNativePlugin { /** * Disconnect from ftp server. * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() disconnect(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/gao-de-location/index.ts b/src/@awesome-cordova-plugins/plugins/gao-de-location/index.ts index f60a6f2c..787605dd 100644 --- a/src/@awesome-cordova-plugins/plugins/gao-de-location/index.ts +++ b/src/@awesome-cordova-plugins/plugins/gao-de-location/index.ts @@ -7,7 +7,6 @@ import { Observable } from 'rxjs'; * @description * Because the original GPS positioning uses Google Browser positioning, and Google withdraws from China, resulting in GPS Android positioning can not be positioned. * Gaode location can directly return address informationGaode location can directly return address information - * * @usage * ```typescript * import { GaoDeLocation } from '@awesome-cordova-plugins/gao-de-location/ngx'; @@ -68,8 +67,9 @@ import { Observable } from 'rxjs'; export class GaoDeLocation extends AwesomeCordovaNativePlugin { /** * Single location + * * @param positionOptions - * @return Promise + * @returns Promise */ @Cordova({ callbackOrder: 'reverse', @@ -80,8 +80,9 @@ export class GaoDeLocation extends AwesomeCordovaNativePlugin { /** * Start serial location + * * @param positionOptions - * @return Promise + * @returns Promise */ @Cordova({ callbackOrder: 'reverse', @@ -93,7 +94,8 @@ export class GaoDeLocation extends AwesomeCordovaNativePlugin { /** * Stop Serial Location - * @return Promise + * + * @returns Promise */ @Cordova({ callbackOrder: 'reverse', diff --git a/src/@awesome-cordova-plugins/plugins/ge-tui-sdk-plugin/index.ts b/src/@awesome-cordova-plugins/plugins/ge-tui-sdk-plugin/index.ts index 58df3743..26388a7f 100644 --- a/src/@awesome-cordova-plugins/plugins/ge-tui-sdk-plugin/index.ts +++ b/src/@awesome-cordova-plugins/plugins/ge-tui-sdk-plugin/index.ts @@ -5,7 +5,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl * @name Ge Tui Sdk Plugin * @description * This plugin does something - * * @usage * ```typescript * import { GeTuiSdkPlugin } from '@awesome-cordova-plugins/ge-tui-sdk-plugin'; diff --git a/src/@awesome-cordova-plugins/plugins/geolocation/index.ts b/src/@awesome-cordova-plugins/plugins/geolocation/index.ts index 2bd85aa7..b6e304b2 100644 --- a/src/@awesome-cordova-plugins/plugins/geolocation/index.ts +++ b/src/@awesome-cordova-plugins/plugins/geolocation/index.ts @@ -99,6 +99,7 @@ export interface GeolocationOptions { * power consumption (with a GPS chip on a mobile device for example). On the * other hand, if false, the device can take the liberty to save resources by * responding more quickly and/or using less power. Default: false. + * * @type {boolean} */ enableHighAccuracy?: boolean; @@ -118,8 +119,6 @@ export interface GeolocationOptions { * We use your location for full functionality of certain app features. * * ``` - * - * * @usage * * ```typescript diff --git a/src/@awesome-cordova-plugins/plugins/globalization/index.ts b/src/@awesome-cordova-plugins/plugins/globalization/index.ts index abe95282..118d19e7 100644 --- a/src/@awesome-cordova-plugins/plugins/globalization/index.ts +++ b/src/@awesome-cordova-plugins/plugins/globalization/index.ts @@ -11,11 +11,9 @@ export interface GlobalizationOptions { * @premier globalization * @description * This plugin obtains information and performs operations specific to the user's locale, language, and timezone. - * * @deprecated * With the [ECMA Internationalization API](https://www.ecma-international.org/ecma-402/1.0/) now supported on iOS, Android and Windows devices, this plugin is not required any more. * Migrating from this plugin to the [ECMA Internationalization API](https://www.ecma-international.org/ecma-402/1.0/) is explained in this [Cordova blog post](https://cordova.apache.org/news/2017/11/20/migrate-from-cordova-globalization-plugin.html). - * * @usage * ```typescript * import { Globalization } from '@awesome-cordova-plugins/globalization/ngx'; @@ -46,6 +44,7 @@ export interface GlobalizationOptions { export class Globalization extends AwesomeCordovaNativePlugin { /** * Returns the BCP-47 compliant language identifier tag to the successCallback with a properties object as a parameter. That object should have a value property with a String value. + * * @returns {Promise<{value: string}>} */ @Cordova() @@ -55,6 +54,7 @@ export class Globalization extends AwesomeCordovaNativePlugin { /** * Returns the BCP 47 compliant locale identifier string to the successCallback with a properties object as a parameter. + * * @returns {Promise<{value: string}>} */ @Cordova() @@ -64,6 +64,7 @@ export class Globalization extends AwesomeCordovaNativePlugin { /** * Converts date to string + * * @param {Date} date Date you wish to convert * @param options Options for the converted date. Length, selector. * @returns {Promise<{value: string}>} Returns a promise when the date has been converted. @@ -78,6 +79,7 @@ export class Globalization extends AwesomeCordovaNativePlugin { /** * Parses a date formatted as a string, according to the client's user preferences and calendar using the time zone of the client, and returns the corresponding date object. + * * @param {string} dateString Date as a string to be converted * @param options Options for the converted date. Length, selector. * @returns {Promise<{ year: number, month: number, day: number, hour: number, minute: number, second: number, millisecond: number }>} Returns a promise when the date has been converted. @@ -103,6 +105,7 @@ export class Globalization extends AwesomeCordovaNativePlugin { /** * Returns a pattern string to format and parse dates according to the client's user preferences. + * * @param options Object with the format length and selector * @returns {Promise<{ pattern: string, timezone: string, utc_offset: number, dst_offset: number }>} Returns a promise. */ @@ -121,7 +124,10 @@ export class Globalization extends AwesomeCordovaNativePlugin { /** * Returns an array of the names of the months or days of the week, depending on the client's user preferences and calendar. + * * @param options Object with type (narrow or wide) and item (month or days). + * @param options.type + * @param options.item * @returns {Promise<{value: string[]}>} Returns a promise. */ @Cordova({ @@ -133,6 +139,7 @@ export class Globalization extends AwesomeCordovaNativePlugin { /** * Indicates whether daylight savings time is in effect for a given date using the client's time zone and calendar. + * * @param {data} date Date to process * @returns {Promise<{dst: string}>} reutrns a promise with the value */ @@ -143,6 +150,7 @@ export class Globalization extends AwesomeCordovaNativePlugin { /** * Returns the first day of the week according to the client's user preferences and calendar. + * * @returns {Promise<{value: string}>} returns a promise with the value */ @Cordova() @@ -152,8 +160,10 @@ export class Globalization extends AwesomeCordovaNativePlugin { /** * Returns a number formatted as a string according to the client's user preferences. + * * @param numberToConvert {Number} The number to convert * @param options {Object} Object with property `type` that can be set to: decimal, percent, or currency. + * @param options.type */ @Cordova({ successIndex: 1, @@ -167,6 +177,7 @@ export class Globalization extends AwesomeCordovaNativePlugin { * * @param {string} stringToConvert String you want to conver to a number * @param options The type of number you want to return. Can be decimal, percent, or currency. + * @param options.type * @returns {Promise<{ value: number | string }>} Returns a promise with the value. */ @Cordova({ @@ -179,7 +190,9 @@ export class Globalization extends AwesomeCordovaNativePlugin { /** * Returns a pattern string to format and parse numbers according to the client's user preferences. + * * @param options Can be decimal, percent, or currency. + * @param options.type * @returns {Promise<{ pattern: string, symbol: string, fraction: number, rounding: number, positive: string, negative: string, decimal: string, grouping: string }>} */ @Cordova({ @@ -200,6 +213,7 @@ export class Globalization extends AwesomeCordovaNativePlugin { /** * Returns a pattern string to format and parse currency values according to the client's user preferences and ISO 4217 currency code. + * * @param {string} currencyCode Currency Code.A * @returns {Promise<{ pattern: string, code: string, fraction: number, rounding: number, decimal: number, grouping: string }>} */ diff --git a/src/@awesome-cordova-plugins/plugins/google-analytics/index.ts b/src/@awesome-cordova-plugins/plugins/google-analytics/index.ts index abcf33e4..c1d499b5 100644 --- a/src/@awesome-cordova-plugins/plugins/google-analytics/index.ts +++ b/src/@awesome-cordova-plugins/plugins/google-analytics/index.ts @@ -41,6 +41,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * In your 'deviceready' handler, set up your Analytics tracker. * https://developers.google.com/analytics/devguides/collection/analyticsjs/ + * * @param {string} id Your Google Analytics Mobile App property * @param {number} interval Optional dispatch period in seconds. Defaults to 30. * @returns {Promise} @@ -55,6 +56,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Enabling Advertising Features in Google Analytics allows you to take advantage of Remarketing, Demographics & Interests reports, and more + * * @param allow {boolean} * @returns {Promise} */ @@ -66,6 +68,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Set a UserId * https://developers.google.com/analytics/devguides/collection/analyticsjs/user-id + * * @param {string} id User ID * @returns {Promise} */ @@ -76,6 +79,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Set a anonymize Ip address + * * @param anonymize {boolean} Set to true to anonymize the IP Address * @returns {Promise} */ @@ -86,6 +90,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Set the app version + * * @param appVersion {string} App version * @returns {Promise} */ @@ -96,6 +101,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Get a variable + * * @param key {string} Variable * @returns {Promise} */ @@ -106,6 +112,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Set a variable + * * @param key {string} Variable * @param value {string} Parameter * @returns {Promise} @@ -117,6 +124,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Set OptOut + * * @param optout {boolean} * @returns {Promise} */ @@ -127,6 +135,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Enable verbose logging + * * @returns {Promise} */ @Cordova() @@ -136,6 +145,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Track custom metric + * * @param key {number} * @param value {any} * @returns {Promise} @@ -168,6 +178,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Add a Custom Dimension * https://developers.google.com/analytics/devguides/platform/customdimsmets + * * @param key {number} * @param value {string} * @returns {Promise} @@ -180,6 +191,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Track an event * https://developers.google.com/analytics/devguides/collection/analyticsjs/events + * * @param category {string} * @param action {string} * @param label {string} @@ -197,6 +209,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Track an exception + * * @param description {string} * @param fatal {boolean} * @returns {Promise} @@ -208,6 +221,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Track User Timing (App Speed) + * * @param category {string} * @param intervalInMilliseconds {number} * @param variable {string} @@ -222,6 +236,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Add a Transaction (Ecommerce) * https://developers.google.com/analytics/devguides/collection/analyticsjs/ecommerce#addTrans + * * @param id {string} * @param affiliation {string} * @param revenue {number} @@ -245,6 +260,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Add a Transaction Item (Ecommerce) * https://developers.google.com/analytics/devguides/collection/analyticsjs/ecommerce#addItem + * * @param {string} id * @param {string} name * @param {string} sku @@ -269,6 +285,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Enable/disable automatic reporting of uncaught exceptions + * * @param shouldEnable {boolean} * @returns {Promise} */ @@ -279,6 +296,7 @@ export class GoogleAnalytics extends AwesomeCordovaNativePlugin { /** * Manually dispatch any data + * * @returns {Promise} * @platform */ diff --git a/src/@awesome-cordova-plugins/plugins/google-nearby/index.ts b/src/@awesome-cordova-plugins/plugins/google-nearby/index.ts index 5b99a4f6..9022a4f8 100644 --- a/src/@awesome-cordova-plugins/plugins/google-nearby/index.ts +++ b/src/@awesome-cordova-plugins/plugins/google-nearby/index.ts @@ -6,7 +6,6 @@ import { Observable } from 'rxjs'; * @name Google Nearby * @description * This plugin adds support for the Google Nearby Messages API. - * * @usage * ```typescript * import { GoogleNearby } from '@awesome-cordova-plugins/google-nearby/ngx'; @@ -36,8 +35,9 @@ import { Observable } from 'rxjs'; export class GoogleNearby extends AwesomeCordovaNativePlugin { /** * Publish a message + * * @param message {string} Message to publish - * @return {Promise} Returns a promise that resolves when the message got published + * @returns {Promise} Returns a promise that resolves when the message got published */ @Cordova() publish(message: string): Promise { @@ -46,7 +46,8 @@ export class GoogleNearby extends AwesomeCordovaNativePlugin { /** * Subscribe to receive messages - * @return {Observable} Returns an observable that emits received messages + * + * @returns {Observable} Returns an observable that emits received messages */ @Cordova({ observable: true, diff --git a/src/@awesome-cordova-plugins/plugins/google-plus/index.ts b/src/@awesome-cordova-plugins/plugins/google-plus/index.ts index 6ecfe718..9401d956 100644 --- a/src/@awesome-cordova-plugins/plugins/google-plus/index.ts +++ b/src/@awesome-cordova-plugins/plugins/google-plus/index.ts @@ -31,6 +31,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class GooglePlus extends AwesomeCordovaNativePlugin { /** * The login function walks the user through the Google Auth process. + * * @param options * @returns {Promise} */ @@ -44,6 +45,7 @@ export class GooglePlus extends AwesomeCordovaNativePlugin { /** * You can call trySilentLogin to check if they're already signed in to the app and sign them in silently if they are. + * * @param options * @returns {Promise} */ @@ -54,6 +56,7 @@ export class GooglePlus extends AwesomeCordovaNativePlugin { /** * This will clear the OAuth2 token. + * * @returns {Promise} */ @Cordova() @@ -63,6 +66,7 @@ export class GooglePlus extends AwesomeCordovaNativePlugin { /** * This will clear the OAuth2 token, forget which account was used to login, and disconnect that account from the app. This will require the user to allow the app access again next time they sign in. Be aware that this effect is not always instantaneous. It can take time to completely disconnect. + * * @returns {Promise} */ @Cordova() @@ -72,6 +76,7 @@ export class GooglePlus extends AwesomeCordovaNativePlugin { /** * This will retrieve the Android signing certificate fingerprint which is required in the Google Developer Console. + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/header-color/index.ts b/src/@awesome-cordova-plugins/plugins/header-color/index.ts index 1b1227e2..c37cd5d9 100644 --- a/src/@awesome-cordova-plugins/plugins/header-color/index.ts +++ b/src/@awesome-cordova-plugins/plugins/header-color/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Header Color * @description * Cordova plugin to change color of header in Android Multitask View - * * @usage * ```typescript * import { HeaderColor } from '@awesome-cordova-plugins/header-color/ngx'; @@ -28,6 +27,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class HeaderColor extends AwesomeCordovaNativePlugin { /** * Set a color to the task header + * * @param color {string} The hex value of the color * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/health-kit/index.ts b/src/@awesome-cordova-plugins/plugins/health-kit/index.ts index f196cb92..c4ec61f4 100644 --- a/src/@awesome-cordova-plugins/plugins/health-kit/index.ts +++ b/src/@awesome-cordova-plugins/plugins/health-kit/index.ts @@ -84,7 +84,6 @@ export interface HealthKitOptions { * @description * The HealthKit plugin allows you to read data from and write data to the iOS 8+ HealthKit framework. * Any data saved shows up in the iOS Health app and is available for other iOS apps. - * * @usage * ```typescript * import { HealthKit } from '@awesome-cordova-plugins/health-kit/ngx'; @@ -94,7 +93,6 @@ export interface HealthKitOptions { * * ... * ``` - * * @interfaces * HealthKitOptions */ @@ -109,6 +107,7 @@ export interface HealthKitOptions { export class HealthKit extends AwesomeCordovaNativePlugin { /** * Check if HealthKit is supported (iOS8+, not on iPad) + * * @returns {Promise} */ @Cordova() @@ -118,6 +117,7 @@ export class HealthKit extends AwesomeCordovaNativePlugin { /** * Pass in a type and get back on of undetermined | denied | authorized + * * @param options {HealthKitOptions} * @returns {Promise} */ @@ -128,6 +128,7 @@ export class HealthKit extends AwesomeCordovaNativePlugin { /** * Ask some or all permissions up front + * * @param options {HealthKitOptions} * @returns {Promise} */ @@ -138,6 +139,7 @@ export class HealthKit extends AwesomeCordovaNativePlugin { /** * Formatted as yyyy-MM-dd + * * @returns {Promise} */ @Cordova() @@ -147,6 +149,7 @@ export class HealthKit extends AwesomeCordovaNativePlugin { /** * Output = male|female|other|unknown + * * @returns {Promise} */ @Cordova() @@ -156,6 +159,7 @@ export class HealthKit extends AwesomeCordovaNativePlugin { /** * Output = A+|A-|B+|B-|AB+|AB-|O+|O-|unknown + * * @returns {Promise} */ @Cordova() @@ -165,6 +169,7 @@ export class HealthKit extends AwesomeCordovaNativePlugin { /** * Output = I|II|III|IV|V|VI|unknown + * * @returns {Promise} */ @Cordova() @@ -174,6 +179,7 @@ export class HealthKit extends AwesomeCordovaNativePlugin { /** * Pass in unit (g=gram, kg=kilogram, oz=ounce, lb=pound, st=stone) and amount + * * @param options {HealthKitOptions} * @returns {Promise} */ @@ -184,6 +190,7 @@ export class HealthKit extends AwesomeCordovaNativePlugin { /** * Pass in unit (g=gram, kg=kilogram, oz=ounce, lb=pound, st=stone) + * * @param options {HealthKitOptions} * @returns {Promise} */ @@ -194,6 +201,7 @@ export class HealthKit extends AwesomeCordovaNativePlugin { /** * Pass in unit (mm=millimeter, cm=centimeter, m=meter, in=inch, ft=foot) and amount + * * @param options {HealthKitOptions} * @returns {Promise} */ @@ -204,6 +212,7 @@ export class HealthKit extends AwesomeCordovaNativePlugin { /** * Pass in unit (mm=millimeter, cm=centimeter, m=meter, in=inch, ft=foot) + * * @param options {HealthKitOptions} * @returns {Promise} */ @@ -214,6 +223,7 @@ export class HealthKit extends AwesomeCordovaNativePlugin { /** * no params yet, so this will return all workouts ever of any type + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/health/index.ts b/src/@awesome-cordova-plugins/plugins/health/index.ts index cc03a6d7..c243a2f7 100644 --- a/src/@awesome-cordova-plugins/plugins/health/index.ts +++ b/src/@awesome-cordova-plugins/plugins/health/index.ts @@ -164,7 +164,6 @@ export interface HealthData { * @name Health * @description * A plugin that abstracts fitness and health repositories like Apple HealthKit or Google Fit. - * * @usage * ```typescript * import { Health } from '@awesome-cordova-plugins/health/ngx'; @@ -191,7 +190,6 @@ export interface HealthData { * * ``` * See description at https://github.com/dariosalvi78/cordova-plugin-health for a full list of Datatypes and see examples. - * * @interfaces * HealthQueryOptions * HealthQueryOptionsAggregated @@ -210,7 +208,7 @@ export class Health extends AwesomeCordovaNativePlugin { /** * Tells if either Google Fit or HealthKit are available. * - * @return {Promise} + * @returns {Promise} */ @Cordova({ callbackOrder: 'reverse', @@ -228,7 +226,7 @@ export class Health extends AwesomeCordovaNativePlugin { * * This function is only available on Android. * - * @return {Promise} + * @returns {Promise} */ @Cordova({ callbackOrder: 'reverse', @@ -254,7 +252,7 @@ export class Health extends AwesomeCordovaNativePlugin { * (e.g. in the case of "distance", it will need access to ACCESS_FINE_LOCATION). * * @param {string[] | HealthDataType[]} datatypes a list of data types you want to be granted access to. - * @return {Promise} + * @returns {Promise} */ @Cordova() requestAuthorization(datatypes: (string | HealthDataType)[]): Promise { @@ -270,7 +268,7 @@ export class Health extends AwesomeCordovaNativePlugin { * Read-only data will always be considered as not authorized. This is an intended behaviour of HealthKit. * * @param {string[] | HealthDataType[]} datatypes a list of data types you want to check access of, same as in requestAuthorization - * @return {Promise} Returns a promise that resolves with a boolean that indicates the authorization status + * @returns {Promise} Returns a promise that resolves with a boolean that indicates the authorization status */ @Cordova() isAuthorized(datatypes: (string | HealthDataType)[]): Promise { @@ -306,7 +304,7 @@ export class Health extends AwesomeCordovaNativePlugin { * Automatic conversion is not trivial and depends on the actual substance. * * @param {HealthQueryOptions} queryOptions - * @return {Promise} + * @returns {Promise} */ @Cordova() query(queryOptions: HealthQueryOptions): Promise { @@ -332,7 +330,7 @@ export class Health extends AwesomeCordovaNativePlugin { * nutrition.vitamin_a is given in micrograms in HealthKit and International Unit in Google Fit. * * @param {HealthQueryOptionsAggregated} queryOptionsAggregated - * @return {Promise} + * @returns {Promise} */ @Cordova() queryAggregated(queryOptionsAggregated: HealthQueryOptionsAggregated): Promise { @@ -350,8 +348,9 @@ export class Health extends AwesomeCordovaNativePlugin { * In iOS distance is assumed to be of type WalkingRunning, if you want to explicitly set it to Cycling you need to add the field cycling: true. * In iOS storing the sleep activities is not supported at the moment. * Storing of nutrients is not supported at the moment. + * * @param storeOptions - * @return {Promise} + * @returns {Promise} */ @Cordova() store(storeOptions: HealthStoreOptions): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/http/index.ts b/src/@awesome-cordova-plugins/plugins/http/index.ts index 29c390fe..e0e3cc38 100644 --- a/src/@awesome-cordova-plugins/plugins/http/index.ts +++ b/src/@awesome-cordova-plugins/plugins/http/index.ts @@ -37,7 +37,6 @@ interface AbortedResponse { * - SSL / TLS Pinning * - CORS restrictions do not apply * - Handling of HTTP code 401 - read more at [Issue CB-2415](https://issues.apache.org/jira/browse/CB-2415) - * * @usage * ```typescript * import { HTTP } from '@awesome-cordova-plugins/http/ngx'; @@ -77,6 +76,7 @@ interface AbortedResponse { export class HTTP extends AwesomeCordovaNativePlugin { /** * This enum represents the internal error codes which can be returned in a HTTPResponse object. + * * @readonly */ @CordovaProperty() @@ -93,6 +93,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * This returns an object representing a basic HTTP Authorization header of the form. + * * @param username {string} Username * @param password {string} Password * @returns {Object} an object representing a basic HTTP Authorization header of the form {'Authorization': 'Basic base64EncodedUsernameAndPassword'} @@ -104,6 +105,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * This sets up all future requests to use Basic HTTP authentication with the given username and password. + * * @param username {string} Username * @param password {string} Password */ @@ -112,6 +114,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Get all headers defined for a given hostname. + * * @param host {string} The hostname * @returns {string} return all headers defined for the hostname */ @@ -122,6 +125,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Set a header for all future requests. Takes a hostname, a header and a value. + * * @param host {string} The hostname to be used for scoping this header * @param header {string} The name of the header * @param value {string} The value of the header @@ -131,6 +135,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Get the name of the data serializer which will be used for all future POST and PUT requests. + * * @returns {string} returns the name of the configured data serializer */ @Cordova({ sync: true }) @@ -140,6 +145,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Set the data serializer which will be used for all future POST, PUT and PATCH requests. Takes a string representing the name of the serializer. + * * @param serializer {string} The name of the serializer. * @see https://github.com/silkimen/cordova-plugin-advanced-http#setdataserializer */ @@ -148,6 +154,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Add a custom cookie. + * * @param url {string} Scope of the cookie * @param cookie {string} RFC compliant cookie string */ @@ -162,6 +169,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Remove cookies for given URL. + * * @param url {string} * @param cb */ @@ -170,6 +178,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Resolve cookie string for given URL. + * * @param url {string} */ @Cordova({ sync: true }) @@ -179,6 +188,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Get global request timeout value in seconds. + * * @returns {number} returns the global request timeout value */ @Cordova({ sync: true }) @@ -188,6 +198,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Set global request timeout value in seconds. + * * @param timeout {number} The timeout in seconds. Default 60 */ @Cordova({ sync: true }) @@ -195,6 +206,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Resolve if it should follow redirects automatically. + * * @returns {boolean} returns true if it is configured to follow redirects automatically */ @Cordova({ sync: true }) @@ -204,6 +216,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Configure if it should follow redirects automatically. + * * @param follow {boolean} Set to false to disable following redirects automatically */ @Cordova({ sync: true }) @@ -215,6 +228,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { * legacy: use legacy default behavior (< 2.0.3), excluding user installed CA certs (only for Android); * nocheck: disable SSL certificate checking and hostname verification, trusting all certs (meant to be used only for testing purposes); * pinned: trust only provided certificates; + * * @see https://github.com/silkimen/cordova-plugin-advanced-http#setservertrustmode * @param {string} mode server trust mode */ @@ -225,6 +239,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make a POST request + * * @param url {string} The url to send the request to * @param body {Object} The body of the request * @param headers {Object} The headers to set for this request @@ -237,6 +252,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make a sync POST request + * * @param url {string} The url to send the request to * @param body {Object} The body of the request * @param headers {Object} The headers to set for this request @@ -260,6 +276,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make a GET request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -272,6 +289,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make a sync GET request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -295,6 +313,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make a PUT request + * * @param url {string} The url to send the request to * @param body {Object} The body of the request * @param headers {Object} The headers to set for this request @@ -307,6 +326,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make a sync PUT request + * * @param url {string} The url to send the request to * @param body {Object} The body of the request * @param headers {Object} The headers to set for this request @@ -330,6 +350,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make a PATCH request + * * @param url {string} The url to send the request to * @param body {Object} The body of the request * @param headers {Object} The headers to set for this request @@ -342,6 +363,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make a sync PATCH request + * * @param url {string} The url to send the request to * @param body {Object} The body of the request * @param headers {Object} The headers to set for this request @@ -365,6 +387,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make a DELETE request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -377,6 +400,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make a sync DELETE request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -400,6 +424,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make a HEAD request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -412,6 +437,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make a sync HEAD request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -435,6 +461,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make an OPTIONS request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -447,6 +474,7 @@ export class HTTP extends AwesomeCordovaNativePlugin { /** * Make an sync OPTIONS request + * * @param url {string} The url to send the request to * @param parameters {Object} Parameters to send with the request * @param headers {Object} The headers to set for this request @@ -560,7 +588,6 @@ export class HTTP extends AwesomeCordovaNativePlugin { * @param options.filePath {string} file path(s) to be used during upload and download see uploadFile and downloadFile for detailed information * @param options.name {string} name(s) to be used during upload see uploadFile for detailed information * @param options.responseType {string} response type, defaults to text - * * @returns {Promise} returns a promise that will resolve on success, and reject on failure */ @Cordova() @@ -596,7 +623,6 @@ export class HTTP extends AwesomeCordovaNativePlugin { * @param options.responseType {string} response type, defaults to text * @param success {function} A callback that is called when the request succeed * @param failure {function} A callback that is called when the request failed - * * @returns {string} returns a string that represents the requestId */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/hyper-track/index.ts b/src/@awesome-cordova-plugins/plugins/hyper-track/index.ts index 5acc0f60..9e8fb3f6 100644 --- a/src/@awesome-cordova-plugins/plugins/hyper-track/index.ts +++ b/src/@awesome-cordova-plugins/plugins/hyper-track/index.ts @@ -91,11 +91,11 @@ export class Coordinates { /** A blocker is an obstacle that needs to be resolved to achieve reliable tracking. */ export interface Blocker { /** Recommended name for a user action, that needs to be performed to resolve the blocker. */ - userActionTitle: String; + userActionTitle: string; /** Recommended name for a button, that will navigate user to the place where he can resolve the blocker */ - userActionCTA: String; + userActionCTA: string; /** User action explanation */ - userActionExplanation: String; + userActionExplanation: string; /** An action that navigates user to the dedicated settings menu. */ resolve: () => void; } @@ -124,7 +124,6 @@ export interface Blocker { * } * * ``` - * */ export class HyperTrack { /** Enables debug log in native HyperTrack SDK. */ @@ -137,8 +136,8 @@ export class HyperTrack { * * Initializes SDK. Also resolves SDK instance that could be used to query deviceId or set * various data. - * @param publishableKey account-specific secret from the HyperTrack dashborad. * + * @param publishableKey account-specific secret from the HyperTrack dashborad. * @see {@link https://dashboard.hypertrack.com/setup}. */ static initialize(publishableKey: string): Promise { @@ -181,7 +180,11 @@ export class HyperTrack { }); } - /** Sets device name that could be used to identify the device in HyperTrack dashboard */ + /** + * Sets device name that could be used to identify the device in HyperTrack dashboard + * + * @param name + */ setDeviceName(name: string): Promise { return new Promise((resolve, reject) => { this.cordovaInstanceHandle.setDeviceName( @@ -194,6 +197,7 @@ export class HyperTrack { /** * Use this to set additional properties, like segments, teams etc. + * * @param metadata key-value pais of properties. */ setDeviceMetadata(metadata: Object): Promise { @@ -206,7 +210,12 @@ export class HyperTrack { }); } - /** Updates title and text in persistent notification, that appears when tracking is active. */ + /** + * Updates title and text in persistent notification, that appears when tracking is active. + * + * @param title + * @param message + */ setTrackingNotificationProperties(title: string, message: string): Promise { return new Promise((resolve, reject) => { this.cordovaInstanceHandle.setTrackingNotificationProperties( @@ -218,7 +227,12 @@ export class HyperTrack { }); } - /** Adds special marker-like object to device timeline. */ + /** + * Adds special marker-like object to device timeline. + * + * @param geotagData + * @param expectedLocation + */ addGeotag(geotagData: Object, expectedLocation?: Coordinates): Promise { return new Promise((resolve, reject) => { this.cordovaInstanceHandle.addGeoTag( diff --git a/src/@awesome-cordova-plugins/plugins/iamport-cordova/index.ts b/src/@awesome-cordova-plugins/plugins/iamport-cordova/index.ts index cd83799c..0c246d47 100644 --- a/src/@awesome-cordova-plugins/plugins/iamport-cordova/index.ts +++ b/src/@awesome-cordova-plugins/plugins/iamport-cordova/index.ts @@ -64,7 +64,6 @@ export interface CertificationData { * @name Iamport Cordova * @description * This plugin does something - * * @usage * ```typescript * import { IamportCordova } from '@awesome-cordova-plugins/iamport-cordova/ngx'; @@ -92,8 +91,9 @@ export interface CertificationData { export class IamportCordova extends AwesomeCordovaNativePlugin { /** * This function is to load a webview of a payment gateway to pay for something + * * @param paymentObject {PaymentObject} Payment data to set the payment webview - * @return {Promise} A callback function of the payment data is triggered when the webview is closed + * @returns {Promise} A callback function of the payment data is triggered when the webview is closed */ @Cordova() payment(paymentObject: PaymentObject): Promise { @@ -102,8 +102,9 @@ export class IamportCordova extends AwesomeCordovaNativePlugin { /** * This function is to load a webview for identification with carrier type(like Verizon), name and phone number + * * @param certificationObject {CertificationObject} Certification data to set the certification webview - * @return {Promise} A callback function of the certification data is triggered when the webview is closed + * @returns {Promise} A callback function of the certification data is triggered when the webview is closed */ @Cordova() certification(certificationObject: CertificationObject): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/ibeacon/index.ts b/src/@awesome-cordova-plugins/plugins/ibeacon/index.ts index d095aad9..d16a8490 100644 --- a/src/@awesome-cordova-plugins/plugins/ibeacon/index.ts +++ b/src/@awesome-cordova-plugins/plugins/ibeacon/index.ts @@ -226,7 +226,6 @@ export interface IBeaconDelegate { * This plugin provides functions for working with iBeacons. * * The plugin's API closely mimics the one exposed through the [CLLocationManager](https://developer.apple.com/library/ios/documentation/CoreLocation/Reference/CLLocationManager_Class/index.html) introduced in iOS 7. - * * @usage * * ```typescript @@ -274,7 +273,6 @@ export interface IBeaconDelegate { * CircularRegion * IBeaconPluginResult * IBeaconDelegate - * */ @Plugin({ pluginName: 'IBeacon', @@ -365,13 +363,13 @@ export class IBeacon extends AwesomeCordovaNativePlugin { /** * Creates a new BeaconRegion * - * @param {String} identifier @see {CLRegion} - * @param {String} uuid The proximity ID of the beacon being targeted. + * @param {string} identifier @see {CLRegion} + * @param identifer + * @param {string} uuid The proximity ID of the beacon being targeted. * This value must not be blank nor invalid as a UUID. - * @param {Number} major The major value that you use to identify one or more beacons. - * @param {Number} minor The minor value that you use to identify a specific beacon. + * @param {number} major The major value that you use to identify one or more beacons. + * @param {number} minor The minor value that you use to identify a specific beacon. * @param {BOOL} notifyEntryStateOnDisplay - * * @returns {BeaconRegion} Returns the BeaconRegion that was created */ @CordovaCheck({ sync: true }) @@ -401,7 +399,6 @@ export class IBeacon extends AwesomeCordovaNativePlugin { /** * @param {IBeaconDelegate} delegate An instance of a delegate to register with the native layer. - * * @returns {IBeaconDelegate} Returns the IBeaconDelegate */ @Cordova() @@ -436,6 +433,7 @@ export class IBeacon extends AwesomeCordovaNativePlugin { /** * Determines if bluetooth is switched on, according to the native layer. + * * @returns {Promise} Returns a promise which is resolved with a {Boolean} * indicating whether bluetooth is active. */ @@ -479,7 +477,6 @@ export class IBeacon extends AwesomeCordovaNativePlugin { * * @param {Region} region An instance of {Region} which will be monitored * by the operating system. - * * @returns {Promise} Returns a promise which is resolved as soon as the * native layer acknowledged the dispatch of the monitoring request. */ @@ -498,7 +495,6 @@ export class IBeacon extends AwesomeCordovaNativePlugin { * * @param {Region} region An instance of {Region} which will be monitored * by the operating system. - * * @returns {Promise} Returns a promise which is resolved as soon as the * native layer acknowledged the dispatch of the request to stop monitoring. */ @@ -516,7 +512,6 @@ export class IBeacon extends AwesomeCordovaNativePlugin { * * @param {Region} region An instance of {Region} which will be monitored * by the operating system. - * * @returns {Promise} Returns a promise which is resolved as soon as the * native layer acknowledged the dispatch of the request to stop monitoring. */ @@ -535,7 +530,6 @@ export class IBeacon extends AwesomeCordovaNativePlugin { * * @param {Region} region An instance of {BeaconRegion} which will be monitored * by the operating system. - * * @returns {Promise} Returns a promise which is resolved as soon as the * native layer acknowledged the dispatch of the monitoring request. */ @@ -554,7 +548,6 @@ export class IBeacon extends AwesomeCordovaNativePlugin { * * @param {Region} region An instance of {BeaconRegion} which will be monitored * by the operating system. - * * @returns {Promise} Returns a promise which is resolved as soon as the * native layer acknowledged the dispatch of the request to stop monitoring. */ @@ -581,6 +574,7 @@ export class IBeacon extends AwesomeCordovaNativePlugin { * requestAlwaysAuthorization * * If you are using this plugin on Android devices only, you will never have to use this, nor {@code requestAlwaysAuthorization} + * * @returns {Promise} Returns a promise that is resolved when the request dialog is shown. */ @Cordova({ otherPromise: true }) @@ -621,6 +615,7 @@ export class IBeacon extends AwesomeCordovaNativePlugin { /** * Determines if ranging is available or not, according to the native layer. + * * @returns {Promise} Returns a promise which is resolved with a {Boolean} * indicating whether ranging is available or not. */ @@ -634,7 +629,6 @@ export class IBeacon extends AwesomeCordovaNativePlugin { * * @param {Region} region An instance of {Region} which will be checked * by the operating system. - * * @returns {Promise} Returns a promise which is resolved with a {Boolean} * indicating whether the region type is supported or not. */ @@ -656,7 +650,7 @@ export class IBeacon extends AwesomeCordovaNativePlugin { * by the operating system. * @param {Integer} measuredPower: Optional parameter, if left empty, the device will * use it's own default value. - * + * @param measuredPower * @returns {Promise} Returns a promise which is resolved as soon as the * native layer acknowledged the dispatch of the advertising request. */ @@ -670,6 +664,7 @@ export class IBeacon extends AwesomeCordovaNativePlugin { * * This is done asynchronously and may not be immediately reflected in isAdvertising. * + * @param region * @returns {Promise} Returns a promise which is resolved as soon as the * native layer acknowledged the dispatch of the request to stop advertising. */ @@ -680,6 +675,7 @@ export class IBeacon extends AwesomeCordovaNativePlugin { /** * Determines if advertising is available or not, according to the native layer. + * * @returns {Promise} Returns a promise which is resolved with a {Boolean} * indicating whether advertising is available or not. */ @@ -690,6 +686,7 @@ export class IBeacon extends AwesomeCordovaNativePlugin { /** * Determines if advertising is currently active, according to the native layer. + * * @returns {Promise} Returns a promise which is resolved with a {Boolean} * indicating whether advertising is active. */ @@ -751,8 +748,7 @@ export class IBeacon extends AwesomeCordovaNativePlugin { * Appends the provided [message] to the device logs. * Note: If debug logging is turned off, this won't do anything. * - * @param {String} message The message to append to the device logs. - * + * @param {string} message The message to append to the device logs. * @returns {Promise} Returns a promise which is resolved with the log * message received by the native layer for appending. The returned message * is expected to be equivalent to the one provided in the original call. diff --git a/src/@awesome-cordova-plugins/plugins/image-picker/index.ts b/src/@awesome-cordova-plugins/plugins/image-picker/index.ts index 54ef9da9..dfe10817 100644 --- a/src/@awesome-cordova-plugins/plugins/image-picker/index.ts +++ b/src/@awesome-cordova-plugins/plugins/image-picker/index.ts @@ -63,7 +63,6 @@ export enum OutputType { * * Requires Cordova plugin: `cordova-plugin-image-picker`. * For more info, please see the https://github.com/Telerik-Verified-Plugins/ImagePicker - * * @usage * ```typescript * import { ImagePicker } from '@awesome-cordova-plugins/image-picker/ngx'; @@ -97,6 +96,7 @@ export enum OutputType { export class ImagePicker extends AwesomeCordovaNativePlugin { /** * Pick pictures from the library. + * * @param {ImagePickerOptions} options * @returns {Promise} Returns a Promise that resolves the image file URI * otherwise rejects with an error. @@ -110,6 +110,7 @@ export class ImagePicker extends AwesomeCordovaNativePlugin { /** * Check if we have permission to read images + * * @returns {Promise} Returns a promise that resolves with a boolean that indicates whether we have permission */ @Cordova({ @@ -121,6 +122,7 @@ export class ImagePicker extends AwesomeCordovaNativePlugin { /** * Request permission to read images + * * @returns {Promise} */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/imap/index.ts b/src/@awesome-cordova-plugins/plugins/imap/index.ts index a88dabd2..b0b6a61a 100644 --- a/src/@awesome-cordova-plugins/plugins/imap/index.ts +++ b/src/@awesome-cordova-plugins/plugins/imap/index.ts @@ -223,7 +223,6 @@ export enum FlagEnum { * This plugin is in Beta version and it offers support only for Android. * The plugin uses Java Mail API. * Planned improvements and support for iOS. - * * @usage * ```typescript * import { Imap } from '@awesome-cordova-plugins/imap/ngx'; @@ -324,8 +323,8 @@ export enum FlagEnum { * }); * * - * * Sets a flag on a message - * * "setFlag()" can be used for deleting messages setting the Delete flag to "FlagEnum.DELETED" + * Sets a flag on a message + * "setFlag()" can be used for deleting messages setting the Delete flag to "FlagEnum.DELETED" * this.imap.setFlag('INBOX', [1206, 1205, 1204], FlagEnum.SEEN, true) * .then((res: ModificationResult) => { * @@ -351,8 +350,9 @@ export enum FlagEnum { export class Imap extends AwesomeCordovaNativePlugin { /** * This function "connect(clientData: Config)" tries to connect and authenticate with the IMAP server. + * * @param clientData {Config} Connection configuration - * @return {Promise} Returns a promise with the connection data + * @returns {Promise} Returns a promise with the connection data */ @Cordova() connect(clientData: Config): Promise { @@ -361,7 +361,8 @@ export class Imap extends AwesomeCordovaNativePlugin { /** * "disconnect()" Closes the connection with the server. - * @return {Promise} Returns a promise status. + * + * @returns {Promise} Returns a promise status. */ @Cordova() disconnect(): Promise { @@ -370,7 +371,8 @@ export class Imap extends AwesomeCordovaNativePlugin { /** * "isConnected()" Checks the current state of the connection. - * @return {Promise} Returns a promise with connection status + * + * @returns {Promise} Returns a promise with connection status */ @Cordova() isConnected(): Promise { @@ -381,7 +383,8 @@ export class Imap extends AwesomeCordovaNativePlugin { /** * "listMailFolders()" Lists the name of all the mail folders in the mailbox. - * @return {Promise} Returns array with all folder names. + * + * @returns {Promise} Returns array with all folder names. */ @Cordova() listMailFolders(): Promise { @@ -390,8 +393,9 @@ export class Imap extends AwesomeCordovaNativePlugin { /** * "getMessageCountByFolderName(folderName: string)" Gets the count of the messages in the folder. + * * @param folderName {string} The name of the desired folder. - * @return {Promise} Returns the consecutive number of the last message. + * @returns {Promise} Returns the consecutive number of the last message. */ @Cordova() getMessageCountByFolderName(folderName: string): Promise { @@ -400,10 +404,11 @@ export class Imap extends AwesomeCordovaNativePlugin { /** * "searchMessagesByDatePeriod(folderName: string, dateInMilliseconds: number, comparison: Comparison)" Returns the messages' consecutive number. + * * @param folderName {string} The name of the desired folder * @param dateInMilliseconds {number} Date in milliseconds * @param comparison {Comparison} A comparison operator - * @return {Promise} Returns array with the messages' consecutive numbers. + * @returns {Promise} Returns array with the messages' consecutive numbers. */ @Cordova() searchMessagesByDatePeriod( @@ -416,10 +421,11 @@ export class Imap extends AwesomeCordovaNativePlugin { /** * "listMessagesHeadersByConsecutiveNumber(folderName: string, start: number, end: number)" Returns messages' headers data based on a "start" and "end" message consecutive number. + * * @param folderName {string} The name of the desired folder * @param start {number} Consecutive number of the first message. * @param end {number} Consecutive number of the last message - * @return {Promise} Returns array with the messages' headers data. + * @returns {Promise} Returns array with the messages' headers data. */ @Cordova() listMessagesHeadersByConsecutiveNumber(folderName: string, start: number, end: number): Promise { @@ -428,10 +434,11 @@ export class Imap extends AwesomeCordovaNativePlugin { /** * "listMessagesHeadersByDate(folderName: string, dateInMilliseconds: number, comparison: Comparison)" Returns messages' headers data based on a date. + * * @param folderName {string} The name of the desired folder * @param dateInMilliseconds {number} Date in milliseconds. * @param comparison {Comparison} A comparison operator - * @return {Promise} Returns array messages' headers data. + * @returns {Promise} Returns array messages' headers data. */ @Cordova() listMessagesHeadersByDate( @@ -444,9 +451,10 @@ export class Imap extends AwesomeCordovaNativePlugin { /** * "getFullMessageData(folderName: string, messageNumber: number)" Returns the full message's data including its attachments. + * * @param folderName {string} The name the message's folder * @param messageNumber {number} Message's consecutive number. - * @return {Promise} Returns "Message" object with full message data. + * @returns {Promise} Returns "Message" object with full message data. */ @Cordova() getFullMessageData(folderName: string, messageNumber: number): Promise { @@ -455,10 +463,11 @@ export class Imap extends AwesomeCordovaNativePlugin { /** * "copyToFolder(sourceFolder: string, destinationFolder: string, messageNums: number[])" Copy messages to a desired folder. + * * @param sourceFolder {string} The name of the source folder. * @param destinationFolder {string} The name of the destination folder. * @param messageNums {number[]} Array with messages' consecutive numbers or array with single message consecutive number. - * @return {Promise} Returns boolean status of the process. + * @returns {Promise} Returns boolean status of the process. */ @Cordova() copyToFolder(sourceFolder: string, destinationFolder: string, messageNums: number[]): Promise { @@ -467,11 +476,12 @@ export class Imap extends AwesomeCordovaNativePlugin { /** * "setFlag(folderName: string, messageNums: number[], flag: FlagEnum, status: boolean)" Set or remove flag from a message + * * @param folderName {string} The name of the source folder where the messages are contained. * @param messageNums {number[]} Array with messages' consecutive numbers or array with single message consecutive number * @param flag {FlagEnum} Desired message flag. * @param status {boolean} Set status to "true" to set the flag on a message; or to "false" to remove the flag from the message - * @return {Promise} Returns object with status and array with messages' consecutive numbers of the modified messages + * @returns {Promise} Returns object with status and array with messages' consecutive numbers of the modified messages */ @Cordova() setFlag(folderName: string, messageNums: number[], flag: FlagEnum, status: boolean): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/in-app-browser/index.ts b/src/@awesome-cordova-plugins/plugins/in-app-browser/index.ts index 11581408..c723ea38 100644 --- a/src/@awesome-cordova-plugins/plugins/in-app-browser/index.ts +++ b/src/@awesome-cordova-plugins/plugins/in-app-browser/index.ts @@ -148,6 +148,7 @@ export class InAppBrowserObject { /** * Opens a URL in a new InAppBrowser instance, the current browser instance, or the system browser. + * * @param {string} url The URL to load. * @param {string} [target="self"] The target in which to load the URL, an optional parameter that defaults to _self. * _self: Opens in the WebView if the URL is in the white list, otherwise it opens in the InAppBrowser. @@ -178,6 +179,7 @@ export class InAppBrowserObject { /** * Method to be called after the "beforeload" event to continue the script + * * @param strUrl {String} The URL the InAppBrowser should navigate to. */ @CordovaInstance({ sync: true }) @@ -205,7 +207,10 @@ export class InAppBrowserObject { /** * Injects JavaScript code into the InAppBrowser window. + * * @param script {Object} Details of the script to run, specifying either a file or code key. + * @param script.file + * @param script.code * @returns {Promise} */ @CordovaInstance() @@ -215,7 +220,10 @@ export class InAppBrowserObject { /** * Injects CSS into the InAppBrowser window. + * * @param css {Object} Details of the script to run, specifying either a file or code key. + * @param css.file + * @param css.code * @returns {Promise} */ @CordovaInstance() @@ -225,6 +233,7 @@ export class InAppBrowserObject { /** * A method that allows you to listen to events happening in the browser. + * * @param event {InAppBrowserEventType} Name of the event * @returns {Observable} Returns back an observable that will listen to the event on subscribe, and will stop listening to the event on unsubscribe. */ @@ -238,6 +247,7 @@ export class InAppBrowserObject { /** * A method that allows you to listen to events happening in the browser. + * * @param event {string} Name of the event * @returns {Observable} Returns back an observable that will listen to the event on subscribe, and will stop listening to the event on unsubscribe. */ @@ -293,6 +303,7 @@ export class InAppBrowserObject { export class InAppBrowser extends AwesomeCordovaNativePlugin { /** * Opens a URL in a new InAppBrowser instance, the current browser instance, or the system browser. + * * @param url {string} The URL to load. * @param target {string} The target in which to load the URL, an optional parameter that defaults to _self. * @param options {string} Options for the InAppBrowser. Optional, defaulting to: location=yes. diff --git a/src/@awesome-cordova-plugins/plugins/in-app-purchase-2/index.ts b/src/@awesome-cordova-plugins/plugins/in-app-purchase-2/index.ts index 3b946f28..2d585943 100644 --- a/src/@awesome-cordova-plugins/plugins/in-app-purchase-2/index.ts +++ b/src/@awesome-cordova-plugins/plugins/in-app-purchase-2/index.ts @@ -101,7 +101,7 @@ export interface IAPProduct { * - you will receive the `approved` event each time the application starts, * where you should try again to finish the pending transaction. * - * **example use** + * example use** * * ```js * store.when("product.id").approved(function(product){ @@ -125,7 +125,7 @@ export interface IAPProduct { /** * Initiate purchase validation as defined by the `store.validator` attribute. * - * **return value** + * return value** * * A Promise with the following methods: * @@ -248,7 +248,6 @@ export class IAPError { * - **macOS** version 10 * - **Xbox One** * - (and any platform supporting Microsoft's UWP) - * * @usage * ```typescript * import { InAppPurchase2 } from '@awesome-cordova-plugins/in-app-purchase-2/ngx'; @@ -458,7 +457,7 @@ export class IAPError { * - call `product.verify()` from the `approved` event, before finishing the transaction. * - finish the transaction when transaction is `verified`. * - * **Shameless Plug**: this is a feature many users struggle with, so as the author of this plugin, we can provide it to you as-a-service: https://billing.fovea.cc/ + * Shameless Plug**: this is a feature many users struggle with, so as the author of this plugin, we can provide it to you as-a-service: https://billing.fovea.cc/ * (which is free until you start making serious money) * * #### example using a validation URL @@ -765,6 +764,7 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin { /** * Get product by id or alias + * * @param idOrAlias */ @Cordova({ sync: true }) @@ -774,6 +774,7 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin { /** * Register error handler + * * @param onError {Function} function to call on error */ @Cordova({ sync: true }) @@ -781,6 +782,7 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin { /** * Add or register a product + * * @param product {IAPProductOptions} */ @Cordova({ sync: true }) @@ -791,7 +793,7 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin { * @param query * @param event * @param callback - * @return {IAPProductEvents} + * @returns {IAPProductEvents} */ @Cordova({ sync: true }) when(query: string | IAPProduct, event?: string, callback?: IAPQueryCallback): IAPProductEvents { @@ -800,10 +802,11 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin { /** * Identical to `when`, but the callback will be called only once. After being called, the callback will be unregistered. + * * @param query {string | IAPProduct} * @param [event] {event} * @param [callback] {IAPQueryCallback} - * @return {IAPProductEvents} + * @returns {IAPProductEvents} */ @Cordova({ sync: true }) once(query: string | IAPProduct, event?: string, callback?: IAPQueryCallback): IAPProductEvents { @@ -812,6 +815,7 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin { /** * Unregister a callback. Works for callbacks registered with ready, when, once and error. + * * @param callback {Function} */ @Cordova({ sync: true }) @@ -833,12 +837,15 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin { * * See the "Purchasing section" to learn more about the purchase process. * - * **return value** + * return value** * * `store.order()` returns a Promise with the following methods: * * - `then` - called when the order was successfully initiated. * - `error` - called if the order couldn't be initiated. + * + * @param product + * @param additionalData */ @Cordova({ sync: true }) order(product: string | IAPProduct, additionalData?: any): { then: Function; error: Function } { @@ -866,7 +873,7 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin { * if a user wants to restore purchases he made from another device, he'll * have a way to do just that. * - * **example usage** + * example usage** * * ```typescript * // ... @@ -877,7 +884,7 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin { * this.store.refresh(); * ``` * - * **restore purchases** + * restore purchases** * * Add a "Refresh Purchases" button to call the `store.refresh()` method, like: * diff --git a/src/@awesome-cordova-plugins/plugins/in-app-review/index.ts b/src/@awesome-cordova-plugins/plugins/in-app-review/index.ts index 5e700ff0..aaabc307 100644 --- a/src/@awesome-cordova-plugins/plugins/in-app-review/index.ts +++ b/src/@awesome-cordova-plugins/plugins/in-app-review/index.ts @@ -7,8 +7,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * This plugin does use the iOS class SKStore​Review​Controller to open the inApp review popup available since iOS 10.3 * * This functionality only works on iOS devices - * - * * @usage * ```typescript * import { InAppReview } from '@awesome-cordova-plugins/in-app-review/ngx'; @@ -37,7 +35,8 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class InAppReview extends AwesomeCordovaNativePlugin { /** * Open the inApp review popup - * @return {Promise} Returns a promise that resolves when something happens + * + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() requestReview(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/in-app-update/index.ts b/src/@awesome-cordova-plugins/plugins/in-app-update/index.ts index 08839629..6f0201b1 100644 --- a/src/@awesome-cordova-plugins/plugins/in-app-update/index.ts +++ b/src/@awesome-cordova-plugins/plugins/in-app-update/index.ts @@ -35,13 +35,13 @@ enum UpdateAvailability { class AppUpdateInfo { updateType: UpdateType; installStatus: InstallStatus; - availableVersionCode: Number; - bytesDownloaded: Number; - totalBytesToDownload: Number; - clientVersionStalenessDays: Number; - packageName: String; + availableVersionCode: number; + bytesDownloaded: number; + totalBytesToDownload: number; + clientVersionStalenessDays: number; + packageName: string; updateAvailability: UpdateAvailability; - installErrorCode: String; + installErrorCode: string; } /** @@ -60,7 +60,8 @@ class AppUpdateInfo { export class InAppUpdate extends AwesomeCordovaNativePlugin { /** * If you want the user to be prompted about new version information before initiating the update, you can use `check` to retrive the new app version information. - * @return {Promise} Returns a promise that resolves with new app version update details + * + * @returns {Promise} Returns a promise that resolves with new app version update details */ @Cordova() check(): Promise { @@ -69,7 +70,10 @@ export class InAppUpdate extends AwesomeCordovaNativePlugin { /** * Initiate Update Flow with "FLEXIBLE" | "IMMEDIATE" updateType - * @return {Observable} Returns a Observable can be subscribed to get update install state + * + * @param config + * @param config.updateType + * @returns {Observable} Returns a Observable can be subscribed to get update install state */ @Cordova({ observable: true }) update(config: { updateType: 'FLEXIBLE' | 'IMMEDIATE' }): Observable { @@ -78,7 +82,8 @@ export class InAppUpdate extends AwesomeCordovaNativePlugin { /** * Flexible updates provide background download. Once flexible update completes the download in background, completion of upgrade can be initiated by calling `completeFlexibleUpdate`. - * @return Returns empty response, fire and forget + * + * @returns Returns empty response, fire and forget */ @Cordova() completeFlexibleUpdate(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/insomnia/index.ts b/src/@awesome-cordova-plugins/plugins/insomnia/index.ts index e5004391..964b8cd9 100644 --- a/src/@awesome-cordova-plugins/plugins/insomnia/index.ts +++ b/src/@awesome-cordova-plugins/plugins/insomnia/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Insomnia * @description * Prevent the screen of the mobile device from falling asleep. - * * @usage * ```typescript * import { Insomnia } from '@awesome-cordova-plugins/insomnia/ngx'; @@ -26,7 +25,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * () => console.log('error') * ); * ``` - * */ @Plugin({ pluginName: 'Insomnia', @@ -39,6 +37,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class Insomnia extends AwesomeCordovaNativePlugin { /** * Keeps awake the application + * * @returns {Promise} */ @Cordova() @@ -48,6 +47,7 @@ export class Insomnia extends AwesomeCordovaNativePlugin { /** * Allows the application to sleep again + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/instagram/index.ts b/src/@awesome-cordova-plugins/plugins/instagram/index.ts index 3524eadd..86f24e13 100644 --- a/src/@awesome-cordova-plugins/plugins/instagram/index.ts +++ b/src/@awesome-cordova-plugins/plugins/instagram/index.ts @@ -4,7 +4,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl /** * @name Instagram * @description Share a photo with the instagram app - * * @usage * ```typescript * import { Instagram } from '@awesome-cordova-plugins/instagram/ngx'; @@ -57,6 +56,7 @@ export class Instagram extends AwesomeCordovaNativePlugin { /** * Share a library asset or video + * * @param assetLocalIdentifier A local fileURI * @returns {Promise} Returns a promise that resolves if the image was shared */ diff --git a/src/@awesome-cordova-plugins/plugins/intercom/index.ts b/src/@awesome-cordova-plugins/plugins/intercom/index.ts index 9ef35474..8c0604c1 100644 --- a/src/@awesome-cordova-plugins/plugins/intercom/index.ts +++ b/src/@awesome-cordova-plugins/plugins/intercom/index.ts @@ -6,7 +6,6 @@ import { Injectable } from '@angular/core'; * @description * This is a plugin that allows your Ionic app to use Intercom for iOS and/or Intercom for Android. * Follow the offical documentation to setup this plugin correctly: https://developers.intercom.com/docs/cordova-phonegap-configuration - * * @usage * ```typescript * import { Intercom } from '@awesome-cordova-plugins/intercom/ngx'; @@ -33,8 +32,9 @@ import { Injectable } from '@angular/core'; export class Intercom extends AwesomeCordovaNativePlugin { /** * Register a identified user + * * @param options {any} Options - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() registerIdentifiedUser(options: any): Promise { @@ -43,8 +43,9 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * Register a unidentified user + * * @param options {any} Options - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() registerUnidentifiedUser(options: any): Promise { @@ -53,7 +54,8 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * This resets the Intercom integration's cache of your user's identity and wipes the slate clean. - * @return {Promise} Returns a promise + * + * @returns {Promise} Returns a promise */ @Cordova() reset(): Promise { @@ -62,7 +64,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() logout(): Promise { @@ -73,7 +75,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { * * @param secureHash {string} * @param secureData {any} - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise * @deprecated Use setUserHash instead as of Intercom Cordova 4.0.0 and higher https://github.com/intercom/intercom-cordova/blob/master/CHANGELOG.md#400-2017-08-29 */ @Cordova() @@ -84,7 +86,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * * @param secureHash {string} - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() setUserHash(secureHash: string): Promise { @@ -94,7 +96,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * * @param attributes {any} - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() updateUser(attributes: any): Promise { @@ -105,7 +107,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { * * @param eventName {string} * @param metaData {any} - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() logEvent(eventName: string, metaData: any): Promise { @@ -114,7 +116,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() displayMessenger(): Promise { @@ -123,7 +125,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() displayMessageComposer(): Promise { @@ -133,7 +135,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * * @param initialMessage {string} - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() displayMessageComposerWithInitialMessage(initialMessage: string): Promise { @@ -142,7 +144,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() displayConversationsList(): Promise { @@ -151,7 +153,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() displayHelpCenter(): Promise { @@ -160,7 +162,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() unreadConversationCount(): Promise { @@ -170,7 +172,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * * @param visibility {string} - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() setLauncherVisibility(visibility: string): Promise { @@ -180,7 +182,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * * @param visibility {string} - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() setInAppMessageVisibility(visibility: string): Promise { @@ -189,7 +191,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() hideMessenger(): Promise { @@ -198,7 +200,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() registerForPush(): Promise { @@ -208,7 +210,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * * @param token {string} - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() sendPushTokenToIntercom(token: string): Promise { @@ -218,7 +220,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * * @param carouselId {string} - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() displayCarousel(carouselId: string): Promise { @@ -228,7 +230,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * * @param articleId {string} - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() displayArticle(articleId: string): Promise { @@ -238,7 +240,7 @@ export class Intercom extends AwesomeCordovaNativePlugin { /** * * @param bottomPadding {string | number} - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() setBottomPadding(bottomPadding: string | number): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/ionic-webview/index.ts b/src/@awesome-cordova-plugins/plugins/ionic-webview/index.ts index 8f6894dc..6219429d 100644 --- a/src/@awesome-cordova-plugins/plugins/ionic-webview/index.ts +++ b/src/@awesome-cordova-plugins/plugins/ionic-webview/index.ts @@ -8,7 +8,6 @@ import { CordovaProperty, AwesomeCordovaNativePlugin, Plugin } from '@awesome-co * Access Web View utilities. * * Requires the Cordova plugin: `cordova-plugin-ionic-webview` > 2.0. For more info, please see the [Ionic Web View](https://github.com/ionic-team/cordova-plugin-ionic-webview) repository. - * * @usage * ```typescript * import { WebView } from '@awesome-cordova-plugins/ionic-webview/ngx'; diff --git a/src/@awesome-cordova-plugins/plugins/ios-aswebauthenticationsession-api/index.ts b/src/@awesome-cordova-plugins/plugins/ios-aswebauthenticationsession-api/index.ts index 9cc141a6..abdd65a3 100644 --- a/src/@awesome-cordova-plugins/plugins/ios-aswebauthenticationsession-api/index.ts +++ b/src/@awesome-cordova-plugins/plugins/ios-aswebauthenticationsession-api/index.ts @@ -5,7 +5,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl * @name ios-aswebauthenticationsession-api * @description * Plugin for iOS 12 ASWebAuthenticationSession API - * * @usage * ```typescript * import { IosASWebauthenticationSession } from '@awesome-cordova-plugins/ios-aswebauthenticationsession-api/ngx'; @@ -34,9 +33,10 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl export class IosASWebauthenticationSession extends AwesomeCordovaNativePlugin { /** * This function start an authentication flow in ASWebauthenticationSession + * * @param callbackUrl {string} Callback URL of your App * @param authorizeURL {number} Authorization URL - * @return {Promise} Returns a promise that resolves a string containing the redirect URL after finishing ASWebauthenticationSession + * @returns {Promise} Returns a promise that resolves a string containing the redirect URL after finishing ASWebauthenticationSession */ @Cordova() start(callbackUrl: string, authorizeURL: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/is-debug/index.ts b/src/@awesome-cordova-plugins/plugins/is-debug/index.ts index 65bf5fd9..072a9816 100644 --- a/src/@awesome-cordova-plugins/plugins/is-debug/index.ts +++ b/src/@awesome-cordova-plugins/plugins/is-debug/index.ts @@ -6,7 +6,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @description * Detect if the app is running in debug mode or not. * Debug mode is when the app is built and installed locally via xcode / eclipse / the cordova cli etc, compared to release mode when the app was downloaded from the app / play store via an end user. - * * @usage * ```typescript * import { IsDebug } from '@awesome-cordova-plugins/is-debug/ngx'; @@ -32,6 +31,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class IsDebug extends AwesomeCordovaNativePlugin { /** * Determine if an app was installed via xcode / eclipse / the ionic CLI etc + * * @returns {Promise} Returns a promise that resolves with true if the app was installed via xcode / eclipse / the ionic CLI etc. It will resolve to false if the app was downloaded from the app / play store by the end user. */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/keyboard/index.ts b/src/@awesome-cordova-plugins/plugins/keyboard/index.ts index 15055916..b0acb2cc 100644 --- a/src/@awesome-cordova-plugins/plugins/keyboard/index.ts +++ b/src/@awesome-cordova-plugins/plugins/keyboard/index.ts @@ -22,7 +22,6 @@ export enum KeyboardResizeMode { * Keyboard plugin for Cordova. * * Requires Cordova plugin: `cordova-plugin-ionic-keyboard`. For more info, please see the [Keyboard plugin docs](https://github.com/ionic-team/cordova-plugin-ionic-keyboard). - * * @usage * ```typescript * import { Keyboard } from '@awesome-cordova-plugins/keyboard/ngx'; @@ -48,6 +47,7 @@ export enum KeyboardResizeMode { export class Keyboard extends AwesomeCordovaNativePlugin { /** * Check keyboard status visible or not. + * * @returns {boolean} */ @CordovaProperty() @@ -55,6 +55,7 @@ export class Keyboard extends AwesomeCordovaNativePlugin { /** * Hide the keyboard accessory bar with the next, previous and done buttons. + * * @param hide {boolean} */ @Cordova({ @@ -83,6 +84,7 @@ export class Keyboard extends AwesomeCordovaNativePlugin { /** * Programatically set the resize mode + * * @param mode {string} */ @Cordova({ @@ -93,7 +95,9 @@ export class Keyboard extends AwesomeCordovaNativePlugin { /** * Programatically set Keyboard style + * * @param mode {string} + * @param style */ @Cordova({ sync: true, @@ -103,7 +107,9 @@ export class Keyboard extends AwesomeCordovaNativePlugin { /** * Programatically enable or disable the WebView scroll + * * @param mode {string} + * @param disable */ @Cordova({ sync: true, @@ -113,6 +119,7 @@ export class Keyboard extends AwesomeCordovaNativePlugin { /** * Creates an observable that notifies you when the keyboard is shown. Unsubscribe to observable to cancel event watch. + * * @returns {Observable} */ @Cordova({ @@ -126,6 +133,7 @@ export class Keyboard extends AwesomeCordovaNativePlugin { /** * Creates an observable that notifies you when the keyboard will show. Unsubscribe to observable to cancel event watch. + * * @returns {Observable} */ @Cordova({ @@ -139,6 +147,7 @@ export class Keyboard extends AwesomeCordovaNativePlugin { /** * Creates an observable that notifies you when the keyboard did show. Unsubscribe to observable to cancel event watch. + * * @returns {Observable} */ @Cordova({ @@ -152,6 +161,7 @@ export class Keyboard extends AwesomeCordovaNativePlugin { /** * Creates an observable that notifies you when the keyboard is hidden. Unsubscribe to observable to cancel event watch. + * * @returns {Observable} */ @Cordova({ @@ -165,6 +175,7 @@ export class Keyboard extends AwesomeCordovaNativePlugin { /** * Creates an observable that notifies you when the keyboard will hide. Unsubscribe to observable to cancel event watch. + * * @returns {Observable} */ @Cordova({ @@ -178,6 +189,7 @@ export class Keyboard extends AwesomeCordovaNativePlugin { /** * Creates an observable that notifies you when the keyboard did hide. Unsubscribe to observable to cancel event watch. + * * @returns {Observable} */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/keychain/index.ts b/src/@awesome-cordova-plugins/plugins/keychain/index.ts index 0b89f5e2..afe2a2e0 100644 --- a/src/@awesome-cordova-plugins/plugins/keychain/index.ts +++ b/src/@awesome-cordova-plugins/plugins/keychain/index.ts @@ -9,7 +9,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * Requires Cordova plugin: `cordova-plugin-ios-keychain`. For more info, please see the [Keychain plugin docs](https://github.com/ionic-team/cordova-plugin-ios-keychain). * * See also [Secure Storage](https://ionicframework.com/docs/native/secure-storage/) for more supported platforms. - * * @usage * ```typescript * import { Keychain } from '@awesome-cordova-plugins/keychain/ngx'; diff --git a/src/@awesome-cordova-plugins/plugins/kommunicate/index.ts b/src/@awesome-cordova-plugins/plugins/kommunicate/index.ts index c804fc82..3adfc491 100644 --- a/src/@awesome-cordova-plugins/plugins/kommunicate/index.ts +++ b/src/@awesome-cordova-plugins/plugins/kommunicate/index.ts @@ -9,7 +9,6 @@ import { Observable } from 'rxjs'; * With the help of this plugin, you can easily add human + bot chat support functionality to you app. * Refer to: TODO: insert site link * For documentation: TODO: insert link - * * @usage * ```typescript * import { Kommunicate } from '@awesome-cordova-plugins/Kommunicate'; @@ -59,7 +58,7 @@ export class Kommunicate extends AwesomeCordovaNativePlugin { * }; * * @param kmUser {any} the user details - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() login(kmUser: any): Promise { @@ -69,7 +68,7 @@ export class Kommunicate extends AwesomeCordovaNativePlugin { /** * Register for push notification * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() registerPushNotification(): Promise { @@ -79,7 +78,7 @@ export class Kommunicate extends AwesomeCordovaNativePlugin { /** * Check if any user is logged in or not * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() isLoggedIn(): Promise { @@ -90,7 +89,7 @@ export class Kommunicate extends AwesomeCordovaNativePlugin { * Update the token for push notifications * * @param token {string} the user details - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() updatePushNotificationToken(token: string): Promise { @@ -100,7 +99,7 @@ export class Kommunicate extends AwesomeCordovaNativePlugin { /** * Launch the conversation screen (it contains all the existing conversations) * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() launchConversation(): Promise { @@ -116,7 +115,7 @@ export class Kommunicate extends AwesomeCordovaNativePlugin { * }; * * @param conversationObject {any} the channel key and other information - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() launchParticularConversation(conversationObject: any): Promise { @@ -127,8 +126,9 @@ export class Kommunicate extends AwesomeCordovaNativePlugin { * Start a new conversation, details about the conversation to be passed as parameters * * @deprecated + * @param conversationParams * @param converationParams {any} the user details - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() startNewConversation(conversationParams: any): Promise { @@ -139,7 +139,7 @@ export class Kommunicate extends AwesomeCordovaNativePlugin { * Process push notifications * * @param data {any} the user details - * @return {boolean} Returns true/false + * @returns {boolean} Returns true/false */ @Cordova({ sync: true }) processPushNotification(data: any): boolean { @@ -149,7 +149,7 @@ export class Kommunicate extends AwesomeCordovaNativePlugin { /** * Logout the current user * - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() logout(): Promise { @@ -161,7 +161,7 @@ export class Kommunicate extends AwesomeCordovaNativePlugin { * * @deprecated * @param data {any} the user details - * @return {Promise} Returns a promise + * @returns {Promise} Returns a promise */ @Cordova() startSingleChat(data: any): Promise { @@ -178,7 +178,8 @@ export class Kommunicate extends AwesomeCordovaNativePlugin { * }; * * @param conversationObject {any} the user details - * @return {Promise} Returns a promise + * @param converationObject + * @returns {Promise} Returns a promise */ @Cordova() conversationBuilder(converationObject: any): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/launch-navigator/index.ts b/src/@awesome-cordova-plugins/plugins/launch-navigator/index.ts index f4ed6b12..3a52fc28 100644 --- a/src/@awesome-cordova-plugins/plugins/launch-navigator/index.ts +++ b/src/@awesome-cordova-plugins/plugins/launch-navigator/index.ts @@ -5,6 +5,7 @@ export interface PromptsOptions { /** * a function to pass the user's decision whether to remember their choice of app. * This will be passed a single boolean value indicating the user's decision. + * * @param rememberChoice */ callback?: (rememberChoice: boolean) => void; @@ -50,6 +51,7 @@ export interface RememberChoiceOptions { * a function which asks the user whether to remember their choice of app. * If this is defined, then the default dialog prompt will not be shown, allowing for a custom UI for asking the user. * This will be passed a callback function which should be invoked with a single boolean argument which indicates the user's decision to remember their choice. + * * @param callback */ promptFn?: (callback: (rememberChoice: boolean) => void) => void; @@ -186,18 +188,21 @@ export interface LaunchNavigatorOptions { export interface UserChoice { /** * Indicates whether a user choice exists for a preferred navigator app. + * * @param callback - function to pass result to: will receive a boolean argument. */ exists: (callback: (exists: boolean) => void) => void; /** * Returns current user choice of preferred navigator app. + * * @param callback - function to pass result to: will receive a string argument indicating the app, which is a constant in `launchnavigator.APP`. */ get: (callback: (app: string) => void) => void; /** * Sets the current user choice of preferred navigator app. + * * @param app - app to set as preferred choice as a constant in `launchnavigator.APP`. * @param callback - function to call once operation is complete. */ @@ -205,6 +210,7 @@ export interface UserChoice { /** * Clears the current user choice of preferred navigator app. + * * @param callback - function to call once operation is complete. */ clear: (callback: () => void) => void; @@ -213,18 +219,21 @@ export interface UserChoice { export interface UserPrompted { /** * Indicates whether user has already been prompted whether to remember their choice a preferred navigator app. + * * @param callback - function to pass result to: will receive a boolean argument. */ get: (callback: (exists: boolean) => void) => void; /** * Sets flag indicating user has already been prompted whether to remember their choice a preferred navigator app. + * * @param callback - function to call once operation is complete. */ set: (callback: () => void) => void; /** * Clears flag which indicates if user has already been prompted whether to remember their choice a preferred navigator app. + * * @param callback - function to call once operation is complete. */ clear: (callback: () => void) => void; @@ -239,7 +248,6 @@ export interface AppSelection { * @name Launch Navigator * @description * Requires Cordova plugin: uk.co.workingedge.phonegap.plugin.launchnavigator. For more info, please see the [LaunchNavigator plugin docs](https://github.com/dpa99c/phonegap-launch-navigator). - * * @usage * Please refer to the plugin's repo for detailed usage. This docs page only explains the Native wrapper. * @@ -308,6 +316,7 @@ export class LaunchNavigator extends AwesomeCordovaNativePlugin { /** * Launches navigator app + * * @param destination {string|number[]} Location name or coordinates (as string or array) * @param options {LaunchNavigatorOptions} * @returns {Promise} @@ -322,6 +331,7 @@ export class LaunchNavigator extends AwesomeCordovaNativePlugin { /** * Determines if the given app is installed and available on the current device. + * * @param app {string} * @returns {Promise} */ @@ -332,6 +342,7 @@ export class LaunchNavigator extends AwesomeCordovaNativePlugin { /** * Returns a list indicating which apps are installed and available on the current device. + * * @returns {Promise} */ @Cordova() @@ -341,6 +352,7 @@ export class LaunchNavigator extends AwesomeCordovaNativePlugin { /** * Returns the display name of the specified app. + * * @param app {string} * @returns {string} */ @@ -351,6 +363,7 @@ export class LaunchNavigator extends AwesomeCordovaNativePlugin { /** * Returns list of supported apps on a given platform. + * * @param platform {string} * @returns {string[]} */ @@ -361,6 +374,7 @@ export class LaunchNavigator extends AwesomeCordovaNativePlugin { /** * Indicates if an app on a given platform supports specification of transport mode. + * * @param app {string} specified as a string, you can use one of the constants, e.g `LaunchNavigator.APP.GOOGLE_MAPS` * @param platform {string} * @returns {boolean} @@ -372,6 +386,7 @@ export class LaunchNavigator extends AwesomeCordovaNativePlugin { /** * Returns the list of transport modes supported by an app on a given platform. + * * @param app {string} * @param platform {string} * @returns {string[]} @@ -393,6 +408,7 @@ export class LaunchNavigator extends AwesomeCordovaNativePlugin { /** * Indicates if an app on a given platform supports specification of start location. + * * @param app {string} * @param platform {string} * @returns {boolean} @@ -415,6 +431,7 @@ export class LaunchNavigator extends AwesomeCordovaNativePlugin { /** * Indicates if an app on a given platform supports specification of launch mode. * Note that currently only Google Maps on Android does. + * * @param app {string} * @param platform {string} * @returns {boolean} diff --git a/src/@awesome-cordova-plugins/plugins/launch-review/index.ts b/src/@awesome-cordova-plugins/plugins/launch-review/index.ts index c17781b8..ecbca8c0 100644 --- a/src/@awesome-cordova-plugins/plugins/launch-review/index.ts +++ b/src/@awesome-cordova-plugins/plugins/launch-review/index.ts @@ -9,7 +9,6 @@ import { Observable } from 'rxjs'; * Assists in leaving user reviews/ratings in the App Stores. * - Launches the platform's App Store page for the current app in order for the user to leave a review. * - On iOS (10.3 and above) invokes the native in-app rating dialog which allows a user to rate your app without needing to open the App Store. - * * @usage * ```typescript * import { LaunchReview } from '@awesome-cordova-plugins/launch-review/ngx'; @@ -38,6 +37,7 @@ import { Observable } from 'rxjs'; export class LaunchReview extends AwesomeCordovaNativePlugin { /** * Launches App Store on current platform in order to leave a review for given app. + * * @param appId {string} - (optional) the platform-specific app ID to use to open the page in the store app. * If not specified, the plugin will use the app ID for the app in which the plugin is contained. * On Android this is the full package name of the app. For example, for Google Maps: `com.google.android.apps.maps` @@ -56,6 +56,7 @@ export class LaunchReview extends AwesomeCordovaNativePlugin { * - First: after `LaunchReview.rating()` is called and the request to show the dialog is successful. Will be passed the value `requested`. * - Second: if and when the Rating dialog is actually displayed. Will be passed the value `shown`. * - Third: if and when the Rating dialog is dismissed. Will be passed the value `dismissed`. + * * @returns {Observable} */ @Cordova({ observable: true }) @@ -66,6 +67,7 @@ export class LaunchReview extends AwesomeCordovaNativePlugin { /** * Indicates if the current platform/version supports in-app ratings dialog, i.e. calling LaunchReview.rating(). * Will return true if current platform is iOS 10.3 or above. + * * @returns {boolean} */ @Cordova({ platforms: ['Android', 'iOS'], sync: true }) diff --git a/src/@awesome-cordova-plugins/plugins/line-login/index.ts b/src/@awesome-cordova-plugins/plugins/line-login/index.ts index 76eaaa5c..8cbb59a2 100644 --- a/src/@awesome-cordova-plugins/plugins/line-login/index.ts +++ b/src/@awesome-cordova-plugins/plugins/line-login/index.ts @@ -46,7 +46,6 @@ export interface LineLoginAccessToken { * @name Line Login * @description * The function login, logs out, acquires, verifies, and refreshes the access token. The version of LineSDK you are using is as follows. - * * @usage * ```typescript * import { LineLogin } from '@awesome-cordova-plugins/line-login/ngx'; @@ -64,12 +63,10 @@ export interface LineLoginAccessToken { * .catch(error => console.log(error)) * * ``` - * * @interfaces * LineLoginParams * LineLoginProfile * LineLoginAccessToken - * */ @Plugin({ pluginName: 'LineLogin', @@ -85,8 +82,9 @@ export interface LineLoginAccessToken { export class LineLogin extends AwesomeCordovaNativePlugin { /** * Initialize + * * @param param LineLoginParams - * @return {Promise} + * @returns {Promise} */ @Cordova() initialize(param: LineLoginParams): Promise { @@ -95,7 +93,8 @@ export class LineLogin extends AwesomeCordovaNativePlugin { /** * Login - * @return {Promise} + * + * @returns {Promise} */ @Cordova() login(): Promise { @@ -105,7 +104,8 @@ export class LineLogin extends AwesomeCordovaNativePlugin { /** * Login with Web * (iOS only) - * @return {Promise} + * + * @returns {Promise} */ @Cordova() loginWeb(): Promise { @@ -114,7 +114,8 @@ export class LineLogin extends AwesomeCordovaNativePlugin { /** * Logout - * @return {Promise} + * + * @returns {Promise} */ @Cordova() logout(): Promise { @@ -123,7 +124,8 @@ export class LineLogin extends AwesomeCordovaNativePlugin { /** * Get Access Token - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getAccessToken(): Promise { @@ -132,7 +134,8 @@ export class LineLogin extends AwesomeCordovaNativePlugin { /** * Verify AccessToken - * @return {Promise} + * + * @returns {Promise} */ @Cordova() verifyAccessToken(): Promise { @@ -141,7 +144,8 @@ export class LineLogin extends AwesomeCordovaNativePlugin { /** * Refresh Access Token - * @return {Promise} + * + * @returns {Promise} */ @Cordova() refreshAccessToken(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/local-backup/index.ts b/src/@awesome-cordova-plugins/plugins/local-backup/index.ts index 3030921d..80bfa515 100644 --- a/src/@awesome-cordova-plugins/plugins/local-backup/index.ts +++ b/src/@awesome-cordova-plugins/plugins/local-backup/index.ts @@ -5,7 +5,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl * @name LocalBackup * @description * This plugin to create local backup - * * @usage * ```typescript * import { LocalBackup } from '@awesome-cordova-plugins/local-backup/ngx'; diff --git a/src/@awesome-cordova-plugins/plugins/local-notifications/index.ts b/src/@awesome-cordova-plugins/plugins/local-notifications/index.ts index 7365367b..8cd8af29 100755 --- a/src/@awesome-cordova-plugins/plugins/local-notifications/index.ts +++ b/src/@awesome-cordova-plugins/plugins/local-notifications/index.ts @@ -69,7 +69,7 @@ export interface ILocalNotificationEvery { } export interface ILocalNotificationTrigger { - /** ***** FIX ***** */ + /** ***** FIX */ /** * The date and time when the system should deliver the local notification. If the specified value is nil or is a date in the past, the local notification is delivered immediately. @@ -77,7 +77,7 @@ export interface ILocalNotificationTrigger { */ at?: Date; - /** ***** TIMESPAN ***** */ + /** ***** TIMESPAN */ /** * Amount of units @@ -89,7 +89,7 @@ export interface ILocalNotificationTrigger { */ unit?: ELocalNotificationTriggerUnit; - /** ***** REPEAT/MATCH ***** */ + /** ***** REPEAT/MATCH */ /** * Amount of units @@ -118,7 +118,7 @@ export interface ILocalNotificationTrigger { */ after?: Date; - /** ***** LOCATION ***** */ + /** ***** LOCATION */ /** * IOS ONLY @@ -481,7 +481,6 @@ export interface ILocalNotification { * @name Local Notifications * @description * This plugin allows you to display local notifications on the device - * * @usage * ```typescript * import { LocalNotifications } from '@awesome-cordova-plugins/local-notifications/ngx'; @@ -537,6 +536,7 @@ export interface ILocalNotification { export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Informs if the app has the permission to show notifications. + * * @returns {Promise} */ @Cordova() @@ -546,6 +546,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Request permission to show notifications if not already granted. + * * @returns {Promise} */ @Cordova() @@ -555,6 +556,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Schedules a single or multiple notifications + * * @param options {Notification | ILocalNotification[]} optional */ @Cordova({ @@ -564,6 +566,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Updates a previously scheduled notification. Must include the id in the options parameter. + * * @param options {ILocalNotification} optional */ @Cordova({ @@ -573,6 +576,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Clears single or multiple notifications + * * @param notificationId {any} A single notification id, or an array of notification ids. * @returns {Promise} Returns a promise when the notification had been cleared */ @@ -583,6 +587,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Clears all notifications + * * @returns {Promise} Returns a promise when all notifications have cleared */ @Cordova() @@ -592,6 +597,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Cancels single or multiple notifications + * * @param notificationId {any} A single notification id, or an array of notification ids. * @returns {Promise} Returns a promise when the notification is canceled */ @@ -602,6 +608,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Cancels all notifications + * * @returns {Promise} Returns a promise when all notifications are canceled */ @Cordova() @@ -611,6 +618,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Checks presence of a notification + * * @param notificationId {number} * @returns {Promise} */ @@ -621,6 +629,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Checks is a notification is scheduled + * * @param notificationId {number} * @returns {Promise} */ @@ -631,6 +640,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Checks if a notification is triggered + * * @param notificationId {number} * @returns {Promise} */ @@ -641,6 +651,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Check if a notification has a given type. + * * @param {number} id The ID of the notification. * @param {string} type The type of the notification. * @returns {Promise} @@ -652,6 +663,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Get the type (triggered, scheduled) for the notification. + * * @param {number} id The ID of the notification. */ @Cordova() @@ -661,6 +673,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Get all the notification ids + * * @returns {Promise>} */ @Cordova() @@ -670,6 +683,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Get the ids of scheduled notifications + * * @returns {Promise} Returns a promise */ @Cordova() @@ -679,6 +693,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Get the ids of triggered notifications + * * @returns {Promise>} */ @Cordova() @@ -688,6 +703,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Get a notification object + * * @param notificationId {any} The id of the notification to get * @returns {Promise} */ @@ -698,6 +714,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Get all notification objects + * * @returns {Promise} */ @Cordova() @@ -707,6 +724,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Get a scheduled notification object + * * @param notificationId {any} The id of the notification to get * @returns {Promise} */ @@ -717,6 +735,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Get a triggered notification object + * * @param notificationId The id of the notification to get * @returns {Promise} */ @@ -727,6 +746,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Adds a group of actions + * * @param groupId The id of the action group * @param actions The actions of this group * @returns {Promise} @@ -738,6 +758,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Removes a group of actions + * * @param groupId The id of the action group * @returns {Promise} */ @@ -748,6 +769,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Checks if a group of actions is defined + * * @param groupId The id of the action group * @returns {Promise} Whether the group is defined */ @@ -758,6 +780,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Gets the (platform specific) default settings. + * * @returns {Promise} An object with all default settings */ @Cordova({ @@ -769,6 +792,8 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Overwrites the (platform specific) default settings. + * + * @param defaults * @returns {Promise} */ @Cordova({ @@ -780,6 +805,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Get all scheduled notification objects + * * @returns {Promise>} */ @Cordova() @@ -789,6 +815,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Get all triggered notification objects + * * @returns {Promise>} */ @Cordova() @@ -798,8 +825,9 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Sets a callback for a specific event + * * @param eventName {string} The name of the event. Available events: schedule, trigger, click, update, clear, clearall, cancel, cancelall. Custom event names are possible for actions - * @return {Observable} + * @returns {Observable} */ @Cordova({ observable: true, @@ -812,6 +840,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Not an official interface, however its possible to manually fire events. + * * @param eventName The name of the event. Available events: schedule, trigger, click, update, clear, clearall, cancel, cancelall. Custom event names are possible for actions * @param args Optional arguments */ @@ -822,6 +851,7 @@ export class LocalNotifications extends AwesomeCordovaNativePlugin { /** * Fire queued events once the device is ready and all listeners are registered. + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/location-accuracy/index.ts b/src/@awesome-cordova-plugins/plugins/location-accuracy/index.ts index 69839070..a6fa2e81 100644 --- a/src/@awesome-cordova-plugins/plugins/location-accuracy/index.ts +++ b/src/@awesome-cordova-plugins/plugins/location-accuracy/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Location Accuracy * @description * This Cordova/Phonegap plugin for Android and iOS to request enabling/changing of Location Services by triggering a native dialog from within the app, avoiding the need for the user to leave your app to change location settings manually. - * * @usage * ```typescript * import { LocationAccuracy } from '@awesome-cordova-plugins/location-accuracy/ngx'; @@ -39,72 +38,86 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class LocationAccuracy extends AwesomeCordovaNativePlugin { /** * Convenience constant + * * @type {number} */ REQUEST_PRIORITY_NO_POWER = 0; /** * Convenience constant + * * @type {number} */ REQUEST_PRIORITY_LOW_POWER = 1; /** * Convenience constant + * * @type {number} */ REQUEST_PRIORITY_BALANCED_POWER_ACCURACY = 2; /** * Convenience constant + * * @type {number} */ REQUEST_PRIORITY_HIGH_ACCURACY = 3; /** * Convenience constant + * * @type {number} */ SUCCESS_SETTINGS_SATISFIED = 0; /** * Convenience constant + * * @type {number} */ SUCCESS_USER_AGREED = 1; /** * Convenience constant + * * @type {number} */ ERROR_ALREADY_REQUESTING = -1; /** * Convenience constant + * * @type {number} */ ERROR_INVALID_ACTION = 0; /** * Convenience constant + * * @type {number} */ ERROR_INVALID_ACCURACY = 1; /** * Convenience constant + * * @type {number} */ ERROR_EXCEPTION = 1; /** * Convenience constant + * * @type {number} */ ERROR_CANNOT_CHANGE_ACCURACY = 3; /** * Convenience constant + * * @type {number} */ ERROR_USER_DISAGREED = 4; /** * Convenience constant + * * @type {number} */ ERROR_GOOGLE_API_CONNECTION_FAILED = 4; /** * Indicates if you can request accurate location + * * @returns {Promise} Returns a promise that resovles with a boolean that indicates if you can request accurate location */ @Cordova() @@ -114,6 +127,7 @@ export class LocationAccuracy extends AwesomeCordovaNativePlugin { /** * Indicates if a request is currently in progress + * * @returns {Promise} Returns a promise that resolves with a boolean that indicates if a request is currently in progress */ @Cordova() @@ -123,6 +137,7 @@ export class LocationAccuracy extends AwesomeCordovaNativePlugin { /** * Requests accurate location + * * @param accuracy {number} Accuracy, from 0 to 4. You can use the static properties of this class that start with REQUEST_PRIORITY_ * @returns {Promise} Returns a promise that resolves on success and rejects if an error occurred */ diff --git a/src/@awesome-cordova-plugins/plugins/lottie-splash-screen/index.ts b/src/@awesome-cordova-plugins/plugins/lottie-splash-screen/index.ts index d4eb7583..56810a13 100644 --- a/src/@awesome-cordova-plugins/plugins/lottie-splash-screen/index.ts +++ b/src/@awesome-cordova-plugins/plugins/lottie-splash-screen/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Lottie Splash Screen * @description * Cordova plugin to show bodymovin/Lottie animations as the splash screen with Airbnb's Lottie wrapper - * * @usage * ```typescript * import { LottieSplashScreen } from '@awesome-cordova-plugins/lottie-splash-screen/ngx'; @@ -35,6 +34,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class LottieSplashScreen extends AwesomeCordovaNativePlugin { /** * This function shows a Lottie splash screen. If no arguments are given, it defaults to the config.xml values, however you can pass (new) options here to change the behavior on runtime. (For easier reading the TypeScript notation is used) + * * @param location {string} Location of the Lottie JSON file that should be loaded. * @param remote {number} Toggles Lottie's remote mode which allows files to be downloaded/displayed from URLs. Example: * @param width {number} Width of the container that's rendering the Lottie animation diff --git a/src/@awesome-cordova-plugins/plugins/media-capture/index.ts b/src/@awesome-cordova-plugins/plugins/media-capture/index.ts index f86bf358..e7b21255 100644 --- a/src/@awesome-cordova-plugins/plugins/media-capture/index.ts +++ b/src/@awesome-cordova-plugins/plugins/media-capture/index.ts @@ -30,6 +30,7 @@ export interface MediaFile { /** * Retrieves the format information of the media file. + * * @param {Function} successCallback * @param {Function} errorCallback */ @@ -119,7 +120,6 @@ export interface ConfigurationData { * This plugin provides access to the device's audio, image, and video capture capabilities. * * Requires Cordova plugin: `cordova-plugin-media-capture`. For more info, please see the [Media Capture plugin docs](https://github.com/apache/cordova-plugin-media-capture). - * * @usage * ```typescript * import { MediaCapture, MediaFile, CaptureError, CaptureImageOptions } from '@awesome-cordova-plugins/media-capture/ngx'; @@ -158,6 +158,7 @@ export interface ConfigurationData { export class MediaCapture extends AwesomeCordovaNativePlugin { /** * The recording image sizes and formats supported by the device. + * * @returns {ConfigurationData[]} */ @CordovaProperty() @@ -165,6 +166,7 @@ export class MediaCapture extends AwesomeCordovaNativePlugin { /** * The audio recording formats supported by the device. + * * @returns {ConfigurationData[]} */ @CordovaProperty() @@ -172,6 +174,7 @@ export class MediaCapture extends AwesomeCordovaNativePlugin { /** * The recording video resolutions and formats supported by the device. + * * @returns {ConfigurationData[]} */ @CordovaProperty() @@ -179,6 +182,7 @@ export class MediaCapture extends AwesomeCordovaNativePlugin { /** * Start the audio recorder application and return information about captured audio clip files. + * * @param options * @returns {Promise} */ @@ -191,6 +195,7 @@ export class MediaCapture extends AwesomeCordovaNativePlugin { /** * Start the camera application and return information about captured image files. + * * @param options * @returns {Promise} */ @@ -203,6 +208,7 @@ export class MediaCapture extends AwesomeCordovaNativePlugin { /** * Start the video recorder application and return information about captured video clip files. + * * @param options * @returns {Promise} */ @@ -215,6 +221,7 @@ export class MediaCapture extends AwesomeCordovaNativePlugin { /** * is fired if the capture call is successful + * * @returns {Observable} */ @Cordova({ @@ -227,6 +234,7 @@ export class MediaCapture extends AwesomeCordovaNativePlugin { /** * is fired if the capture call is unsuccessful + * * @returns {Observable} */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/media/index.ts b/src/@awesome-cordova-plugins/plugins/media/index.ts index d1549c64..d8cfe46c 100644 --- a/src/@awesome-cordova-plugins/plugins/media/index.ts +++ b/src/@awesome-cordova-plugins/plugins/media/index.ts @@ -61,6 +61,7 @@ export class MediaObject { /** * Get the current amplitude of the current recording. + * * @returns {Promise} Returns a promise with the amplitude of the current recording */ @CordovaInstance() @@ -70,6 +71,7 @@ export class MediaObject { /** * Get the current position within an audio file. Also updates the Media object's position parameter. + * * @returns {Promise} Returns a promise with the position of the current recording */ @CordovaInstance() @@ -79,6 +81,7 @@ export class MediaObject { /** * Get the duration of an audio file in seconds. If the duration is unknown, it returns a value of -1. + * * @returns {number} Returns a promise with the duration of the current recording */ @CordovaInstance({ sync: true }) @@ -88,6 +91,10 @@ export class MediaObject { /** * Starts or resumes playing an audio file. + * + * @param iosOptions + * @param iosOptions.numberOfLoops + * @param iosOptions.playAudioWhenScreenIsLocked */ @CordovaInstance({ sync: true }) play(iosOptions?: { numberOfLoops?: number; playAudioWhenScreenIsLocked?: boolean }): void {} @@ -106,6 +113,7 @@ export class MediaObject { /** * Sets the current position within an audio file. + * * @param {number} milliseconds The time position you want to set for the current audio file */ @CordovaInstance({ sync: true }) @@ -113,6 +121,7 @@ export class MediaObject { /** * Set the volume for an audio file. + * * @param volume {number} The volume to set for playback. The value must be within the range of 0.0 to 1.0. */ @CordovaInstance({ sync: true }) @@ -188,7 +197,6 @@ export type MediaErrorCallback = (error: MediaError) => void; * @premier media * @description * This plugin provides the ability to record and play back audio files on a device. - * * @usage * ```typescript * import { Media, MediaObject } from '@awesome-cordova-plugins/media/ngx'; @@ -332,8 +340,9 @@ export class Media extends AwesomeCordovaNativePlugin { /** * Open a media file + * * @param src {string} A URI containing the audio content. - * @return {MediaObject} + * @returns {MediaObject} */ create(src: string): MediaObject { let instance: any; diff --git a/src/@awesome-cordova-plugins/plugins/metrix/index.ts b/src/@awesome-cordova-plugins/plugins/metrix/index.ts index 2d27c0fd..c185e98c 100644 --- a/src/@awesome-cordova-plugins/plugins/metrix/index.ts +++ b/src/@awesome-cordova-plugins/plugins/metrix/index.ts @@ -150,7 +150,6 @@ export enum MetrixAttributionStatus { * This is the Ionic Cordova SDK of Metrix™. You can read more about Metrix™ at metrix.ir. * * Requires Cordova plugin: `ir.metrix.sdk`. For more info, please see the [Metrix Cordova SDK](https://github.com/metrixorg/MetrixSDK-CordovaPlugin) - * * @usage * ```typescript * import { Metrix, MetrixConfig } from '@awesome-cordova-plugins/metrix'; @@ -182,6 +181,7 @@ export enum MetrixAttributionStatus { export class Metrix extends AwesomeCordovaNativePlugin { /** * This method initializes Metrix SDK + * * @param {MetrixConfig} config MetrixConfig object used as starting options */ @Cordova({ sync: true }) @@ -189,7 +189,8 @@ export class Metrix extends AwesomeCordovaNativePlugin { /** * Function used to get Session Number - * @return {Promise} Returns a promise with session number value + * + * @returns {Promise} Returns a promise with session number value */ @Cordova() getSessionNum(): Promise { @@ -198,21 +199,24 @@ export class Metrix extends AwesomeCordovaNativePlugin { /** * This method tracks an event + * * @param {string} slug the slug of the event to be tracked - * @param {Map | object} attributes optional attributes of the event to be tracked + * @param {Map | object} attributes optional attributes of the event to be tracked */ @Cordova({ sync: true }) - newEvent(slug: string, attributes?: Map | object): void {} + newEvent(slug: string, attributes?: Map | object): void {} /** * This method adds the provided attributes to all metrix events - * @param {Map | object} attributes the attributes to be added to all future events + * + * @param {Map | object} attributes the attributes to be added to all future events */ @Cordova({ sync: true }) - addUserAttributes(attributes: Map | object): void {} + addUserAttributes(attributes: Map | object): void {} /** * This method tracks a revenue + * * @param {string} slug the slug of the event to be tracked * @param {number} amount the amount of money gained by the revenue * @param {number} currency (OPTIONAL) currency of the amount @@ -223,6 +227,7 @@ export class Metrix extends AwesomeCordovaNativePlugin { /** * By making this call, the Metrix SDK will try to find if there is any new attribution info inside of the deep link and if any, it will be sent to the Metrix backend. + * * @param {string} url URL of the deeplink */ @Cordova({ sync: true }) diff --git a/src/@awesome-cordova-plugins/plugins/mixpanel/index.ts b/src/@awesome-cordova-plugins/plugins/mixpanel/index.ts index 2ca7e2ca..9183f81b 100644 --- a/src/@awesome-cordova-plugins/plugins/mixpanel/index.ts +++ b/src/@awesome-cordova-plugins/plugins/mixpanel/index.ts @@ -1,13 +1,12 @@ import { Injectable } from '@angular/core'; import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-plugins/core'; -declare var mixpanel: any; +declare let mixpanel: any; /** * @name Mixpanel * @description * Cordova Plugin that wraps Mixpanel SDK for Android and iOS - * * @usage * ```typescript * import { Mixpanel } from '@awesome-cordova-plugins/mixpanel/ngx'; @@ -35,6 +34,7 @@ declare var mixpanel: any; export class Mixpanel extends AwesomeCordovaNativePlugin { /** * If originalId is omitted, aliasId will be used as originalId. + * * @param aliasId {string} * @param originalId {string} * @returns {Promise} @@ -63,6 +63,7 @@ export class Mixpanel extends AwesomeCordovaNativePlugin { /** * The usePeople parameter is used for the iOS Mixpanel SDK. + * * @param distinctId {string} * @param usePeople {boolean} * @returns {Promise} @@ -168,7 +169,7 @@ export class MixpanelPeople extends AwesomeCordovaNativePlugin { /** * * @param appendObject {any} - * @return {Promise} + * @returns {Promise} */ @Cordova() append(appendObject: any): Promise { @@ -177,7 +178,7 @@ export class MixpanelPeople extends AwesomeCordovaNativePlugin { /** * - * @return {Promise} + * @returns {Promise} */ @Cordova() deleteUser(): Promise { @@ -187,7 +188,7 @@ export class MixpanelPeople extends AwesomeCordovaNativePlugin { /** * * @param distinctId {string} - * @return {Promise} + * @returns {Promise} * @deprecated since 2016-11-21 - Use Mixpanel.identify instead. */ @Cordova() @@ -198,7 +199,7 @@ export class MixpanelPeople extends AwesomeCordovaNativePlugin { /** * * @param peopleProperties {string} - * @return {Promise} + * @returns {Promise} */ @Cordova() increment(peopleProperties: any): Promise { @@ -208,7 +209,7 @@ export class MixpanelPeople extends AwesomeCordovaNativePlugin { /** * * @param pushId - * @return {Promise} + * @returns {Promise} */ @Cordova() setPushId(pushId: string): Promise { @@ -218,7 +219,7 @@ export class MixpanelPeople extends AwesomeCordovaNativePlugin { /** * * @param peopleProperties - * @return {Promise} + * @returns {Promise} */ @Cordova() set(peopleProperties: any): Promise { @@ -228,7 +229,7 @@ export class MixpanelPeople extends AwesomeCordovaNativePlugin { /** * * @param peopleProperties {any} - * @return {Promise} + * @returns {Promise} */ @Cordova() setOnce(peopleProperties: any): Promise { @@ -239,7 +240,7 @@ export class MixpanelPeople extends AwesomeCordovaNativePlugin { * * @param amount {number} * @param chargeProperties - * @return {Promise} + * @returns {Promise} */ @Cordova() trackCharge(amount: number, chargeProperties: any): Promise { @@ -249,7 +250,7 @@ export class MixpanelPeople extends AwesomeCordovaNativePlugin { /** * * @param propertiesArray - * @return {Promise} + * @returns {Promise} */ @Cordova() unset(propertiesArray: string[]): Promise { @@ -259,7 +260,7 @@ export class MixpanelPeople extends AwesomeCordovaNativePlugin { /** * * @param unionObject {any} - * @return {Promise} + * @returns {Promise} */ @Cordova() union(unionObject: any): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/mlkit-translate/index.ts b/src/@awesome-cordova-plugins/plugins/mlkit-translate/index.ts index 027f8ae8..70365c1c 100644 --- a/src/@awesome-cordova-plugins/plugins/mlkit-translate/index.ts +++ b/src/@awesome-cordova-plugins/plugins/mlkit-translate/index.ts @@ -21,7 +21,6 @@ export interface LanguageModel { * @name MLKitTranslate * @description * Plugin that implements MLKit Translation and Language Identification features. - * * @usage * ```typescript * import { MLKitTranslate } from '@awesome-cordova-plugins/ml-kit-translate'; @@ -51,10 +50,11 @@ export class MLKitTranslate extends AwesomeCordovaNativePlugin { /** * Translates text from one language to another. Requires the source and target languages need to be downloaded. * If not the languages are downloaded in the background automatically. + * * @param text {string} text to be translated * @param targetLanguage {string} BCP-47 language code of the language to translate to * @param sourceLanguage {string=} (optional) BCP-47 language code of the language to translate to. If not provided, source language is inferred from text - * @return {Promise} Returns a promise that resolves with the translated text + * @returns {Promise} Returns a promise that resolves with the translated text */ @Cordova() translate(text: string, targetLanguage: string, sourceLanguage?: string): Promise { @@ -63,8 +63,9 @@ export class MLKitTranslate extends AwesomeCordovaNativePlugin { /** * Determines the language of a string of text. + * * @param text {string} text to be translated - * @return {Promise} Returns a promise that resolves with the identified language + * @returns {Promise} Returns a promise that resolves with the identified language */ @Cordova() identifyLanguage(text: string): Promise { @@ -73,7 +74,8 @@ export class MLKitTranslate extends AwesomeCordovaNativePlugin { /** * List of language models that have been downloaded to the device. - * @return {Promise} Returns a promise that resolves with an array of languages that have been downloaded. + * + * @returns {Promise} Returns a promise that resolves with an array of languages that have been downloaded. */ @Cordova() getDownloadedModels(): Promise { @@ -82,7 +84,8 @@ export class MLKitTranslate extends AwesomeCordovaNativePlugin { /** * List of language models that can be downloaded. - * @return {Promise} Returns a promise that resolves with an array of possible languages that can be downloaded. + * + * @returns {Promise} Returns a promise that resolves with an array of possible languages that can be downloaded. */ @Cordova() getAvailableModels(): Promise { @@ -91,8 +94,9 @@ export class MLKitTranslate extends AwesomeCordovaNativePlugin { /** * Downloads a specified language model. + * * @param code {string} BCP-47 language code of the language to download - * @return {Promise} Returns a promise that resolves with the downloaded language. + * @returns {Promise} Returns a promise that resolves with the downloaded language. */ @Cordova() downloadModel(code: string): Promise { @@ -101,8 +105,9 @@ export class MLKitTranslate extends AwesomeCordovaNativePlugin { /** * Deletes a specified language model. + * * @param code {string} BCP-47 language code of the language to delete - * @return {Promise} Returns a promise that resolves with the deleted language. + * @returns {Promise} Returns a promise that resolves with the deleted language. */ @Cordova() deleteModel(code: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/mobile-messaging/index.ts b/src/@awesome-cordova-plugins/plugins/mobile-messaging/index.ts index 2733aefe..29f46dad 100644 --- a/src/@awesome-cordova-plugins/plugins/mobile-messaging/index.ts +++ b/src/@awesome-cordova-plugins/plugins/mobile-messaging/index.ts @@ -182,7 +182,6 @@ export class DefaultMessageStorage { * This document describes library integration steps for your Cordova project. * * For more info see [Cordova plugin docs](https://github.com/infobip/mobile-messaging-cordova-plugin) - * * @usage * ```typescript * import { MobileMessaging } from '@awesome-cordova-plugins/mobile-messaging/ngx'; @@ -228,6 +227,8 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin { * * @name init * @param config. Configuration for Mobile Messaging + * @param config + * @param onInitError * @param {Function} onInitError. Error callback */ @Cordova({ sync: true }) @@ -259,7 +260,8 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin { * Un register from MobileMessaging library event. * * @name unregister - * @param {String} eventName + * @param {string} eventName + * @param event * @param {Function} handler will be unregistered from event */ @Cordova({ @@ -289,6 +291,7 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin { * "dateAttribute": "2020-02-26T09:41:57Z", * "booleanAttribute": true * } + * @param event * } */ @Cordova({ @@ -313,6 +316,7 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin { * "booleanAttribute": true * } * } + * @param event * @param {Function} callback will be called on result, you have to handle error and do retries yourself */ @Cordova({ @@ -326,6 +330,7 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin { * Saves user data to the server. * * @name saveUser + * @param userData * @param {Object} userData. An object containing user data */ @Cordova() @@ -357,6 +362,7 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin { * Saves installation to the server. * * @name saveInstallation + * @param installation * @param {Object} installation. An object containing installation data */ @Cordova() @@ -388,8 +394,8 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin { * Sets any installation as primary for this user. * * @name setInstallationAsPrimary - * @param {String} pushRegistrationId of an installation - * @param {Boolean} primary or not + * @param {string} pushRegistrationId of an installation + * @param {boolean} primary or not */ @Cordova() setInstallationAsPrimary(pushRegistrationId: string, primary: boolean): Promise { @@ -400,6 +406,7 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin { * Performs personalization of the current installation on the platform. * * @name personalize + * @param context * @param {Object} context. An object containing user identity information as well as additional user attributes. */ @Cordova() @@ -420,7 +427,7 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin { /** * Performs depersonalization of the installation referenced by pushRegistrationId. * - * @param {String} pushRegistrationId of the remote installation to depersonalize + * @param {string} pushRegistrationId of the remote installation to depersonalize */ @Cordova() depersonalizeInstallation(pushRegistrationId: string): Promise { @@ -442,7 +449,7 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin { * Displays built-in error dialog so that user can resolve errors during sdk initialization. * * @name showDialogForError - * @param {Number} errorCode to display dialog for + * @param {number} errorCode to display dialog for */ @Cordova() showDialogForError(errorCode: number): Promise { @@ -458,6 +465,7 @@ export class MobileMessaging extends AwesomeCordovaNativePlugin { * Displays chat view. * * @name showChat + * @param config * @param {ChatConfig} chat config */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/multiple-document-picker/index.ts b/src/@awesome-cordova-plugins/plugins/multiple-document-picker/index.ts index f7bd8d67..16bc77ae 100644 --- a/src/@awesome-cordova-plugins/plugins/multiple-document-picker/index.ts +++ b/src/@awesome-cordova-plugins/plugins/multiple-document-picker/index.ts @@ -9,7 +9,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl * @name Multiple Documents Picker * @description * This plugin allows users to pick multiple documents/images at once - * * @usage * ```typescript * import { MultipleDocumentsPicker } from '@awesome-cordova-plugins/multiple-document-picker/ngx'; @@ -37,8 +36,9 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl export class MultipleDocumentsPicker extends AwesomeCordovaNativePlugin { /** * This function allow user to show native file picker + * * @param type {number} To pick type of files: for images send 1, for all files send 2 - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() pick(type: number): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/music-controls/index.ts b/src/@awesome-cordova-plugins/plugins/music-controls/index.ts index c88a7554..437e5255 100644 --- a/src/@awesome-cordova-plugins/plugins/music-controls/index.ts +++ b/src/@awesome-cordova-plugins/plugins/music-controls/index.ts @@ -35,7 +35,6 @@ export interface MusicControlsOptions { * Music controls for Cordova applications. * Display a 'media' notification with play/pause, previous, next buttons, allowing the user to control the play. * Handle also headset event (plug, unplug, headset button). - * * @usage * ```typescript * import { MusicControls } from '@awesome-cordova-plugins/music-controls/ngx'; @@ -157,6 +156,7 @@ export interface MusicControlsOptions { export class MusicControls extends AwesomeCordovaNativePlugin { /** * Create the media controls + * * @param options {MusicControlsOptions} * @returns {Promise} */ @@ -167,6 +167,7 @@ export class MusicControls extends AwesomeCordovaNativePlugin { /** * Destroy the media controller + * * @returns {Promise} */ @Cordova() @@ -176,6 +177,7 @@ export class MusicControls extends AwesomeCordovaNativePlugin { /** * Subscribe to the events of the media controller + * * @returns {Observable} */ @Cordova({ @@ -193,6 +195,7 @@ export class MusicControls extends AwesomeCordovaNativePlugin { /** * Toggle play/pause: + * * @param isPlaying {boolean} */ @Cordova() @@ -200,7 +203,10 @@ export class MusicControls extends AwesomeCordovaNativePlugin { /** * Update elapsed time, optionally toggle play/pause: + * * @param args {Object} + * @param args.elapsed + * @param args.isPlaying */ @Cordova({ platforms: ['iOS'], @@ -209,6 +215,7 @@ export class MusicControls extends AwesomeCordovaNativePlugin { /** * Toggle dismissable: + * * @param dismissable {boolean} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/native-audio/index.ts b/src/@awesome-cordova-plugins/plugins/native-audio/index.ts index e8caab6e..c9d29d69 100644 --- a/src/@awesome-cordova-plugins/plugins/native-audio/index.ts +++ b/src/@awesome-cordova-plugins/plugins/native-audio/index.ts @@ -40,6 +40,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class NativeAudio extends AwesomeCordovaNativePlugin { /** * Loads an audio file into memory. Optimized for short clips / single shots (up to five seconds). Cannot be stopped / looped. + * * @param id {string} unique ID for the audio file * @param assetPath {string} the relative path or absolute URL (inluding http://) to the audio asset. * @returns {Promise} @@ -51,6 +52,7 @@ export class NativeAudio extends AwesomeCordovaNativePlugin { /** * Loads an audio file into memory. Optimized for background music / ambient sound. Uses highlevel native APIs with a larger footprint. (iOS: AVAudioPlayer). Can be stopped / looped and used with multiple voices. Can be faded in and out using the delay parameter. + * * @param id {string} unique ID for the audio file * @param assetPath {string} the relative path or absolute URL (inluding http://) to the audio asset. * @param volume {number} the volume of the preloaded sound (0.1 to 1.0) @@ -65,6 +67,7 @@ export class NativeAudio extends AwesomeCordovaNativePlugin { /** * Plays an audio asset + * * @param id {string} unique ID for the audio file * @param completeCallback {Function} optional. Callback to be invoked when audio is done playing * @returns {Promise} @@ -79,6 +82,7 @@ export class NativeAudio extends AwesomeCordovaNativePlugin { /** * Stops playing an audio + * * @param id {string} unique ID for the audio file * @returns {Promise} */ @@ -89,8 +93,9 @@ export class NativeAudio extends AwesomeCordovaNativePlugin { /** * Loops an audio asset infinitely, this only works for complex assets + * * @param id {string} unique ID for the audio file - * @return {Promise} + * @returns {Promise} */ @Cordova() loop(id: string): Promise { @@ -99,6 +104,7 @@ export class NativeAudio extends AwesomeCordovaNativePlugin { /** * Unloads an audio file from memory + * * @param id {string} unique ID for the audio file * @returns {Promise} */ @@ -109,6 +115,7 @@ export class NativeAudio extends AwesomeCordovaNativePlugin { /** * Changes the volume for preloaded complex assets. + * * @param id {string} unique ID for the audio file * @param volume {number} the volume of the audio asset (0.1 to 1.0) * @returns {Promise} diff --git a/src/@awesome-cordova-plugins/plugins/native-geocoder/index.ts b/src/@awesome-cordova-plugins/plugins/native-geocoder/index.ts index ed10c4b2..8c5b1611 100644 --- a/src/@awesome-cordova-plugins/plugins/native-geocoder/index.ts +++ b/src/@awesome-cordova-plugins/plugins/native-geocoder/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Native Geocoder * @description * Cordova plugin for native forward and reverse geocoding - * * @usage * ```typescript * import { NativeGeocoder, NativeGeocoderResult, NativeGeocoderOptions } from '@awesome-cordova-plugins/native-geocoder/ngx'; @@ -42,10 +41,11 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class NativeGeocoder extends AwesomeCordovaNativePlugin { /** * Reverse geocode a given latitude and longitude to find location address + * * @param latitude {number} The latitude * @param longitude {number} The longitude * @param options {NativeGeocoderOptions} The options - * @return {Promise} + * @returns {Promise} */ @Cordova({ callbackOrder: 'reverse', @@ -60,9 +60,10 @@ export class NativeGeocoder extends AwesomeCordovaNativePlugin { /** * Forward geocode a given address to find coordinates + * * @param addressString {string} The address to be geocoded * @param options {NativeGeocoderOptions} The options - * @return {Promise} + * @returns {Promise} */ @Cordova({ callbackOrder: 'reverse', diff --git a/src/@awesome-cordova-plugins/plugins/native-keyboard/index.ts b/src/@awesome-cordova-plugins/plugins/native-keyboard/index.ts index b9f8ce9a..c812bd4d 100644 --- a/src/@awesome-cordova-plugins/plugins/native-keyboard/index.ts +++ b/src/@awesome-cordova-plugins/plugins/native-keyboard/index.ts @@ -174,8 +174,6 @@ export interface NativeKeyboardUpdateMessengerOptions { * @name Native Keyboard * @description * A cross platform WhatsApp / Messenger / Slack -style keyboard even. For your Cordova app. - * - * * @usage * ``` * import { NativeKeyboard } from '@awesome-cordova-plugins/native-keyboard/ngx'; @@ -204,6 +202,7 @@ export interface NativeKeyboardUpdateMessengerOptions { export class NativeKeyboard extends AwesomeCordovaNativePlugin { /** * Show messenger + * * @param options {NativeKeyboardOptions} */ @Cordova({ sync: true }) @@ -211,6 +210,7 @@ export class NativeKeyboard extends AwesomeCordovaNativePlugin { /** * Hide messenger + * * @param options {NativeKeyboardOptions} */ @Cordova({ sync: true }) @@ -218,7 +218,8 @@ export class NativeKeyboard extends AwesomeCordovaNativePlugin { /** * Programmatically pop up the keyboard again if the user dismissed it. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() showMessengerKeyboard(): Promise { @@ -235,6 +236,7 @@ export class NativeKeyboard extends AwesomeCordovaNativePlugin { /** * Manipulate the messenger while it's open. For instance if you want to update the text programmatically based on what the user typed. + * * @param options */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/native-page-transitions/index.ts b/src/@awesome-cordova-plugins/plugins/native-page-transitions/index.ts index dd6a5a37..b1b01595 100644 --- a/src/@awesome-cordova-plugins/plugins/native-page-transitions/index.ts +++ b/src/@awesome-cordova-plugins/plugins/native-page-transitions/index.ts @@ -20,7 +20,6 @@ export interface NativeTransitionOptions { * @name Native Page Transitions * @description * The Native Page Transitions plugin uses native hardware acceleration to animate your transitions between views. You have complete control over the type of transition, the duration, and direction. - * * @usage * ```typescript * import { NativePageTransitions, NativeTransitionOptions } from '@awesome-cordova-plugins/native-page-transitions/ngx'; @@ -72,6 +71,7 @@ export interface NativeTransitionOptions { export class NativePageTransitions extends AwesomeCordovaNativePlugin { /** * Perform a slide animation + * * @param options {NativeTransitionOptions} Options for the transition * @returns {Promise} */ @@ -82,6 +82,7 @@ export class NativePageTransitions extends AwesomeCordovaNativePlugin { /** * Perform a flip animation + * * @param options {NativeTransitionOptions} Options for the transition * @returns {Promise} */ @@ -92,6 +93,7 @@ export class NativePageTransitions extends AwesomeCordovaNativePlugin { /** * Perform a fade animation + * * @param options {NativeTransitionOptions} Options for the transition * @returns {Promise} */ @@ -102,6 +104,7 @@ export class NativePageTransitions extends AwesomeCordovaNativePlugin { /** * Perform a slide animation + * * @param options {NativeTransitionOptions} Options for the transition * @returns {Promise} */ @@ -112,6 +115,7 @@ export class NativePageTransitions extends AwesomeCordovaNativePlugin { /** * Perform a slide animation + * * @param options {NativeTransitionOptions} Options for the transition * @returns {Promise} */ @@ -122,6 +126,7 @@ export class NativePageTransitions extends AwesomeCordovaNativePlugin { /** * Execute pending transition + * * @returns {Promise} */ @Cordova() @@ -131,6 +136,7 @@ export class NativePageTransitions extends AwesomeCordovaNativePlugin { /** * Cancel pending transition + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/native-storage/index.ts b/src/@awesome-cordova-plugins/plugins/native-storage/index.ts index 9b7e7ea0..df1e242a 100644 --- a/src/@awesome-cordova-plugins/plugins/native-storage/index.ts +++ b/src/@awesome-cordova-plugins/plugins/native-storage/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Native Storage * @premier nativestorage * @description Native storage of variables in Android and iOS - * * @usage * ```typescript * import { NativeStorage } from '@awesome-cordova-plugins/native-storage/ngx'; @@ -38,6 +37,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class NativeStorage extends AwesomeCordovaNativePlugin { /** * Initialises shared storage with the suite name when using app groups in iOS + * * @param reference {string} * @returns {Promise} */ @@ -50,6 +50,7 @@ export class NativeStorage extends AwesomeCordovaNativePlugin { /** * Stores a value + * * @param reference {string} * @param value * @returns {Promise} @@ -61,6 +62,7 @@ export class NativeStorage extends AwesomeCordovaNativePlugin { /** * Gets a stored item + * * @param reference {string} * @returns {Promise} */ @@ -71,6 +73,7 @@ export class NativeStorage extends AwesomeCordovaNativePlugin { /** * Retrieving all keys + * * @returns {Promise} */ @Cordova() @@ -80,6 +83,7 @@ export class NativeStorage extends AwesomeCordovaNativePlugin { /** * Removes a single stored item + * * @param reference {string} * @returns {Promise} */ @@ -90,6 +94,7 @@ export class NativeStorage extends AwesomeCordovaNativePlugin { /** * Removes all stored values. + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/native-view/index.ts b/src/@awesome-cordova-plugins/plugins/native-view/index.ts index 423df41b..90953710 100644 --- a/src/@awesome-cordova-plugins/plugins/native-view/index.ts +++ b/src/@awesome-cordova-plugins/plugins/native-view/index.ts @@ -4,7 +4,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl /** * @name NativeView * @description Shows the native view. - * * @usage * ```typescript * import { NativeView } from '@awesome-cordova-plugins/native-view/ngx'; @@ -134,7 +133,8 @@ export class NativeView extends AwesomeCordovaNativePlugin { * Get the **Android** current build variant FLAVOR * This is great if you change the FLAVOR in compile time * - * @param {Boolean} [config.catchError] `config.catchError` True, if you wish catch a JSON with error information + * @param {boolean} [config.catchError] `config.catchError` True, if you wish catch a JSON with error information + * @param config * @param {Function} [success] Callback when success. Use `.then()` Promise method, instead * @param {Function} [error] Callback callbed when an error happens. Use `.catch()` Promise method, instead * @returns {Promise} Returns a current FLAVOR string diff --git a/src/@awesome-cordova-plugins/plugins/network-interface/index.ts b/src/@awesome-cordova-plugins/plugins/network-interface/index.ts index 1a6b2044..14e96e05 100644 --- a/src/@awesome-cordova-plugins/plugins/network-interface/index.ts +++ b/src/@awesome-cordova-plugins/plugins/network-interface/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Network Interface * @description * Network interface information plugin for Cordova/PhoneGap that supports Android, Blackberry 10, Browser, iOS, and Windows Phone 8. - * * @usage * ```typescript * import { NetworkInterface } from '@awesome-cordova-plugins/network-interface/ngx'; @@ -38,7 +37,8 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class NetworkInterface extends AwesomeCordovaNativePlugin { /** * Gets the WiFi IP address - * @return {Promise} Returns a Promise that resolves with the IP address information. + * + * @returns {Promise} Returns a Promise that resolves with the IP address information. */ @Cordova() getWiFiIPAddress(): Promise { @@ -47,7 +47,8 @@ export class NetworkInterface extends AwesomeCordovaNativePlugin { /** * Gets the wireless carrier IP address - * @return {Promise} Returns a Promise that resolves with the IP address information. + * + * @returns {Promise} Returns a Promise that resolves with the IP address information. */ @Cordova() getCarrierIPAddress(): Promise { @@ -56,8 +57,10 @@ export class NetworkInterface extends AwesomeCordovaNativePlugin { /** * Gets the relevant proxies for the passed URL in order of application + * * @param {url} message The message to display. - * @return {Promise} Returns a Promise that resolves with the proxy information. + * @param url + * @returns {Promise} Returns a Promise that resolves with the proxy information. */ @Cordova() getHttpProxyInformation(url: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/network/index.ts b/src/@awesome-cordova-plugins/plugins/network/index.ts index e5e80be1..288421f2 100644 --- a/src/@awesome-cordova-plugins/plugins/network/index.ts +++ b/src/@awesome-cordova-plugins/plugins/network/index.ts @@ -27,7 +27,6 @@ export enum Connection { * @premier network-information * @description * Requires Cordova plugin: cordova-plugin-network-information. For more info, please see the [Network plugin docs](https://github.com/apache/cordova-plugin-network-information). - * * @usage * ```typescript * import { Network } from '@awesome-cordova-plugins/network/ngx'; @@ -90,19 +89,22 @@ export class Network extends AwesomeCordovaNativePlugin { /** * Connection type - * @return {string} + * + * @returns {string} */ @CordovaProperty() type: string; /** * Downlink Max Speed - * @return {string} + * + * @returns {string} */ @CordovaProperty() downlinkMax: string; /** * Returns an observable to watch connection changes - * @return {Observable<'connected' | 'disconnected'>} + * + * @returns {Observable<'connected' | 'disconnected'>} */ @CordovaCheck() onChange(): Observable<'connected' | 'disconnected'> { @@ -114,6 +116,7 @@ export class Network extends AwesomeCordovaNativePlugin { /** * Get notified when the device goes offline + * * @returns {Observable} Returns an observable. */ @Cordova({ @@ -127,6 +130,7 @@ export class Network extends AwesomeCordovaNativePlugin { /** * Get notified when the device goes online + * * @returns {Observable} Returns an observable. */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/nfc/index.ts b/src/@awesome-cordova-plugins/plugins/nfc/index.ts index 5da8192f..96e7b0f1 100644 --- a/src/@awesome-cordova-plugins/plugins/nfc/index.ts +++ b/src/@awesome-cordova-plugins/plugins/nfc/index.ts @@ -58,7 +58,6 @@ export interface ScanOptions { * - receive data from NFC devices * * This plugin uses NDEF (NFC Data Exchange Format) for maximum compatibilty between NFC devices, tag types, and operating systems. - * * @usage * ```typescript * import { NFC, Ndef } from '@awesome-cordova-plugins/nfc/ngx'; @@ -136,6 +135,8 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Function scanNdef starts the NFCNDEFReaderSession allowing iOS to scan NFC tags. * https://github.com/chariotsolutions/phonegap-nfc#nfcscanndef + * + * @param options */ @Cordova({ sync: true }) scanNdef(options?: ScanOptions): Promise { @@ -147,6 +148,8 @@ export class NFC extends AwesomeCordovaNativePlugin { * * You probably want *scanNdef* for reading NFC tags on iOS. Only use scanTag if you need the tag UID. * https://github.com/chariotsolutions/phonegap-nfc#nfcscantag + * + * @param options */ @Cordova({ sync: true }) scanTag(options?: ScanOptions): Promise { @@ -198,8 +201,8 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Starts the NFCNDEFReaderSession allowing iOS to scan NFC tags. - * @deprecated use scanNdef or scanTag * + * @deprecated use scanNdef or scanTag * @param onSuccess * @param onFailure * @returns {Observable} @@ -217,6 +220,7 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Registers an event listener for any NDEF tag. + * * @param onSuccess * @param onFailure * @returns {Observable} @@ -234,6 +238,7 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Registers an event listener for tags matching any tag type. + * * @param onSuccess * @param onFailure * @returns {Observable} @@ -251,6 +256,7 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Registers an event listener for NDEF tags matching a specified MIME type. + * * @param mimeType * @param onSuccess * @param onFailure @@ -269,6 +275,7 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Registers an event listener for formatable NDEF tags. + * * @param onSuccess * @param onFailure * @returns {Observable} @@ -284,6 +291,7 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Writes an NdefMessage(array of ndef records) to a NFC tag. + * * @param message {any[]} * @returns {Promise} */ @@ -293,6 +301,7 @@ export class NFC extends AwesomeCordovaNativePlugin { } /** * Makes a NFC tag read only. **Warning** this is permanent. + * * @returns {Promise} */ @Cordova() @@ -302,6 +311,7 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Shares an NDEF Message(array of ndef records) via peer-to-peer. + * * @param message An array of NDEF Records. * @returns {Promise} */ @@ -312,6 +322,7 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Stop sharing NDEF data via peer-to-peer. + * * @returns {Promise} */ @Cordova() @@ -329,6 +340,7 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Send a file to another device via NFC handover. + * * @param uris A URI as a String, or an array of URIs. * @returns {Promise} */ @@ -339,6 +351,7 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Stop sharing NDEF data via NFC handover. + * * @returns {Promise} */ @Cordova() @@ -348,6 +361,7 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Opens the device's NFC settings. + * * @returns {Promise} */ @Cordova() @@ -357,6 +371,7 @@ export class NFC extends AwesomeCordovaNativePlugin { /** * Check if NFC is available and enabled on this device. + * * @returns {Promise} */ @Cordova() @@ -369,6 +384,7 @@ export class NFC extends AwesomeCordovaNativePlugin { */ /** * Convert byte array to string + * * @param bytes {number[]} * @returns {string} */ @@ -378,6 +394,7 @@ export class NFC extends AwesomeCordovaNativePlugin { } /** * Convert string to byte array. + * * @param str {string} * @returns {number[]} */ diff --git a/src/@awesome-cordova-plugins/plugins/ocr/index.ts b/src/@awesome-cordova-plugins/plugins/ocr/index.ts index 05acee8a..74f98019 100644 --- a/src/@awesome-cordova-plugins/plugins/ocr/index.ts +++ b/src/@awesome-cordova-plugins/plugins/ocr/index.ts @@ -136,12 +136,10 @@ export interface OCRResult { * .catch((error: any) => console.error(error)); * * ``` - * * @interfaces * OCRCorners * OCRRect * OCRResult - * * @enums * OCRSourceType */ @@ -156,9 +154,10 @@ export interface OCRResult { export class OCR extends AwesomeCordovaNativePlugin { /** * Extract text from image + * * @param sourceType {OCRSourceType} type of image source * @param source {string} image source (either file URL or base64 string) - * @return {Promise} extracted text and geometry + * @returns {Promise} extracted text and geometry */ @Cordova() recText(sourceType: OCRSourceType, source: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/onesignal/index.ts b/src/@awesome-cordova-plugins/plugins/onesignal/index.ts index b08c2cfb..51ab3eee 100644 --- a/src/@awesome-cordova-plugins/plugins/onesignal/index.ts +++ b/src/@awesome-cordova-plugins/plugins/onesignal/index.ts @@ -12,7 +12,7 @@ export interface OSNotification { */ shown?: boolean; /** - * **ANDROID** - Android Notification assigned to the notification. Can be used to cancel or replace the notification. + * ANDROID** - Android Notification assigned to the notification. Can be used to cancel or replace the notification. */ androidNotificationId?: number; /** @@ -24,7 +24,7 @@ export interface OSNotification { */ displayType?: OSDisplayType; /** - * **ANDROID** - Notification is a summary notification for a group this will contain all notification payloads it was created from. + * ANDROID** - Notification is a summary notification for a group this will contain all notification payloads it was created from. */ groupedNotifications?: OSNotificationPayload[]; app_id?: string; @@ -91,7 +91,7 @@ export interface OSNotification { } /** - * **ANDROID** - Privacy setting for how the notification should be shown on the lockscreen of Android 5+ devices. + * ANDROID** - Privacy setting for how the notification should be shown on the lockscreen of Android 5+ devices. */ export enum OSLockScreenVisibility { /** @@ -148,19 +148,19 @@ export interface OSNotificationPayload { */ additionalData?: any; /** - * **ANDROID** - Small icon resource name set on the notification. + * ANDROID** - Small icon resource name set on the notification. */ smallIcon?: string; /** - * **ANDROID** - Large icon set on the notification. + * ANDROID** - Large icon set on the notification. */ largeIcon?: string; /** - * **ANDROID** - Big picture image set on the notification. + * ANDROID** - Big picture image set on the notification. */ bigPicture?: string; /** - * **ANDROID** - Accent color shown around small notification icon on Android 5+ devices. ARGB format. + * ANDROID** - Accent color shown around small notification icon on Android 5+ devices. ARGB format. */ smallIconAccentColor?: string; /** @@ -172,16 +172,16 @@ export interface OSNotificationPayload { */ sound: string; /** - * **ANDROID** - Devices that have a notification LED will blink in this color. ARGB format. + * ANDROID** - Devices that have a notification LED will blink in this color. ARGB format. */ ledColor?: string; lockScreenVisibility?: OSLockScreenVisibility; /** - * **ANDROID** - Notifications with this same key will be grouped together as a single summary notification. + * ANDROID** - Notifications with this same key will be grouped together as a single summary notification. */ groupKey?: string; /** - * **ANDROID** - Summary text displayed in the summary notification. + * ANDROID** - Summary text displayed in the summary notification. */ groupMessage?: string; /** @@ -189,11 +189,11 @@ export interface OSNotificationPayload { */ actionButtons: OSActionButton[]; /** - * **ANDROID** - The Google project number the notification was sent under. + * ANDROID** - The Google project number the notification was sent under. */ fromProjectNumber?: string; /** - * **ANDROID** - If a background image was set this object will be available. + * ANDROID** - If a background image was set this object will be available. */ backgroundImageLayout?: OSBackgroundImageLayout; priority?: number; @@ -216,7 +216,7 @@ export interface OSActionButton { */ text: string; /** - * **ANDROID** - Icon shown on the button. + * ANDROID** - Icon shown on the button. */ icon: string; } @@ -264,7 +264,7 @@ export interface OSPermissionSubscriptionState { } /** - * **ANDROID** - If a background image was set, this object will be available. + * ANDROID** - If a background image was set, this object will be available. */ export interface OSBackgroundImageLayout { /** @@ -395,8 +395,6 @@ export interface OSInAppMessageAction { * * 3. From the root of your project make the file executable: * `$ chmod +x hooks/copy_android_notification_icons.js` - * - * * @usage * ```typescript * import { OneSignal } from '@awesome-cordova-plugins/onesignal/ngx'; @@ -441,6 +439,7 @@ export interface OSInAppMessageAction { export class OneSignal extends AwesomeCordovaNativePlugin { /** * constants to use in inFocusDisplaying() + * * @hidden */ OSInFocusDisplayOption = { @@ -464,7 +463,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { /** * Callback to run when a notification is received, whether it was displayed or not. * - * @return {Observable} + * @returns {Observable} */ @Cordova({ observable: true, @@ -478,7 +477,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { * center (**iOS**), or when closing an Alert notification shown in the app (if InAppAlert is enabled in * inFocusDisplaying). * - * @return {Observable} + * @returns {Observable} */ @Cordova({ observable: true, @@ -490,7 +489,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { /** * Use to process an In-App Message the user just tapped on. * - * @return {Observable} + * @returns {Observable} */ @Cordova({ observable: true, @@ -500,7 +499,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { } /** - * **iOS** - Settings for iOS apps + * iOS** - Settings for iOS apps * * @param settings * kOSSettingsKeyAutoPrompt: boolean = true @@ -508,6 +507,8 @@ export class OneSignal extends AwesomeCordovaNativePlugin { * * kOSSettingsKeyInAppLaunchURL: boolean = false * Launch notifications with a launch URL as an in app webview. + * @param settings.kOSSettingsKeyAutoPrompt + * @param settings.kOSSettingsKeyInAppLaunchURL * @returns {any} */ @Cordova({ @@ -530,6 +531,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { /** * Prompt the user for notification permissions. Callback fires as soon as the user accepts or declines notifications. + * * @returns {Promise} */ @Cordova({ @@ -542,7 +544,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { /** * Retrieve a list of tags that have been set on the user from the OneSignal server. * - * **Quirk**: You must wait for `getTags` to resolve before calling it again, as the plugin will only process the last method call and discard any previous ones. + * Quirk**: You must wait for `getTags` to resolve before calling it again, as the plugin will only process the last method call and discard any previous ones. * * @returns {Promise} Returns a Promise that resolves when tags are recieved. */ @@ -572,6 +574,8 @@ export class OneSignal extends AwesomeCordovaNativePlugin { * * @param {string} Key of your choosing to create or update. * @param {string} Value to set on the key. NOTE: Passing in a blank String deletes the key, you can also call deleteTag. + * @param key + * @param value */ @Cordova({ sync: true }) sendTag(key: string, value: string): void {} @@ -581,6 +585,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { * Recommend using sendTags over sendTag if you need to set more than one tag on a user at a time. * * @param {string} Pass a json object with key/value pairs like: {key: "value", key2: "value2"} + * @param json */ @Cordova({ sync: true }) sendTags(json: any): void {} @@ -589,6 +594,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { * Deletes a tag that was previously set on a user with `sendTag` or `sendTags`. Use `deleteTags` if you need to delete more than one. * * @param {string} Key to remove. + * @param key */ @Cordova({ sync: true }) deleteTag(key: string): void {} @@ -597,6 +603,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { * Deletes tags that were previously set on a user with `sendTag` or `sendTags`. * * @param {string[]} Keys to remove. + * @param keys */ @Cordova({ sync: true }) deleteTags(keys: string[]): void {} @@ -616,6 +623,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { * Passing false means that the device will only vibrate lightly when the device is in it's vibrate only mode. * * @param {boolean} false to disable vibrate, true to re-enable it. + * @param enable */ @Cordova({ sync: true }) enableVibrate(enable: boolean): void {} @@ -628,6 +636,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { * Passing false means that the device will only vibrate unless the device is set to a total silent mode. * * @param {boolean} false to disable sound, true to re-enable it. + * @param enable */ @Cordova({ sync: true }) enableSound(enable: boolean): void {} @@ -666,6 +675,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { /** * * @param {notificationObj} Parameters see POST [documentation](https://documentation.onesignal.com/v2.0/docs/notifications-create-notification) + * @param notificationObj * @returns {Promise} Returns a Promise that resolves if the notification was send successfully. */ @Cordova() @@ -675,6 +685,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { /** * Cancels a single OneSignal notification based on its Android notification integer id. Use instead of NotificationManager.cancel(id); otherwise the notification will be restored when your app is restarted. + * * @param notificationId {string} */ @Cordova({ sync: true }) @@ -700,12 +711,16 @@ export class OneSignal extends AwesomeCordovaNativePlugin { * The higher the value the more information is shown. * * @param {loglevel} contains two properties: logLevel (for console logging) and visualLevel (for dialog messages) + * @param logLevel + * @param logLevel.logLevel + * @param logLevel.visualLevel */ @Cordova({ sync: true }) setLogLevel(logLevel: { logLevel: number; visualLevel: number }): void {} /** * Disable or enable location collection (Defaults to enabled) if your app has location permission. + * * @param shared {boolean} */ @Cordova({ sync: true }) @@ -717,7 +732,8 @@ export class OneSignal extends AwesomeCordovaNativePlugin { * - Notification permission prompt shown * - The user accepting or declining the permission prompt * - Enabling/disabling notifications for your app in the device Settings after returning to your app. - * @return {Observable} + * + * @returns {Observable} */ @Cordova({ observable: true, @@ -733,7 +749,8 @@ export class OneSignal extends AwesomeCordovaNativePlugin { * - Getting a player / user id from OneSignal * - OneSignal.setSubscription is called * - User disables or enables notifications - * @return {Observable} + * + * @returns {Observable} */ @Cordova({ observable: true, @@ -744,6 +761,9 @@ export class OneSignal extends AwesomeCordovaNativePlugin { /** * Clears all OneSignal notifications + * + * @param email + * @param emailAuthToken */ @Cordova() setEmail(email: string, emailAuthToken?: string): Promise { @@ -765,7 +785,8 @@ export class OneSignal extends AwesomeCordovaNativePlugin { * - Getting a player / user id from OneSignal * - OneSignal.setSubscription is called * - User disables or enables notifications - * @return {Observable} + * + * @returns {Observable} */ @Cordova({ observable: true, @@ -783,6 +804,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { /** * Allows you to delay the initialization of the SDK until the user provides privacy consent. * The SDK will not be fully initialized until the provideUserConsent(true) method is called. + * * @param {boolean} required */ @Cordova() @@ -791,6 +813,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { /** * If your application is set to require the user's privacy consent, you can provide this consent using this method. * Until you call provideUserConsent(true), the SDK will not fully initialize and will not send any data to OneSignal. + * * @param {boolean} granted */ @Cordova() @@ -798,6 +821,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { /** * Accepts a callback, which returns a boolean variable indicating if the user has given privacy consent yet. + * * @param {Function} callback */ @Cordova() @@ -806,6 +830,7 @@ export class OneSignal extends AwesomeCordovaNativePlugin { /** * Allows you to use your own system's user ID's to send push notifications to your users. * To tie a user to a given user ID, you can use this method. + * * @param {string} externalId */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/open-native-settings/index.ts b/src/@awesome-cordova-plugins/plugins/open-native-settings/index.ts index 78d0c9e7..4691f648 100644 --- a/src/@awesome-cordova-plugins/plugins/open-native-settings/index.ts +++ b/src/@awesome-cordova-plugins/plugins/open-native-settings/index.ts @@ -101,8 +101,9 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class OpenNativeSettings extends AwesomeCordovaNativePlugin { /** * Opens a setting dialog + * * @param setting {string|array} setting name - * @return {Promise} + * @returns {Promise} */ @Cordova() open(setting: string | [string, boolean]): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/openalpr/index.ts b/src/@awesome-cordova-plugins/plugins/openalpr/index.ts index 8b8b38b8..3404acd4 100644 --- a/src/@awesome-cordova-plugins/plugins/openalpr/index.ts +++ b/src/@awesome-cordova-plugins/plugins/openalpr/index.ts @@ -20,7 +20,6 @@ export interface OpenALPRResult { * @name OpenALPR * @description * This Cordova plugin adds support for the OpenALPR (Automatic License Plate Recognition) library, which provides support for retrieving the license plate from a picture. - * * @usage * ```typescript * import { OpenALPR, OpenALPROptions, OpenALPRResult } from '@awesome-cordova-plugins/openalpr/ngx'; @@ -63,9 +62,10 @@ export class OpenALPR extends AwesomeCordovaNativePlugin { /** * This function does something + * * @param imageData {any} Base64 encoding of the image data or the image file URI * @param options {OpenALPROptions} Options to pass to the OpenALPR scanner - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() scan(imageData: any, options?: OpenALPROptions): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/paytabs/index.ts b/src/@awesome-cordova-plugins/plugins/paytabs/index.ts index f65d6b9e..e5185466 100644 --- a/src/@awesome-cordova-plugins/plugins/paytabs/index.ts +++ b/src/@awesome-cordova-plugins/plugins/paytabs/index.ts @@ -395,7 +395,6 @@ export enum AlternativePaymentMethod { * @name PayTabs * @description * A plugin that allows you to use PayTabs's Native SDKs for Android and iOS. - * * @usage * ```typescript * import { PayTabs } from '@awesome-cordova-plugins/paytabs/ngx'; @@ -453,8 +452,10 @@ export enum AlternativePaymentMethod { export class PayTabs extends AwesomeCordovaNativePlugin { /** * Start Card Payment + * * @param params {PaymentSDKConfiguration} payment request configuration - * @return {Promise} returns a promise that resolves with transaction details, or rejects with an error + * @param configuration + * @returns {Promise} returns a promise that resolves with transaction details, or rejects with an error */ @Cordova() startCardPayment(configuration: PaymentSDKConfiguration): Promise { @@ -462,8 +463,10 @@ export class PayTabs extends AwesomeCordovaNativePlugin { } /** * Start ApplePay Payment + * * @param params {PaymentSDKConfiguration} payment request configuration - * @return {Promise} returns a promise that resolves with transaction details, or rejects with an error + * @param configuration + * @returns {Promise} returns a promise that resolves with transaction details, or rejects with an error */ @Cordova() startApplePayPayment(configuration: PaymentSDKConfiguration): Promise { @@ -471,8 +474,10 @@ export class PayTabs extends AwesomeCordovaNativePlugin { } /** * Start Alternative Payment Method + * * @param params {PaymentSDKConfiguration} payment request configuration - * @return {Promise} returns a promise that resolves with transaction details, or rejects with an error + * @param configuration + * @returns {Promise} returns a promise that resolves with transaction details, or rejects with an error */ @Cordova() startAlternativePaymentMethod(configuration: PaymentSDKConfiguration): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/pdf-generator/index.ts b/src/@awesome-cordova-plugins/plugins/pdf-generator/index.ts index 4b6a53b7..a7d5d926 100644 --- a/src/@awesome-cordova-plugins/plugins/pdf-generator/index.ts +++ b/src/@awesome-cordova-plugins/plugins/pdf-generator/index.ts @@ -39,7 +39,6 @@ export interface PDFGeneratorOptions { * @name PDFGenerator * @description * Simple plugin to generate (offline) pdf. The plugin transforms HTML to PDF and also provide the mechanism to share the pdf to other apps like Mail, etc. - * * @usage * ```typescript * import { PDFGenerator } from '@awesome-cordova-plugins/pdf-generator'; @@ -65,6 +64,7 @@ export interface PDFGeneratorOptions { export class PDFGenerator extends AwesomeCordovaNativePlugin { /** * Creates a PDF using a URL, it download the document into an in memory Webkit object, and renders it into a PDF. + * * @param url {string} URL to create a PDF from * @param options {PDFGeneratorOptions} options for PDF generation * @returns {Promise} @@ -76,6 +76,7 @@ export class PDFGenerator extends AwesomeCordovaNativePlugin { /** * Creates a PDF using string with the HTML representation, it download the document into an in memory Webkit object, and renders it into a PDF. + * * @param data {string} HTML string representation to create a PDF from * @param options {PDFGeneratorOptions} options for PDF generation * @returns {Promise} diff --git a/src/@awesome-cordova-plugins/plugins/photo-library/index.ts b/src/@awesome-cordova-plugins/plugins/photo-library/index.ts index 0b46a46b..8d51f3a5 100644 --- a/src/@awesome-cordova-plugins/plugins/photo-library/index.ts +++ b/src/@awesome-cordova-plugins/plugins/photo-library/index.ts @@ -17,6 +17,7 @@ export interface CordovaFiniteObservableOptions extends CordovaOptions { } /** + * @param opts * @hidden * * Wraps method that returns an observable that can be completed. Provided opts.resultFinalPredicate dictates when the observable completes. @@ -58,7 +59,6 @@ export function CordovaFiniteObservable(opts: CordovaFiniteObservableOptions = { * The PhotoLibrary plugin allows access to photos from device by url. So you can use plain img tag to display photos and their thumbnails, and different 3rd party libraries as well. * Saving photos and videos to the library is also supported. * cdvphotolibrary urls should be trusted by Angular. See plugin homepage to learn how. - * * @usage * ```typescript * import { PhotoLibrary } from '@awesome-cordova-plugins/photo-library/ngx'; @@ -103,8 +103,11 @@ export function CordovaFiniteObservable(opts: CordovaFiniteObservableOptions = { export class PhotoLibrary extends AwesomeCordovaNativePlugin { /** * Retrieves library items. Library item contains photo metadata like width and height, as well as photoURL and thumbnailURL. + * + * @param success + * @param error * @param options {GetLibraryOptions} Optional, like thumbnail size and chunks settings. - * @return {Observable} Returns library items. If appropriate option was set, will be returned by chunks. + * @returns {Observable} Returns library items. If appropriate option was set, will be returned by chunks. */ @Cordova({ observable: true, @@ -119,8 +122,9 @@ export class PhotoLibrary extends AwesomeCordovaNativePlugin { /** * Asks user permission to access photo library. + * * @param options {RequestAuthorizationOptions} Optional, like whether only read access needed or read/write. - * @return { Promise} Returns a promise that resolves when permissions are granted, and fails when not. + * @returns { Promise} Returns a promise that resolves when permissions are granted, and fails when not. */ @Cordova({ callbackOrder: 'reverse', @@ -131,7 +135,8 @@ export class PhotoLibrary extends AwesomeCordovaNativePlugin { /** * Returns list of photo albums on device. - * @return {Promise} Resolves to list of albums. + * + * @returns {Promise} Resolves to list of albums. */ @Cordova({ callbackOrder: 'reverse', @@ -142,9 +147,10 @@ export class PhotoLibrary extends AwesomeCordovaNativePlugin { /** * Provides means to request URL of thumbnail, with specified size or quality. + * * @param photo {string | LibraryItem} Id of photo, or LibraryItem. * @param options {GetThumbnailOptions} Options, like thumbnail size or quality. - * @return {Promise} Resolves to URL of cdvphotolibrary schema. + * @returns {Promise} Resolves to URL of cdvphotolibrary schema. */ @Cordova({ successIndex: 1, @@ -156,9 +162,10 @@ export class PhotoLibrary extends AwesomeCordovaNativePlugin { /** * Provides means to request photo URL by id. + * * @param photo {string | LibraryItem} Id or LibraryItem. * @param options {GetPhotoOptions} Optional options. - * @return {Promise} Resolves to URL of cdvphotolibrary schema. + * @returns {Promise} Resolves to URL of cdvphotolibrary schema. */ @Cordova({ successIndex: 1, @@ -170,9 +177,10 @@ export class PhotoLibrary extends AwesomeCordovaNativePlugin { /** * Returns thumbnail as Blob. + * * @param photo {string | LibraryItem} Id or LibraryItem. * @param options {GetThumbnailOptions} Options, like thumbnail size or quality. - * @return {Promise} Resolves requested thumbnail as blob. + * @returns {Promise} Resolves requested thumbnail as blob. */ @Cordova({ successIndex: 1, @@ -184,9 +192,10 @@ export class PhotoLibrary extends AwesomeCordovaNativePlugin { /** * Returns photo as Blob. + * * @param photo {string | LibraryItem} Id or LibraryItem. * @param options {GetPhotoOptions} Optional options. - * @return {Promise} Resolves requested photo as blob. + * @returns {Promise} Resolves requested photo as blob. */ @Cordova({ successIndex: 1, @@ -199,10 +208,11 @@ export class PhotoLibrary extends AwesomeCordovaNativePlugin { /** * Saves image to specified album. Album will be created if not exists. * LibraryItem that represents saved image is returned. + * * @param url {string} URL of a file, or DataURL. * @param album {AlbumItem | string} Name of an album or AlbumItem object. * @param options {GetThumbnailOptions} Options, like thumbnail size for resulting LibraryItem. - * @return {Promise} Resolves to LibraryItem that represents saved image. + * @returns {Promise} Resolves to LibraryItem that represents saved image. */ @Cordova({ successIndex: 2, @@ -214,9 +224,10 @@ export class PhotoLibrary extends AwesomeCordovaNativePlugin { /** * Saves video to specified album. Album will be created if not exists. + * * @param url {string} URL of a file, or DataURL. * @param album {AlbumItem | string} Name of an album or AlbumItem object. - * @return {Promise} Resolves when save operation completes. + * @returns {Promise} Resolves when save operation completes. */ @Cordova({ successIndex: 2, diff --git a/src/@awesome-cordova-plugins/plugins/photo-viewer/index.ts b/src/@awesome-cordova-plugins/plugins/photo-viewer/index.ts index 71caee09..8205bb8c 100644 --- a/src/@awesome-cordova-plugins/plugins/photo-viewer/index.ts +++ b/src/@awesome-cordova-plugins/plugins/photo-viewer/index.ts @@ -58,6 +58,7 @@ export interface PhotoViewerOptions { export class PhotoViewer extends AwesomeCordovaNativePlugin { /** * Shows an image in full screen + * * @param url {string} URL or path to image * @param title {string} * @param options {PhotoViewerOptions} diff --git a/src/@awesome-cordova-plugins/plugins/pollfish/index.ts b/src/@awesome-cordova-plugins/plugins/pollfish/index.ts index 6ba9335e..961f63ae 100644 --- a/src/@awesome-cordova-plugins/plugins/pollfish/index.ts +++ b/src/@awesome-cordova-plugins/plugins/pollfish/index.ts @@ -5,7 +5,6 @@ import { Plugin, Cordova, CordovaProperty, AwesomeCordovaNativePlugin } from '@a * @name Pollfish * @description * Pollfish Ionic Native plugin wrapper - * * @usage * ```typescript * import { Pollfish } from '@awesome-cordova-plugins/pollfish/ngx'; @@ -90,6 +89,7 @@ export class Pollfish extends AwesomeCordovaNativePlugin { /** * Function to init Pollfish + * * @param releaseMode {boolean} * @param rewardMode {boolean} * @param apiKey {string} @@ -113,6 +113,7 @@ export class Pollfish extends AwesomeCordovaNativePlugin { /** * Function to init Pollfish with user attributes + * * @param releaseMode {boolean} * @param rewardMode {boolean} * @param apiKey {string} @@ -157,6 +158,7 @@ export class Pollfish extends AwesomeCordovaNativePlugin { /** * Function to set event callbacks + * * @param eventName * @param callback */ diff --git a/src/@awesome-cordova-plugins/plugins/power-optimization/index.ts b/src/@awesome-cordova-plugins/plugins/power-optimization/index.ts index 7ad9e2a7..249e1d34 100644 --- a/src/@awesome-cordova-plugins/plugins/power-optimization/index.ts +++ b/src/@awesome-cordova-plugins/plugins/power-optimization/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @description * Android Custom Roms made sometimes your apps unfunctional due to being killed in the background, notification messages do not appearing or your services being killed by agressive power saving mode. * The Power Optimization plugin give you android PowerManager methods with cordova. - * * @usage * ```typescript * import { PowerOptimization } from '@awesome-cordova-plugins/power-optimization/ngx'; @@ -32,6 +31,7 @@ export class PowerOptimization extends AwesomeCordovaNativePlugin { /** * Check if the battery optimization is ignoring * For more info, please check https://github.com/snt1017/cordova-plugin-power-optimization + * * @returns {Promise} */ @Cordova({ sync: true }) @@ -41,6 +41,7 @@ export class PowerOptimization extends AwesomeCordovaNativePlugin { /** * Request permisson to ignore optimizations: * For more info, please check https://github.com/snt1017/cordova-plugin-power-optimization + * * @returns {Promise} */ @Cordova({ sync: true }) @@ -50,6 +51,7 @@ export class PowerOptimization extends AwesomeCordovaNativePlugin { /** * Go to battery optimizations configurations menu: * For more info, please check https://github.com/snt1017/cordova-plugin-power-optimization + * * @returns {Promise} */ @Cordova({ sync: true }) @@ -59,6 +61,7 @@ export class PowerOptimization extends AwesomeCordovaNativePlugin { /** * Check if have any data restrictions in background: * For more info, please check https://github.com/snt1017/cordova-plugin-power-optimization + * * @returns {Promise} */ @Cordova({ sync: true }) @@ -68,6 +71,7 @@ export class PowerOptimization extends AwesomeCordovaNativePlugin { /** * Go to data restrictions in background configurations menu: * For more info, please check https://github.com/snt1017/cordova-plugin-power-optimization + * * @returns {Promise} */ @Cordova({ sync: true }) @@ -77,6 +81,7 @@ export class PowerOptimization extends AwesomeCordovaNativePlugin { /** * Check if have another battery restriction is present into phone (like huawei, xiaomi, etc): * For more info, please check https://github.com/snt1017/cordova-plugin-power-optimization + * * @returns {Promise} */ @Cordova({ sync: true }) @@ -86,6 +91,7 @@ export class PowerOptimization extends AwesomeCordovaNativePlugin { /** * Go to configurations menu if another battery restriction is present into phone (like huawei, xiaomi, etc). You can send true into params if you want to force show the menu (is only show the fist time without params): * For more info, please check https://github.com/snt1017/cordova-plugin-power-optimization + * * @returns {Promise} */ @Cordova({ sync: true }) diff --git a/src/@awesome-cordova-plugins/plugins/preview-any-file/index.ts b/src/@awesome-cordova-plugins/plugins/preview-any-file/index.ts index 105b6406..5f71f4ee 100644 --- a/src/@awesome-cordova-plugins/plugins/preview-any-file/index.ts +++ b/src/@awesome-cordova-plugins/plugins/preview-any-file/index.ts @@ -7,7 +7,6 @@ import { Observable } from 'rxjs'; * Whatever the file is PDF document, Word document, Excel, office document,zip archive file, image, text, html or anything else, you can perform a preview by this cordova Plugin to preview any file in native mode by providing the local or external URL. * * Requires Cordova plugin: `cordova-plugin-preview-any-file`. For more info, please see the [previewAnyFile plugin docs](https://github.com/mostafa-mansour1/previewAnyFile). - * * @usage * ```typescript * import { PreviewAnyFile } from '@awesome-cordova-plugins/preview-any-file/ngx'; @@ -61,56 +60,60 @@ export class PreviewAnyFile extends AwesomeCordovaNativePlugin { /** * @deprecated Use the previewPath,previewBase64 or previewAsset. they have more options * @param url {String} full absolute URL -> file://, content://, http://, https, ... etc - * @return {Promise} Returns a promise that resolves if the file opened reject if not; + * @returns {Promise} Returns a promise that resolves if the file opened reject if not; * @author Mostafa Mansour */ @Cordova() - preview(url: String): Promise { + preview(url: string): Promise { return; } /** * previewPath function will return SUCCESS,NO_APP or CLOSING in Observable Callback , if the content is base64 you have to use previewBase64 method + * * @param path {String} full absolute URL -> file://, content://, http://, https, ... etc, if extension not exist, you must define it in the opt param * @param opt {PreviewOptions} define the name of the file with extension or it's mimeType, if the correct extension not exist in the path - * @return {Observable} Returns an Observable that resolves if the file opened, closed or not opened , it will reject if any error; + * @returns {Observable} Returns an Observable that resolves if the file opened, closed or not opened , it will reject if any error; * @author Mostafa Mansour */ @Cordova({ observable: true, callbackOrder: 'reverse', }) - previewPath(path: String, opt: PreviewOptions = {}): Observable { + previewPath(path: string, opt: PreviewOptions = {}): Observable { return; // We add return; here to avoid any IDE / Compiler errors } /** * previewBase64 function will return SUCCESS,NO_APP or CLOSING in Observable Callback , if the content is url or path you have to use previewPath method + * * @param path {String} full absolute URL -> file://, content://, http://, https, ... etc, if extension not exist, you must define it in the opt param + * @param base64 * @param opt {PreviewOptions} define the name of the file with extension or it's mimeType, if the mimetype not exist in the base64 string - * @return {Observable} Returns an Observable that resolves if the file opened, closed or not opened , it will reject if any error; + * @returns {Observable} Returns an Observable that resolves if the file opened, closed or not opened , it will reject if any error; * @author Mostafa Mansour */ @Cordova({ observable: true, callbackOrder: 'reverse', }) - previewBase64(base64: String, opt: PreviewOptions = {}): Observable { + previewBase64(base64: string, opt: PreviewOptions = {}): Observable { return; // We add return; here to avoid any IDE / Compiler errors } /** * Use previewAsset function to open a file from assets folder, it will return SUCCESS,NO_APP or CLOSING in Observable Callback , + * * @param path {String} relative path of the file from assets folder "/assets/file.pdf" , if extension not exist, you must define it in the opt param * @param opt {PreviewOptions} define the name of the file with extension or it's mimeType, if the correct extension not exist in the path - * @return {Observable} Returns an Observable that resolves if the file opened, closed or not opened , it will reject if any error; + * @returns {Observable} Returns an Observable that resolves if the file opened, closed or not opened , it will reject if any error; * @author Mostafa Mansour */ @Cordova({ observable: true, callbackOrder: 'reverse', }) - previewAsset(path: String, opt: PreviewOptions = {}): Observable { + previewAsset(path: string, opt: PreviewOptions = {}): Observable { return; // We add return; here to avoid any IDE / Compiler errors } } diff --git a/src/@awesome-cordova-plugins/plugins/printer/index.ts b/src/@awesome-cordova-plugins/plugins/printer/index.ts index 1373320f..abd61cf0 100644 --- a/src/@awesome-cordova-plugins/plugins/printer/index.ts +++ b/src/@awesome-cordova-plugins/plugins/printer/index.ts @@ -169,6 +169,7 @@ export interface PrintOptions { export class Printer extends AwesomeCordovaNativePlugin { /** * Checks whether the device is capable of printing (uses `check()` internally) + * * @returns {Promise} */ isAvailable(): Promise { @@ -177,7 +178,8 @@ export class Printer extends AwesomeCordovaNativePlugin { /** * Checks To check if printing is supported in general - * @return {Promise} returns a promise that resolve with an object indicating whether printing is available + * + * @returns {Promise} returns a promise that resolve with an object indicating whether printing is available */ @CordovaCheck() check(): Promise { @@ -190,6 +192,7 @@ export class Printer extends AwesomeCordovaNativePlugin { /** * Displays a system interface allowing the user to select an available printer. To speak with a printer directly you need to know the network address by picking them before via `printer.pick`. + * * @returns {Promise} */ @Cordova() @@ -199,6 +202,7 @@ export class Printer extends AwesomeCordovaNativePlugin { /** * Sends content to the printer. + * * @param content {string | HTMLElement} The content to print. Can be a URL or an HTML string. If a HTML DOM Object is provided, its innerHtml property value will be used. * @param options {PrintOptions} optional. The options to pass to the printer * @returns {Promise} diff --git a/src/@awesome-cordova-plugins/plugins/pspdfkit-cordova/index.ts b/src/@awesome-cordova-plugins/plugins/pspdfkit-cordova/index.ts index 34e6fa96..63147c63 100644 --- a/src/@awesome-cordova-plugins/plugins/pspdfkit-cordova/index.ts +++ b/src/@awesome-cordova-plugins/plugins/pspdfkit-cordova/index.ts @@ -13,7 +13,6 @@ import { Observable } from 'rxjs'; * @name PSPDFKit-Cordova * @description * The official plugin to use PSPDFKit with Cordova and Ionic. - * * @usage * ```typescript * import { PSPDFKit } from '@awesome-cordova-plugins/pspdfkit-cordova/ngx'; @@ -55,7 +54,8 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * Activates PSPDFKit with your license key from https://customers.pspdfkit.com. * * @param key {string} The license key. - * @return {Promise} Success and error callback function. + * @param licenseKey + * @returns {Promise} Success and error callback function. * * __Supported Platforms__ * @@ -72,7 +72,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * * @param path {string} The path should be a string containing the file path (not URL) for the PDF. Relative paths are assumed to be relative to the www directory (if the path has a different base URL set, this will be ignored). To specify a path inside the application documents or library directory, use a `~`, e.g. `"~/Documents/mypdf.pdf"` or `"~/Library/Application Support/mypdf.pdf"`. Path can be null, but must not be omitted * @param options {any} The `options` parameter is an optional object containing configuration properties for the PDF document and/or view controller. All currently supported values are listed below under Options. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -87,9 +87,10 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { /** * Opens the PSPDFActivity to show a document from the app's assets folder. This method copies the * file to the internal app directory on the device before showing it. + * * @param assetFile {string} Relative path within the app's assets folder. * @param options {any} PSPDFKit configuration options. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -106,7 +107,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * @param path {string} Should be a string containing the file path (not URL) for the PDF. Relative paths are assumed to be relative to the www directory (if the path has a different base URL set, this will be ignored). To specify a path inside the application documents or library directory, use a `~`, e.g. `"~/Documents/mypdf.pdf"` or `"~/Library/Application Support/mypdf.pdf"`. Path can be null, but must not be omitted * @param xfdfPath {string} should be a string containing the file path (not URL) for the XFDF file backing the PDF document. Relative paths are assumed to be relative to the www directory (if the xfdf path has a different base URL set, we will create an XFDF file in `'"~/Documents/" + xfdfPath'`). To specify a path inside the application documents or library directory, use a ~, e.g. `"~/Documents/myXFDF.xfdf"` or `"~/Library/Application Support/myXFDF.xfdf"`. The xfdfPath cannot be null and must not be omitted. * @param options {any} The `options` parameter is an optional object containing configuration properties for the PDF document and/or view controller. All currently supported values are listed below under Options. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -121,7 +122,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * iOS: Dismisses the modally presented PDF view. * Android: Dismisses any previously launched PDF activity. Calls the optional callback function after all activities have been dismissed. * - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -136,7 +137,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { /** * Reloads the current PDF. * - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -152,7 +153,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * Provides "wasModified" as a part of a successful response which will be equal to true if * the file was modified and changes were saved. false if there was nothing to save. * - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -166,7 +167,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { /** * Saves any changed annotations in the current document. * - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -180,7 +181,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { /** * Return true in the success (or result) callback if the document has unsaved annotation. Returns false otherwise. * - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -198,7 +199,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * @param query {string} Search Term to query * @param animated {boolean} Determines if the search should be animated (if omitted, the search will not be animated). The optional headless argument determines whether the search UI should be disaplyed (if omitted, the search UI *will* be displayed). * @param headless {boolean} Determines whether the search UI should be disaplyed (if omitted, the search UI *will* be displayed). - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -214,7 +215,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * * @param options {any} The options set will be applied to the current document (if there is one) as well as all subsequently displayed documents. All currently supported values are listed below under Options. * @param animated {boolean} determines if the property should be animated. Not all property changes can be animated, so if the property does not support animation the animated argument will be ignored. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -229,7 +230,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * Gets several document or view controller options in a single call. * * @param names {any} array of option names - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -246,7 +247,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * @param name {string} the option name * @param value {any} the option value * @param animated {boolean} determines if the property should be animated. Not all property changes can be animated, so if the property does not support animation the animated argument will be ignored. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -261,7 +262,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * Gets a single document or view controller settings at once. * * @param name {string} the option name - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -277,7 +278,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * * @param page {number} the page index * @param animated {boolean} Optional argument. Determines if the page change should be animated (if omitted, the search will not be animated). - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -291,7 +292,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { /** * Gets the currently visible page. * - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -305,7 +306,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { /** * Gets the page count of the current document. * - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -320,7 +321,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * Scrolls to the next page. * * @param animated {boolean} Optional argument. Determines if the page change should be animated (if omitted, the search will not be animated). - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -335,7 +336,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * Scrolls to the previous page. * * @param animated {boolean} Optional argument. Determines if the page change should be animated (if omitted, the search will not be animated). - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -350,7 +351,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * Sets the appearance mode. * * @param appearanceMode {string} the appearance mode. Can be 'default', 'sepia', or 'night' - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -367,7 +368,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * since invalidating single documents or specific page caches since excessive cache invalidation may decrease performance. * * @param clearDiskCache {boolean} optional parameter. Android: if set to true clears disk cache as well. iOS: has no effect. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -382,7 +383,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { /** * Clears the cache from the currently presented document. * - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -398,7 +399,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * Invalidates the render cache for the specified page. * * @param pageIndex {number} 0-based index of the page whose render cache should be invalidated. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -412,7 +413,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { /** * Hides the annotation toolbar * - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -426,7 +427,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { /** * Shows the annotation toolbar * - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -440,7 +441,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { /** * Toggles the annotation toolbar * - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -455,7 +456,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * Applies the passed in document Instant JSON. * * @param jsonValue {string} The document Instant JSON to apply. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -472,7 +473,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * payload - https://pspdfkit.com/guides/ios/current/importing-exporting/instant-json/#instant-annotation-json-api * * @param jsonAnnotation {string} Instant JSON of the annotation to add. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -489,7 +490,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * JSON format - https://pspdfkit.com/guides/ios/current/importing-exporting/instant-json/#instant-annotation-json-api * * @param jsonAnnotation {string} Instant JSON of the annotation to remove. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -506,7 +507,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * * @param pageIndex {number} The page to get the annotations for. * @param type {string} The type of annotations to get (See here for types https://pspdfkit.com/guides/server/current/api/json-format/) or `null` to get all annotations. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -521,7 +522,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { /** * Gets all unsaved changes to annotations. * - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -538,7 +539,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * * @param value {string} the value. * @param fullyQualifiedName {string} the fully qualified name of the form element. - * @return {Promise} callback Success (result) and error callback function. + * @returns {Promise} callback Success (result) and error callback function. * * __Supported Platforms__ * @@ -554,7 +555,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * Gets the value of the form element of the fully qualified name. * * @param fullyQualifiedName {string} description. - * @return {Promise} callback Success (result) and error callback function. + * @returns {Promise} callback Success (result) and error callback function. * * __Supported Platforms__ * @@ -570,7 +571,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * Imports all annotations from the specified XFDF file to the current document. * * @param xfdfPath {string} XFDF file path to import annotations - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -586,7 +587,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * Exports all annotations from the current document to the specified XFDF file path. * * @param xfdfPath {string} XFDF file path to export annotations - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -604,7 +605,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * @param annotationChange {string} the annotation change. Can be 'flatten', 'remove', 'embed' or 'print' * @param processedDocumentPath {string} description. * @param annotationType {string} The optional string annotationType argument. If omitted, we process 'All' annotations. The annotation type can have one of the following values: None, Undefined, Link, Highlight, StrikeOut, Underline, Squiggly, FreeText, Ink, Square, Circle, Line, Text, Stamp, Caret, RichMedia, Screen, Widget, Sound, FileAttachment, Polygon, PolyLine, Popup, Watermark, TrapNet, 3D, Redact, All. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * @@ -622,7 +623,7 @@ export class PSPDFKit extends AwesomeCordovaNativePlugin { * @param html {string} HTML string. * @param fileName {string} File name of the generated PDF. * @param options {string} Options to be considered when converting the HTML string to PDF. - * @return {Promise} callback Success (or result) and error callback function. + * @returns {Promise} callback Success (or result) and error callback function. * * __Supported Platforms__ * diff --git a/src/@awesome-cordova-plugins/plugins/purchases/index.ts b/src/@awesome-cordova-plugins/plugins/purchases/index.ts index e802822e..a9008b6e 100644 --- a/src/@awesome-cordova-plugins/plugins/purchases/index.ts +++ b/src/@awesome-cordova-plugins/plugins/purchases/index.ts @@ -7,7 +7,7 @@ import { Observable } from 'rxjs'; * * Enum for attribution networks * @readonly - * @enum {Number} + * @enum {number} */ export enum ATTRIBUTION_NETWORKS { APPLE_SEARCH_ADS = 0, @@ -76,7 +76,7 @@ export enum BILLING_FEATURE { * * Enum for attribution networks * @readonly - * @enum {String} + * @enum {string} */ export enum ProductType { SUBS = 'subs', @@ -195,7 +195,6 @@ export enum INTRO_ELIGIBILITY_STATUS { * ## Getting Started * * For more detailed information, you can view our complete documentation at [docs.revenuecat.com](https://docs.revenuecat.com/docs). - * * @usage * #### 1. Get a RevenueCat API key * @@ -223,7 +222,6 @@ export enum INTRO_ELIGIBILITY_STATUS { * ### Requirements * Requires XCode 11.0+ and minimum target iOS 9.0+ * This plugin has been tested with cordova-plugin-purchases@ - * * @interfaces * PurchasesError * IntroEligibility @@ -251,13 +249,15 @@ export class Purchases extends AwesomeCordovaNativePlugin { static ATTRIBUTION_NETWORKS = ATTRIBUTION_NETWORK; /** * Enum for attribution networks + * * @readonly - * @enum {Number} + * @enum {number} */ static ATTRIBUTION_NETWORK = ATTRIBUTION_NETWORK; /** * Supported SKU types. + * * @readonly * @enum {string} */ @@ -272,6 +272,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Replace SKU's ProrationMode. + * * @readonly * @enum {number} */ @@ -279,6 +280,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Enumeration of all possible Package types. + * * @readonly * @enum {string} */ @@ -286,6 +288,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Enum of different possible states for intro price eligibility status. + * * @readonly * @enum {number} */ @@ -293,6 +296,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Sets up Purchases with your API key and an app user id. + * * @param {string} apiKey RevenueCat API Key. Needs to be a String * @param {string?} appUserID A unique id for identifying the user * @param {boolean} observerMode An optional boolean. Set this to TRUE if you have your own IAP implementation and @@ -309,6 +313,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { * Set this to true if you are passing in an appUserID but it is anonymous, this is true by default if you didn't pass an appUserID * If a user tries to purchase a product that is active on the current app store account, we will treat it as a restore and alias * the new ID with the previous id. + * * @param allowSharing {boolean} true if enabled, false to disabled */ @Cordova({ sync: true }) @@ -318,7 +323,6 @@ export class Purchases extends AwesomeCordovaNativePlugin { * Add a dict of attribution information * * @deprecated Use the set functions instead. - * * @param {object} data Attribution data from any of the attribution networks in Purchases.ATTRIBUTION_NETWORKS * @param {ATTRIBUTION_NETWORK} network Which network, see Purchases.ATTRIBUTION_NETWORK * @param {string?} networkUserId An optional unique id for identifying the user. Needs to be a string. @@ -329,7 +333,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Gets the Offerings configured in the dashboard * - * @return {Promise} Will return a [PurchasesError] if the offerings are not properly configured in RevenueCat or if there is another error retrieving them. + * @returns {Promise} Will return a [PurchasesError] if the offerings are not properly configured in RevenueCat or if there is another error retrieving them. */ @Cordova() getOfferings(): Promise { @@ -338,10 +342,10 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Fetch the product info + * * @param {string[]} productIdentifiers Array of product identifiers * @param {PURCHASE_TYPE} type Optional type of products to fetch, can be inapp or subs. Subs by default - * - * @return {Promise} Will return a [PurchasesError] if the products are not properly configured in RevenueCat or if there is another error retrieving them. + * @returns {Promise} Will return a [PurchasesError] if the products are not properly configured in RevenueCat or if there is another error retrieving them. */ @Cordova({ successIndex: 1, @@ -364,8 +368,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { * @param {UpgradeInfo} upgradeInfo Android only. Optional UpgradeInfo you wish to upgrade from containing the oldSKU * and the optional prorationMode. * @param {PURCHASE_TYPE} type Optional type of product, can be inapp or subs. Subs by default - * - * @return {Promise} A [PurchasesError] is triggered after an error or when the user cancels the purchase. + * @returns {Promise} A [PurchasesError] is triggered after an error or when the user cancels the purchase. * If user cancelled, userCancelled will be true */ @Cordova({ @@ -386,8 +389,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { * @param {PurchasesPackage} aPackage The Package you wish to purchase. You can get the Packages by calling getOfferings * @param {UpgradeInfo} upgradeInfo Android only. Optional UpgradeInfo you wish to upgrade from containing the oldSKU * and the optional prorationMode. - * - * @return {Promise} A [PurchasesError] is triggered after an error or when the user cancels the purchase. + * @returns {Promise} A [PurchasesError] is triggered after an error or when the user cancels the purchase. * If user cancelled, userCancelled will be true */ @Cordova({ @@ -404,7 +406,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Restores a user's previous purchases and links their appUserIDs to any user's also using those purchases. * - * @return {Promise} Errors are of type [PurchasesError] + * @returns {Promise} Errors are of type [PurchasesError] */ @Cordova() restoreTransactions(): Promise { @@ -414,7 +416,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Get the appUserID that is currently in placed in the SDK * - * @return {string} + * @returns {string} */ @Cordova({ sync: true }) getAppUserID(): string { @@ -424,9 +426,9 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * This function will logIn the current user with an appUserID. Typically this would be used after a log in * to identify a user without calling configure. - * @param {String} appUserID The appUserID that should be linked to the currently user * - * @return {Promise} an object that contains the purchaserInfo after logging in, as well as a boolean indicating + * @param {string} appUserID The appUserID that should be linked to the currently user + * @returns {Promise} an object that contains the purchaserInfo after logging in, as well as a boolean indicating * whether the user has just been created for the first time in the RevenueCat backend. */ @Cordova() @@ -437,7 +439,8 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Logs out the Purchases client clearing the saved appUserID. This will generate a random user id and save it in the cache. * If the current user is already anonymous, this will produce a PurchasesError. - * @return {Promise} new purchaser info after resetting. + * + * @returns {Promise} new purchaser info after resetting. */ @Cordova() logOut(): Promise { @@ -448,8 +451,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { * @deprecated, use logIn instead. * This function will alias two appUserIDs together. * @param newAppUserID {String} The new appUserID that should be linked to the currently identified appUserID. Needs to be a string. - * - * @return {Promise} Errors are of type [PurchasesError] and get normally triggered if there + * @returns {Promise} Errors are of type [PurchasesError] and get normally triggered if there * is an error retrieving the new purchaser info for the new user or if there is an error creating the alias. */ @Cordova() @@ -461,8 +463,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { * @deprecated, use logIn instead. * This function will identify the current user with an appUserID. Typically this would be used after a logout to identify a new user without calling configure * @param newAppUserID {String} The new appUserID that should be linked to the currently identified appUserID. Needs to be a string. - * - * @return {Promise} Errors are of type [PurchasesError] and get normally triggered if there + * @returns {Promise} Errors are of type [PurchasesError] and get normally triggered if there * is an error retrieving the new purchaser info for the new user. */ @Cordova() @@ -473,8 +474,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * @deprecated, use logOut instead. * Resets the Purchases client clearing the saved appUserID. This will generate a random user id and save it in the cache. - * - * @return {Promise} Errors are of type [PurchasesError] and get normally triggered if there + * @returns {Promise} Errors are of type [PurchasesError] and get normally triggered if there * is an error retrieving the new purchaser info for the new user. */ @Cordova() @@ -486,7 +486,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { * Gets the current purchaser info. This call will return the cached purchaser info unless the cache is stale, in which case, * it will make a network call to retrieve it from the servers. * - * @return {Promise} Errors are of type [PurchasesError] and get normally triggered if there + * @returns {Promise} Errors are of type [PurchasesError] and get normally triggered if there * is an error retrieving the purchaser info. */ @Cordova() @@ -497,7 +497,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Returns an observable that can be used to receive updates on the purchaser info * - * @return {Observable} + * @returns {Observable} */ @Cordova({ eventObservable: true, @@ -510,6 +510,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Enables/Disables debugs logs + * * @param {boolean} enabled true to enable debug logs, false to disable */ @Cordova({ sync: true }) @@ -526,7 +527,8 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * iOS only. - * @param {Boolean} enabled Set this property to true *only* when testing the ask-to-buy / SCA purchases flow. + * + * @param {boolean} enabled Set this property to true *only* when testing the ask-to-buy / SCA purchases flow. * More information: http://errors.rev.cat/ask-to-buy */ @Cordova({ sync: true }) @@ -534,13 +536,14 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Enable automatic collection of Apple Search Ads attribution. Disabled by default. - * @param {Boolean} enabled Enable or not automatic collection + * + * @param {boolean} enabled Enable or not automatic collection */ @Cordova({ sync: true }) setAutomaticAppleSearchAdsAttributionCollection(enabled: boolean): void {} /** - * @return {Promise} A boolean indicating if the `appUserID` has been generated + * @returns {Promise} A boolean indicating if the `appUserID` has been generated * by RevenueCat or not. */ @Cordova({ sync: true }) @@ -558,7 +561,6 @@ export class Purchases extends AwesomeCordovaNativePlugin { * `INTRO_ELIGIBILITY_STATUS_UNKNOWN`. The best course of action on unknown status is to display the non-intro * pricing, to not create a misleading situation. To avoid this, make sure you are testing with the latest version of * iOS so that the subscription group can be collected by the SDK. Android always returns INTRO_ELIGIBILITY_STATUS_UNKNOWN. - * * @param productIdentifiers Array of product identifiers for which you want to compute eligibility * @returns { Promise> } Map of IntroEligibility per productId */ @@ -571,6 +573,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Sets a function to be called on purchases initiated on the Apple App Store. This is only used in iOS. + * * @param {ShouldPurchasePromoProductListener} shouldPurchasePromoProductListener Called when a user initiates a * promotional in-app purchase from the App Store. If your app is able to handle a purchase at the current time, run * the deferredPurchase function. If the app is not in a state to make a purchase: cache the deferredPurchase, then @@ -583,6 +586,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Removes a given ShouldPurchasePromoProductListener + * * @param {ShouldPurchasePromoProductListener} listenerToRemove ShouldPurchasePromoProductListener reference of the listener to remove * @returns {boolean} True if listener was removed, false otherwise */ @@ -717,6 +721,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Subscriber attribute associated with the AppsFlyer Id for the user * Required for the RevenueCat AppsFlyer integration + * * @param appsflyerID Empty String or null will delete the subscriber attribute. */ @Cordova({ sync: true }) @@ -763,9 +768,11 @@ export class Purchases extends AwesomeCordovaNativePlugin { * * Note: Billing features are only relevant to Google Play Android users. * For other stores and platforms, billing features won't be checked. + * * @param feature An array of feature types to check for support. Feature types must be one of * [BILLING_FEATURE]. By default, is an empty list and no specific feature support will be checked. - * @return {Promise} Or [PurchasesError] if there is an error. + * @param features + * @returns {Promise} Or [PurchasesError] if there is an error. */ @Cordova() canMakePayments(features: BILLING_FEATURE[] = []): Promise { @@ -774,6 +781,7 @@ export class Purchases extends AwesomeCordovaNativePlugin { /** * Set this property to your proxy URL before configuring Purchases *only* if you've received a proxy key value from your RevenueCat contact. + * * @param url Proxy URL as a string. */ @Cordova({ sync: true }) diff --git a/src/@awesome-cordova-plugins/plugins/push/index.ts b/src/@awesome-cordova-plugins/plugins/push/index.ts index 5e50aaa7..fb7517ee 100644 --- a/src/@awesome-cordova-plugins/plugins/push/index.ts +++ b/src/@awesome-cordova-plugins/plugins/push/index.ts @@ -74,7 +74,7 @@ export interface IOSPushOptions { /** * If true the device shows an alert on receipt of notification. - * **Note**: the value you set this option to the first time you call the init + * Note**: the value you set this option to the first time you call the init * method will be how the application always acts. Once this is set * programmatically in the init method it can only be changed manually by the * user in Settings>Notifications>App Name. This is normal iOS behaviour. @@ -83,7 +83,7 @@ export interface IOSPushOptions { /** * If true the device sets the badge number on receipt of notification. - * **Note**: the value you set this option to the first time you call the init + * Note**: the value you set this option to the first time you call the init * method will be how the application always acts. Once this is set * programmatically in the init method it can only be changed manually by the * user in Settings>Notifications>App Name. This is normal iOS behaviour. @@ -92,7 +92,7 @@ export interface IOSPushOptions { /** * If true the device plays a sound on receipt of notification. - * **Note**: the value you set this option to the first time you call the init + * Note**: the value you set this option to the first time you call the init * method will be how the application always acts. Once this is set * programmatically in the init method it can only be changed manually by the * user in Settings>Notifications>App Name. This is normal iOS behaviour. @@ -107,7 +107,7 @@ export interface IOSPushOptions { /** * If the array contains one or more strings each string will be used to * subscribe to a GcmPubSub topic. - * **Note**: only usable in conjunction with `senderID`. + * Note**: only usable in conjunction with `senderID`. */ topics?: string[]; @@ -248,7 +248,6 @@ export type PushEvent = string; * Requires Cordova plugin: `phonegap-plugin-push`. For more info, please see the [Push plugin docs](https://github.com/phonegap/phonegap-plugin-push). * * For TypeScript users, see the [Push plugin docs about using TypeScript for custom notifications](https://github.com/phonegap/phonegap-plugin-push/blob/master/docs/TYPESCRIPT.md). - * * @usage * ```typescript * import { Push, PushObject, PushOptions } from '@awesome-cordova-plugins/push/ngx'; @@ -314,7 +313,6 @@ export type PushEvent = string; * * * ``` - * * @interfaces * RegistrationEventResponse * NotificationEventResponse @@ -336,8 +334,9 @@ export type PushEvent = string; export class Push extends AwesomeCordovaNativePlugin { /** * Init push notifications + * * @param options {PushOptions} - * @return {PushObject} + * @returns {PushObject} */ init(options: PushOptions): PushObject { return new PushObject(options); @@ -345,7 +344,8 @@ export class Push extends AwesomeCordovaNativePlugin { /** * Check whether the push notification permission has been granted. - * @return {Promise<{isEnabled: boolean}>} Returns a Promise that resolves with an object with one property: isEnabled, a boolean that indicates if permission has been granted. + * + * @returns {Promise<{isEnabled: boolean}>} Returns a Promise that resolves with an object with one property: isEnabled, a boolean that indicates if permission has been granted. */ @Cordova() hasPermission(): Promise<{ isEnabled: boolean }> { @@ -354,6 +354,7 @@ export class Push extends AwesomeCordovaNativePlugin { /** * Create a new notification channel for Android O and above. + * * @param channel {Channel} */ @Cordova({ @@ -365,6 +366,7 @@ export class Push extends AwesomeCordovaNativePlugin { /** * Delete a notification channel for Android O and above. + * * @param id {string} */ @Cordova({ @@ -376,7 +378,8 @@ export class Push extends AwesomeCordovaNativePlugin { /** * Returns a list of currently configured channels. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() listChannels(): Promise { @@ -405,8 +408,9 @@ export class PushObject { /** * Adds an event listener + * * @param event {string} - * @return {Observable} + * @returns {Observable} */ @CordovaInstance({ observable: true, @@ -433,6 +437,7 @@ export class PushObject { * The count is an integer indicating what number should show up in the badge. * Passing 0 will clear the badge. * Each notification event contains a data.count value which can be used to set the badge to correct number. + * * @param count */ @CordovaInstance({ @@ -454,6 +459,7 @@ export class PushObject { * iOS only * Tells the OS that you are done processing a background push notification. * successHandler gets called when background push processing is successfully completed. + * * @param [id] */ @CordovaInstance({ @@ -473,8 +479,9 @@ export class PushObject { /** * The subscribe method is used when the application wants to subscribe a new topic to receive push notifications. + * * @param topic {string} Topic to subscribe to. - * @return {Promise} + * @returns {Promise} */ @CordovaInstance() subscribe(topic: string): Promise { @@ -483,8 +490,9 @@ export class PushObject { /** * The unsubscribe method is used when the application no longer wants to receive push notifications from a specific topic but continue to receive other push messages. + * * @param topic {string} Topic to unsubscribe from. - * @return {Promise} + * @returns {Promise} */ @CordovaInstance() unsubscribe(topic: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/pushape-push/index.ts b/src/@awesome-cordova-plugins/plugins/pushape-push/index.ts index 88778124..f4e3fb85 100644 --- a/src/@awesome-cordova-plugins/plugins/pushape-push/index.ts +++ b/src/@awesome-cordova-plugins/plugins/pushape-push/index.ts @@ -77,7 +77,7 @@ export interface IOSPushOptions { /** * If true the device shows an alert on receipt of notification. - * **Note**: the value you set this option to the first time you call the init + * Note**: the value you set this option to the first time you call the init * method will be how the application always acts. Once this is set * programmatically in the init method it can only be changed manually by the * user in Settings>Notifications>App Name. This is normal iOS behaviour. @@ -86,7 +86,7 @@ export interface IOSPushOptions { /** * If true the device sets the badge number on receipt of notification. - * **Note**: the value you set this option to the first time you call the init + * Note**: the value you set this option to the first time you call the init * method will be how the application always acts. Once this is set * programmatically in the init method it can only be changed manually by the * user in Settings>Notifications>App Name. This is normal iOS behaviour. @@ -95,7 +95,7 @@ export interface IOSPushOptions { /** * If true the device plays a sound on receipt of notification. - * **Note**: the value you set this option to the first time you call the init + * Note**: the value you set this option to the first time you call the init * method will be how the application always acts. Once this is set * programmatically in the init method it can only be changed manually by the * user in Settings>Notifications>App Name. This is normal iOS behaviour. @@ -110,7 +110,7 @@ export interface IOSPushOptions { /** * If the array contains one or more strings each string will be used to * subscribe to a GcmPubSub topic. - * **Note**: only usable in conjunction with `senderID`. + * Note**: only usable in conjunction with `senderID`. */ topics?: string[]; @@ -273,7 +273,6 @@ export interface PushapeRegistrationEventResponse extends RegistrationEventRespo * Requires Cordova plugin: `pushape-cordova-push`. For more info, please see the [Pushape plugin docs](https://github.com/gluelabs/pushape-cordova-push). * * For TypeScript users, see the [Pushape plugin docs about using TypeScript for custom notifications](https://github.com/gluelabs/pushape-cordova-push/blob/master/docs/PUSHAPE_TYPESCRIPT.md). - * * @usage * ```typescript * import { PushapePush } from '@awesome-cordova-plugins/pushape-push/ngx'; @@ -286,7 +285,6 @@ export interface PushapeRegistrationEventResponse extends RegistrationEventRespo * * * ``` - * * @interfaces * PushapeRegistrationEventResponse * NotificationEventResponse @@ -309,8 +307,9 @@ export interface PushapeRegistrationEventResponse extends RegistrationEventRespo export class PushapePush extends AwesomeCordovaNativePlugin { /** * Init push notifications + * * @param options {PushapeOptions} - * @return {PushObject} + * @returns {PushObject} */ init(options: PushapeOptions): PushObject { return new PushObject(options); @@ -318,7 +317,8 @@ export class PushapePush extends AwesomeCordovaNativePlugin { /** * Check whether the push notification permission has been granted. - * @return {Promise<{isEnabled: boolean}>} Returns a Promise that resolves with an object with one property: isEnabled, a boolean that indicates if permission has been granted. + * + * @returns {Promise<{isEnabled: boolean}>} Returns a Promise that resolves with an object with one property: isEnabled, a boolean that indicates if permission has been granted. */ @Cordova() hasPermission(): Promise<{ isEnabled: boolean }> { @@ -327,6 +327,7 @@ export class PushapePush extends AwesomeCordovaNativePlugin { /** * Create a new notification channel for Android O and above. + * * @param channel {Channel} */ @Cordova({ @@ -338,6 +339,7 @@ export class PushapePush extends AwesomeCordovaNativePlugin { /** * Delete a notification channel for Android O and above. + * * @param id {string} */ @Cordova({ @@ -349,7 +351,8 @@ export class PushapePush extends AwesomeCordovaNativePlugin { /** * Returns a list of currently configured channels. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() listChannels(): Promise { @@ -378,8 +381,9 @@ export class PushObject { /** * Adds an event listener + * * @param event {string} - * @return {Observable} + * @returns {Observable} */ @CordovaInstance({ observable: true, @@ -406,6 +410,7 @@ export class PushObject { * The count is an integer indicating what number should show up in the badge. * Passing 0 will clear the badge. * Each notification event contains a data.count value which can be used to set the badge to correct number. + * * @param count */ @CordovaInstance({ @@ -427,6 +432,7 @@ export class PushObject { * iOS only * Tells the OS that you are done processing a background push notification. * successHandler gets called when background push processing is successfully completed. + * * @param [id] */ @CordovaInstance({ @@ -446,8 +452,9 @@ export class PushObject { /** * The subscribe method is used when the application wants to subscribe a new topic to receive push notifications. + * * @param topic {string} Topic to subscribe to. - * @return {Promise} + * @returns {Promise} */ @CordovaInstance() subscribe(topic: string): Promise { @@ -456,8 +463,9 @@ export class PushObject { /** * The unsubscribe method is used when the application no longer wants to receive push notifications from a specific topic but continue to receive other push messages. + * * @param topic {string} Topic to unsubscribe from. - * @return {Promise} + * @returns {Promise} */ @CordovaInstance() unsubscribe(topic: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/safari-view-controller/index.ts b/src/@awesome-cordova-plugins/plugins/safari-view-controller/index.ts index a3114159..c763ae6a 100644 --- a/src/@awesome-cordova-plugins/plugins/safari-view-controller/index.ts +++ b/src/@awesome-cordova-plugins/plugins/safari-view-controller/index.ts @@ -21,7 +21,6 @@ export interface SafariViewControllerOptions { * For displaying read-only web content. * * Requires Cordova plugin: `cordova-plugin-safariviewcontroller`. For more info, please see the [Safari View Controller plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-safariviewcontroller). - * * @usage * ```typescript * import { SafariViewController } from '@awesome-cordova-plugins/safari-view-controller/ngx'; @@ -70,6 +69,7 @@ export interface SafariViewControllerOptions { export class SafariViewController extends AwesomeCordovaNativePlugin { /** * Checks if SafariViewController is available + * * @returns {Promise} */ @Cordova() @@ -79,6 +79,7 @@ export class SafariViewController extends AwesomeCordovaNativePlugin { /** * Shows Safari View Controller + * * @param options {SafariViewControllerOptions} optional * @returns {Observable} */ @@ -101,6 +102,7 @@ export class SafariViewController extends AwesomeCordovaNativePlugin { /** * Tries to connect to the Chrome's custom tabs service. you must call this method before calling any of the other methods listed below. + * * @returns {Promise} */ @Cordova() @@ -110,6 +112,7 @@ export class SafariViewController extends AwesomeCordovaNativePlugin { /** * Call this method whenever there's a chance the user will open an external url. + * * @returns {Promise} */ @Cordova() @@ -119,7 +122,9 @@ export class SafariViewController extends AwesomeCordovaNativePlugin { /** * For even better performance optimization, call this methods if there's more than a 50% chance the user will open a certain URL. + * * @param url{string} + * @param url * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/screen-orientation/index.ts b/src/@awesome-cordova-plugins/plugins/screen-orientation/index.ts index e1f8fa02..fa5d7a07 100644 --- a/src/@awesome-cordova-plugins/plugins/screen-orientation/index.ts +++ b/src/@awesome-cordova-plugins/plugins/screen-orientation/index.ts @@ -9,7 +9,6 @@ import { Observable } from 'rxjs'; * Cordova plugin to set/lock the screen orientation in a common way. * * Requires Cordova plugin: `cordova-plugin-screen-orientation`. For more info, please see the [Screen Orientation plugin docs](https://github.com/apache/cordova-plugin-screen-orientation). - * * @usage * ```typescript * import { ScreenOrientation } from '@awesome-cordova-plugins/screen-orientation/ngx'; @@ -36,7 +35,6 @@ import { Observable } from 'rxjs'; * ); * * ``` - * * @advanced * * Accepted orientation values: @@ -49,7 +47,6 @@ import { Observable } from 'rxjs'; * | landscape-secondary | The orientation is in the secondary landscape mode. | * | portrait | The orientation is either portrait-primary or portrait-secondary (sensor). | * | landscape | The orientation is either landscape-primary or landscape-secondary (sensor). | - * */ @Plugin({ pluginName: 'ScreenOrientation', @@ -74,7 +71,8 @@ export class ScreenOrientation extends AwesomeCordovaNativePlugin { }; /** * Listen to orientation change event - * @return {Observable} + * + * @returns {Observable} */ @Cordova({ eventObservable: true, @@ -88,8 +86,9 @@ export class ScreenOrientation extends AwesomeCordovaNativePlugin { /** * Lock the orientation to the passed value. * See below for accepted values + * * @param orientation {string} The orientation which should be locked. Accepted values see table above. - * @return {Promise} + * @returns {Promise} */ @Cordova({ otherPromise: true }) lock(orientation: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/secure-storage-echo/index.ts b/src/@awesome-cordova-plugins/plugins/secure-storage-echo/index.ts index 90694c12..aa5cb793 100644 --- a/src/@awesome-cordova-plugins/plugins/secure-storage-echo/index.ts +++ b/src/@awesome-cordova-plugins/plugins/secure-storage-echo/index.ts @@ -38,6 +38,7 @@ export class SecureStorageEchoObject { /** * Gets a stored item + * * @param key {string} * @returns {Promise} */ @@ -50,6 +51,7 @@ export class SecureStorageEchoObject { /** * Stores a value + * * @param key {string} * @param value {string} * @returns {Promise} @@ -63,6 +65,7 @@ export class SecureStorageEchoObject { /** * Removes a single stored item + * * @param key {string} * @returns {Promise} returns a promise that resolves with the key that was removed */ @@ -75,6 +78,7 @@ export class SecureStorageEchoObject { /** * Get all references from the storage. + * * @returns {Promise} returns a promise that resolves with array of keys storage */ @CordovaInstance({ @@ -86,6 +90,7 @@ export class SecureStorageEchoObject { /** * Clear all references from the storage. + * * @returns {Promise} */ @CordovaInstance({ @@ -97,6 +102,7 @@ export class SecureStorageEchoObject { /** * Brings up the screen-lock settings + * * @returns {Promise} */ @CordovaInstance() @@ -113,7 +119,6 @@ export class SecureStorageEchoObject { * Requires Cordova plugin: `cordova-plugin-secure-storage-echo`. For more info, please see the [Cordova Secure Storage docs](https://github.com/mibrito707/cordova-plugin-secure-storage-echo). * * The browser platform is supported as a mock only. Key/values are stored unencrypted in localStorage. - * * @usage * * ```typescript @@ -162,7 +167,9 @@ export class SecureStorageEchoObject { export class SecureStorageEcho extends AwesomeCordovaNativePlugin { /** * Creates a namespaced storage. + * * @param store {string} + * @param options * @returns {Promise} */ @CordovaCheck() diff --git a/src/@awesome-cordova-plugins/plugins/secure-storage/index.ts b/src/@awesome-cordova-plugins/plugins/secure-storage/index.ts index 7a9c3b43..33f979af 100644 --- a/src/@awesome-cordova-plugins/plugins/secure-storage/index.ts +++ b/src/@awesome-cordova-plugins/plugins/secure-storage/index.ts @@ -15,6 +15,7 @@ export class SecureStorageObject { /** * Gets a stored item + * * @param key {string} * @returns {Promise} */ @@ -27,6 +28,7 @@ export class SecureStorageObject { /** * Stores a value + * * @param key {string} * @param value {string} * @returns {Promise} @@ -40,6 +42,7 @@ export class SecureStorageObject { /** * Removes a single stored item + * * @param key {string} * @returns {Promise} returns a promise that resolves with the key that was removed */ @@ -52,6 +55,7 @@ export class SecureStorageObject { /** * Get all references from the storage. + * * @returns {Promise} returns a promise that resolves with array of keys storage */ @CordovaInstance({ @@ -63,6 +67,7 @@ export class SecureStorageObject { /** * Clear all references from the storage. + * * @returns {Promise} */ @CordovaInstance({ @@ -74,6 +79,7 @@ export class SecureStorageObject { /** * Brings up the screen-lock settings + * * @returns {Promise} */ @CordovaInstance() @@ -90,7 +96,6 @@ export class SecureStorageObject { * Requires Cordova plugin: `cordova-plugin-secure-storage`. For more info, please see the [Cordova Secure Storage docs](https://github.com/Crypho/cordova-plugin-secure-storage). * * The browser platform is supported as a mock only. Key/values are stored unencrypted in localStorage. - * * @usage * * ```typescript @@ -139,6 +144,7 @@ export class SecureStorageObject { export class SecureStorage extends AwesomeCordovaNativePlugin { /** * Creates a namespaced storage. + * * @param store {string} * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/service-discovery/index.ts b/src/@awesome-cordova-plugins/plugins/service-discovery/index.ts index 944e151f..ce4475cf 100644 --- a/src/@awesome-cordova-plugins/plugins/service-discovery/index.ts +++ b/src/@awesome-cordova-plugins/plugins/service-discovery/index.ts @@ -5,7 +5,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl * @name ServiceDiscovery * @description * Simple plugin to get any SSDP / UPnP / DLNA service on a local network - * * @usage * ```typescript * import { ServiceDiscovery } from '@awesome-cordova-plugins/service-discovery'; @@ -33,8 +32,9 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl export class ServiceDiscovery extends AwesomeCordovaNativePlugin { /** * Finds and returns metadata about devices discovered on the network via SSDP / UPnP / DLNA + * * @param service {string} The service name to discover - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() getNetworkServices(service: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/shake/index.ts b/src/@awesome-cordova-plugins/plugins/shake/index.ts index a4538ce2..c31c98eb 100644 --- a/src/@awesome-cordova-plugins/plugins/shake/index.ts +++ b/src/@awesome-cordova-plugins/plugins/shake/index.ts @@ -30,6 +30,7 @@ import { Observable } from 'rxjs'; export class Shake extends AwesomeCordovaNativePlugin { /** * Watch for shake gesture + * * @param sensitivity {number} Optional sensitivity parameter. Defaults to 40 * @returns {Observable} */ diff --git a/src/@awesome-cordova-plugins/plugins/sign-in-with-apple/index.ts b/src/@awesome-cordova-plugins/plugins/sign-in-with-apple/index.ts index cc1ded13..86e572b4 100644 --- a/src/@awesome-cordova-plugins/plugins/sign-in-with-apple/index.ts +++ b/src/@awesome-cordova-plugins/plugins/sign-in-with-apple/index.ts @@ -77,6 +77,7 @@ export interface AppleSignInResponse { /** * The user's name + * * @see https://developer.apple.com/documentation/foundation/nspersonnamecomponents?language=objc */ fullName?: NSPersonNameComponents; @@ -122,8 +123,7 @@ export interface AppleSignInErrorResponse extends NSError { * they can use Sign in with Apple to set up an account and start using your app right away. * All accounts are protected with two-factor authentication for superior security, * and Apple will not track users’ activity in your app or website. - * *Source:* https://developer.apple.com/sign-in-with-apple/ - * + * Source:* https://developer.apple.com/sign-in-with-apple/ * @usage * ```typescript * import { SignInWithApple, AppleSignInResponse, AppleSignInErrorResponse, ASAuthorizationAppleIDRequest } from '@awesome-cordova-plugins/sign-in-with-apple/ngx'; @@ -163,8 +163,9 @@ export interface AppleSignInErrorResponse extends NSError { export class SignInWithApple extends AwesomeCordovaNativePlugin { /** * Starts the authorization flows named during controller initialization + * * @see https://developer.apple.com/documentation/authenticationservices/asauthorizationcontroller/3153047-performrequests - * @return {Promise} Returns a promise when authorization succeeds + * @returns {Promise} Returns a promise when authorization succeeds * @param {ASAuthorizationAppleIDRequest} options * @throws AppleSignInErrorResponse */ diff --git a/src/@awesome-cordova-plugins/plugins/smartlook/index.ts b/src/@awesome-cordova-plugins/plugins/smartlook/index.ts index 644aceeb..115301ec 100644 --- a/src/@awesome-cordova-plugins/plugins/smartlook/index.ts +++ b/src/@awesome-cordova-plugins/plugins/smartlook/index.ts @@ -250,7 +250,6 @@ export class SmartlookRenderingMode { * @description * Official Smartlook SDK plugin. * Full documentation can be found here: https://smartlook.github.io/docs/sdk/ionic/ - * * @usage * ```typescript * import { Smartlook, SmartlookSetupConfig } from '@awesome-cordova-plugins/smartlook/ngx'; @@ -298,6 +297,7 @@ export class SmartlookRenderingMode { export class Smartlook extends AwesomeCordovaNativePlugin { /** * Setup and start Smartlook SDK recording. + * * @param config SmartlookSetupConfig object. * @param config.smartlookAPIKey (required) Smartlook API key (you can obtain it in your dashboard). * @param config.fps (optional) recorded video framerate (allowed values 2-10 fps). @@ -312,6 +312,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Setup/initialize Smartlook SDK. This method DOESN'T start the recording (@see start()) + * * @param config SmartlookSetupConfig object. * @param config.smartlookAPIKey (required) Smartlook API key (you can obtain it in your dashboard). * @param config.fps (optional) recorded video framerate (allowed values 2-10 fps). @@ -342,7 +343,8 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Check if SDK is currently recording. - * @return {Promise} Returns a promise with isRecording boolean. + * + * @returns {Promise} Returns a promise with isRecording boolean. */ @Cordova() isRecording(): Promise { @@ -351,6 +353,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Resets current session and new session in dashboard is created. + * * @param resetSession SmartlookResetSession object. * @param resetSession.resetUser If set to TRUE new visitor is created in the dashboard. */ @@ -377,7 +380,8 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Check if fullscreen sensitive mode is active. - * @return {Promise} Returns a promise with isFullscreenSensitiveModeActive boolean. + * + * @returns {Promise} Returns a promise with isFullscreenSensitiveModeActive boolean. */ @Cordova() isFullscreenSensitiveModeActive(): Promise { @@ -386,6 +390,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Identify user. + * * @param identifier SmartlookUserIdentifier object. * @param identifier.idenfier (required) id that can be used to identify user and his records. * You will see this Id in Smartlook dashboard so you can pair records with concrete user. @@ -398,6 +403,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * You can configure which events are being tracked by setting eventTrackingMode. + * * @param eventTrackingMode Can be on of: * - EventTrackingMode.FULL_TRACKING ... track everything * - EventTrackingMode.IGNORE_USER_INTERACTION ... will not track touches @@ -413,6 +419,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * You can configure which events are being tracked by setting eventTrackingMode. + * * @param eventTrackingModes Array of EventTrackingModes. */ @Cordova({ sync: true }) @@ -422,6 +429,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Track custom navigation event. + * * @param navigationEvent SmartlookNavigationEvent object. * @param navigationEvent.name Controler/Activity/Page name. * @param navigationEvent.viewState One of SmartlookViewState.START or SmartlookViewState.STOP. @@ -433,11 +441,12 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Track custom event. + * * @param timedEvent SmartlookTimedCustomEventStart object. * @param timedEvent.name (required) string used to identify event in dashboard. * @param timedEvent.eventProperties (optional) timed event properties object. These properties * are going to be merged with properties passed in stop/cancel. - * @return {Promise} Returns a promise with eventId string (@see stopTimedCustomEvent(), @see cancelTimedCustomEvent()). + * @returns {Promise} Returns a promise with eventId string (@see stopTimedCustomEvent(), @see cancelTimedCustomEvent()). */ @Cordova() startTimedCustomEvent(timedEvent: SmartlookTimedCustomEventStart): Promise { @@ -446,6 +455,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Stops timed event. Duration from according start is calculated and send with the event. + * * @param timedEvent SmartlookTimedCustomEventStop object. * @param timedEvent.eventId (required) Unique event id that is used to identify this event. * @param timedEvent.eventProperties (optional) timed event properties object. These properties @@ -458,6 +468,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Cancels timed event. It calculates event duration and notes that this event has failed. + * * @param timedEvent SmartlookTimedCustomEventCancel object. * @param timedEvent.eventId (required) Unique event id that is used to identify this event. * @param timedEvent.reason (required) Short string description explaining why the event was canceled. @@ -471,6 +482,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Track custom event. + * * @param event SmartlookCustomEvent object. * @param event.name (required) string used to identify event. * @param event.eventProperties (optional) event properties object. @@ -482,6 +494,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Set global event properties that will be added to every tracked event. + * * @param properties SmartlookGlobalEventProperties object. * @param properties.globalEventProperties (required) global event properties object. * @param properties.immutable (required) If set to TRUE these properties have higher priority @@ -494,6 +507,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Check if SDK is currently recording. + * * @param property SmartlookGlobalEventProperty object. * @param property.key (required) global property key. * @param property.value (required) global property value. @@ -507,6 +521,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Remove property from global event properties. + * * @param property SmartlookGlobalEventPropertyKey object. * @param property.key (required) Global property key. */ @@ -526,6 +541,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Possibility to manually set referrer and source of the installation visible in dashboard * and accessible via filters. + * * @param referrer SmartlookReferrer object. * @param referrer.referrer (required) Desired referrer value. * @param referrer.source (required) Desired source, i.e. com.android.vending or com.amazon.venezia. @@ -537,9 +553,10 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Obtain session URL leading to our dashboard. + * * @param smartlookDashboardSessionUrl SmartlookDashboardSessionUrl object. * @param smartlookDashboardSessionUrl.withCurrentTimestamp If set to TRUE record will start at current timestamp. - * @return {Promise} Returns a promise with dashboard session URL string. + * @returns {Promise} Returns a promise with dashboard session URL string. */ @Cordova() getDashboardSessionUrl(smartlookDashboardSessionUrl: SmartlookDashboardSessionUrl): Promise { @@ -548,7 +565,8 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Obtain visitor URL leading to our dashboard. - * @return {Promise} Returns a promise with dashboard visitor URL string. + * + * @returns {Promise} Returns a promise with dashboard visitor URL string. */ @Cordova() getDashboardVisitorUrl(): Promise { @@ -558,6 +576,7 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * Integration listener can be used to obtain dashboard URL for current session and visitor. * These URLs can be propagated to various analytic tools/SDKs. + * * @param integrationListener SmartlookIntegrationListener object. * @param integrationListener.onSessionReady Called when dashboard session URL is ready. Note that this URL can be accesed only by user * that has access to Smartlook dashboard (it is not public share link). @@ -571,8 +590,10 @@ export class Smartlook extends AwesomeCordovaNativePlugin { /** * By changing rendering mode you can adjust the way we render the application for recordings. + * * @param options.renderingMode Mode defining the video output of recording. Curently only * SmartlookRenderingMode.NO_RENDERING() and SmartlookRenderingMode.NATIVE() available. + * @param renderingMode */ @Cordova({ sync: true }) setRenderingMode(renderingMode: SmartlookRenderingMode): void { diff --git a/src/@awesome-cordova-plugins/plugins/sms-retriever/index.ts b/src/@awesome-cordova-plugins/plugins/sms-retriever/index.ts index c1a80ca5..6667b5ed 100644 --- a/src/@awesome-cordova-plugins/plugins/sms-retriever/index.ts +++ b/src/@awesome-cordova-plugins/plugins/sms-retriever/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Sms Retriever * @description * This plugin retrives the SMS which arrive without requiring READ permissions. - * * @usage * ```typescript * import { SmsRetriever } from '@awesome-cordova-plugins/sms-retriever'; @@ -38,7 +37,8 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class SmsRetriever extends AwesomeCordovaNativePlugin { /** * This function start wathching message arrive event and retrive message text. - * @return {Promise} Returns a promise that resolves when retrives SMS text or TIMEOUT after 5 min. + * + * @returns {Promise} Returns a promise that resolves when retrives SMS text or TIMEOUT after 5 min. */ @Cordova() startWatching(): Promise { @@ -47,7 +47,8 @@ export class SmsRetriever extends AwesomeCordovaNativePlugin { /** * This function is to get hash string of APP. - * @return {Promise} Returns a promise that resolves when successfully generate hash of APP. + * + * @returns {Promise} Returns a promise that resolves when successfully generate hash of APP. */ @Cordova() getAppHash(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/sms/index.ts b/src/@awesome-cordova-plugins/plugins/sms/index.ts index 2031a152..f29194a6 100644 --- a/src/@awesome-cordova-plugins/plugins/sms/index.ts +++ b/src/@awesome-cordova-plugins/plugins/sms/index.ts @@ -25,7 +25,6 @@ export interface SmsOptionsAndroid { * @description * * Requires Cordova plugin: cordova-sms-plugin. For more info, please see the [SMS plugin docs](https://github.com/cordova-sms/cordova-sms-plugin). - * * @usage * ```typescript * import { SMS } from '@awesome-cordova-plugins/sms/ngx'; @@ -54,6 +53,7 @@ export interface SmsOptionsAndroid { export class SMS extends AwesomeCordovaNativePlugin { /** * Sends sms to a number + * * @param phoneNumber {string|string[]} Phone number * @param message {string} Message * @param options {SmsOptions} Options @@ -69,7 +69,8 @@ export class SMS extends AwesomeCordovaNativePlugin { /** * This function lets you know if the app has permission to send SMS - * @return {Promise} returns a promise that resolves with a boolean that indicates if we have permission + * + * @returns {Promise} returns a promise that resolves with a boolean that indicates if we have permission */ @Cordova({ platforms: ['Android'], diff --git a/src/@awesome-cordova-plugins/plugins/social-sharing/index.ts b/src/@awesome-cordova-plugins/plugins/social-sharing/index.ts index 38318891..b475458b 100644 --- a/src/@awesome-cordova-plugins/plugins/social-sharing/index.ts +++ b/src/@awesome-cordova-plugins/plugins/social-sharing/index.ts @@ -8,7 +8,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * Share text, files, images, and links via social networks, sms, and email. * * For Browser usage check out the Web Share API docs: https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin#5-web-share-api - * * @usage * ```typescript * import { SocialSharing } from '@awesome-cordova-plugins/social-sharing/ngx'; @@ -43,6 +42,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Shares using the share sheet + * * @param message {string} The message you would like to share. * @param subject {string} The subject * @param file {string|string[]} URL(s) to file(s) or image(s), local path(s) to file(s) or image(s), or base64 data of an image. Only the first file/image will be used on Windows Phone. @@ -59,7 +59,13 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Shares using the share sheet with additional options and returns a result object or an error message (requires plugin version 5.1.0+) + * * @param options {object} The options object with the message, subject, files, url and chooserTitle properties. + * @param options.message + * @param options.subject + * @param options.files + * @param options.url + * @param options.chooserTitle * @returns {Promise} */ @Cordova({ @@ -77,6 +83,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Checks if you can share via a specific app. + * * @param appName {string} App name or package name. Examples: instagram or com.apple.social.facebook * @param message {string} * @param subject {string} @@ -95,6 +102,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Shares directly to Twitter + * * @param message {string} * @param image {string} * @param url {string} @@ -111,6 +119,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Shares directly to Facebook + * * @param message {string} * @param image {string} * @param url {string} @@ -127,6 +136,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Shares directly to Facebook with a paste message hint + * * @param message {string} * @param image {string} * @param url {string} @@ -149,6 +159,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Shares directly to Instagram + * * @param message {string} * @param image {string} * @returns {Promise} @@ -162,6 +173,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Shares directly to WhatsApp + * * @param message {string} * @param image {string} * @param url {string} @@ -178,6 +190,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Shares directly to a WhatsApp Contact + * * @param receiver {string} Pass phone number on Android, and Addressbook ID (abid) on iOS * @param message {string} Message to send * @param image {string} Image to send (does not work on iOS @@ -195,6 +208,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Share via SMS + * * @param messge {string} message to send * @param phoneNumber {string} Number or multiple numbers seperated by commas * @returns {Promise} @@ -208,6 +222,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Checks if you can share via email + * * @returns {Promise} */ @Cordova({ @@ -219,6 +234,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Share via Email + * * @param message {string} * @param subject {string} * @param to {string[]} @@ -245,6 +261,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Share via AppName + * * @param appName {string} App name or package name. Examples: instagram or com.apple.social.facebook * @param message {string} * @param subject {string} @@ -263,6 +280,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * defines the popup position before call the share method. + * * @param targetBounds {string} left, top, width, height */ @Cordova({ @@ -273,6 +291,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Save an array of images to the camera roll + * * @param {string|string[]} fileOrFileArray Single or multiple files * @returns {Promise } */ @@ -285,6 +304,7 @@ export class SocialSharing extends AwesomeCordovaNativePlugin { /** * Shares directly to a WhatsApp Contact with phone number. + * * @param phone {string} Pass phone number * @param message {string} Message to send * @param fileOrFileArray fileOrFileArray Single or multiple files diff --git a/src/@awesome-cordova-plugins/plugins/speech-recognition/index.ts b/src/@awesome-cordova-plugins/plugins/speech-recognition/index.ts index e2d5a706..77aa2b8f 100644 --- a/src/@awesome-cordova-plugins/plugins/speech-recognition/index.ts +++ b/src/@awesome-cordova-plugins/plugins/speech-recognition/index.ts @@ -54,7 +54,6 @@ export interface SpeechRecognitionListeningOptionsAndroid { * @name Speech Recognition * @description * This plugin does speech recognition using cloud services - * * @usage * ```typescript * import { SpeechRecognition } from '@awesome-cordova-plugins/speech-recognition/ngx'; @@ -110,7 +109,8 @@ export interface SpeechRecognitionListeningOptionsAndroid { export class SpeechRecognition extends AwesomeCordovaNativePlugin { /** * Check feature available - * @return {Promise} + * + * @returns {Promise} */ @Cordova() isRecognitionAvailable(): Promise { @@ -119,7 +119,9 @@ export class SpeechRecognition extends AwesomeCordovaNativePlugin { /** * Start the recognition process - * @return {Promise< string[] >} list of recognized terms + * + * @param options + * @returns {Promise< string[] >} list of recognized terms */ @Cordova({ callbackOrder: 'reverse', @@ -139,7 +141,8 @@ export class SpeechRecognition extends AwesomeCordovaNativePlugin { /** * Get the list of supported languages - * @return {Promise< string[] >} list of languages + * + * @returns {Promise< string[] >} list of languages */ @Cordova() getSupportedLanguages(): Promise { @@ -148,7 +151,8 @@ export class SpeechRecognition extends AwesomeCordovaNativePlugin { /** * Check permission - * @return {Promise} has permission + * + * @returns {Promise} has permission */ @Cordova() hasPermission(): Promise { @@ -157,7 +161,8 @@ export class SpeechRecognition extends AwesomeCordovaNativePlugin { /** * Request permissions - * @return {Promise} + * + * @returns {Promise} */ @Cordova() requestPermission(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/spinner-dialog/index.ts b/src/@awesome-cordova-plugins/plugins/spinner-dialog/index.ts index 7d275d74..f7c0b106 100644 --- a/src/@awesome-cordova-plugins/plugins/spinner-dialog/index.ts +++ b/src/@awesome-cordova-plugins/plugins/spinner-dialog/index.ts @@ -29,7 +29,6 @@ export interface SpinnerDialogIOSOptions { * Cordova plugin for showing a native spinner based on Paldom/SpinnerDialog. * * Requires Cordova plugin: `cordova-plugin-native-spinner`. For more info, please see the [Spinner Dialog plugin docs](https://github.com/greybax/cordova-plugin-native-spinner). - * * @usage * ```typescript * import { SpinnerDialog } from '@awesome-cordova-plugins/spinner-dialog/ngx'; @@ -56,6 +55,7 @@ export interface SpinnerDialogIOSOptions { export class SpinnerDialog extends AwesomeCordovaNativePlugin { /** * Shows the spinner dialog + * * @param title {string} Spinner title (shows on Android only) * @param message {string} Spinner message * @param cancelCallback {boolean|function} Set to true to set spinner not cancelable. Or provide a function to call when the user cancels the spinner. diff --git a/src/@awesome-cordova-plugins/plugins/spotify-auth/index.ts b/src/@awesome-cordova-plugins/plugins/spotify-auth/index.ts index 5b6a9abf..8d4869db 100644 --- a/src/@awesome-cordova-plugins/plugins/spotify-auth/index.ts +++ b/src/@awesome-cordova-plugins/plugins/spotify-auth/index.ts @@ -53,7 +53,6 @@ export interface AuthorizationData { * @description * Cordova plugin for authenticating with Spotify * > https://github.com/Festify/cordova-spotify-oauth - * * @usage * ```typescript * import { SpotifyAuth } from '@awesome-cordova-plugins/spotify-auth/ngx'; @@ -115,7 +114,7 @@ export class SpotifyAuth extends AwesomeCordovaNativePlugin { * Bottom line - always call this if you need a valid access token in your code. * * @param cfg {Config} configuration - * @return {Promise} + * @returns {Promise} */ @Cordova({ sync: false, @@ -130,7 +129,7 @@ export class SpotifyAuth extends AwesomeCordovaNativePlugin { * * This is akin to a "logout". * - * @return {void} + * @returns {void} */ @Cordova({ sync: true, diff --git a/src/@awesome-cordova-plugins/plugins/sqlite-db-copy/index.ts b/src/@awesome-cordova-plugins/plugins/sqlite-db-copy/index.ts index 0693cef0..44037779 100644 --- a/src/@awesome-cordova-plugins/plugins/sqlite-db-copy/index.ts +++ b/src/@awesome-cordova-plugins/plugins/sqlite-db-copy/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Sqlite Db Copy * @description * This plugin does something - * * @usage * ```typescript * import { SqliteDbCopy } from '@awesome-cordova-plugins/sqlite-db-copy/ngx'; @@ -39,9 +38,10 @@ export class SqliteDbCopy extends AwesomeCordovaNativePlugin { * location = 1; // If set will copy the database to Library folder instead of Documents folder. * or * location = 2; // It will copy the database in the default SQLite Database directory. This is the default location for database + * * @param dbname {string} Database file name available in www diretory with extension.The plugin will look for and copy the file according to the filename provided here. And the same file name should be used while opening the database via SQLitePlugin * @param location {number} Location where to copy the database for app (only applicable for ios).For Android pass 0. - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova({ successIndex: 2, @@ -52,9 +52,10 @@ export class SqliteDbCopy extends AwesomeCordovaNativePlugin { } /** * Check if database is available at external storage. Useful when trying to copying the database from device sdcard. + * * @param dbname {string} Name of the database file which is available on external or intenral storage * @param source {string} Full native path for the folder in which db file is present. The "/" must be added at the end of path. For.eg. /sdcard/mydb/. Should not include dbname. - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 2, @@ -71,11 +72,12 @@ export class SqliteDbCopy extends AwesomeCordovaNativePlugin { * location = 1; // If set will copy the database to Library folder instead of Documents folder. * or * location = 2; // It will copy the database in the default SQLite Database directory. This is the default location for database + * * @param dbname {string} Is the name of the database you want to copy. The plugin will look for and copy the file according to the filename provided here. And the same file name should be used while opening the database via SQLitePlugin * @param location {number} Location where to copy the database for app (only applicable for ios). For Android pass 0. * @param source {string} Source File location like /sdcard/mydb/db.db. Please provide a valid existing location and the dbname should be present in the path. * @param deleteolddb {boolean} A boolean value if set to true, will delete the existing db from the local app database folder before copying the new db. Please provide proper boolean value true or false; - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 4, @@ -92,11 +94,12 @@ export class SqliteDbCopy extends AwesomeCordovaNativePlugin { * location = 1; // It will copy the database from Library folder instead. * or * location = 2; // It will copy the database from the default SQLite Database directory. This is the default location for database + * * @param dbname {string} Is the name of the database you want to copy. The plugin will look for and copy the file according to the filename provided here. And the same file name should be used while opening the database via SQLitePlugin. * @param location {number} Location where to copy the database for app (only applicable for ios). For Android pass 0. * @param destination {string} Destination File location like /sdcard/mydb/ Please provide a valid existing location and "/" should be present at the end of the path. Do not append db name in the path. * @param overwrite {boolean} If set to true, then will replace the file at the destination. Otherwise will throw an error, if destination file already exists. - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 4, @@ -113,9 +116,10 @@ export class SqliteDbCopy extends AwesomeCordovaNativePlugin { * location = 1; // If set will copy the database to Library folder instead of Documents folder. * or * location = 2; // It will copy the database in the default SQLite Database directory. This is the default location for database + * * @param dbname {string} Is the name of the database you want to remove. If the database file is having any extension, please provide that also. * @param location {number} Location where to copy the database for app (only applicable for ios).For Android pass 0. - * @return {Promise} + * @returns {Promise} */ @Cordova({ successIndex: 2, diff --git a/src/@awesome-cordova-plugins/plugins/sqlite-porter/index.ts b/src/@awesome-cordova-plugins/plugins/sqlite-porter/index.ts index c89ae6a1..33f6e4e2 100644 --- a/src/@awesome-cordova-plugins/plugins/sqlite-porter/index.ts +++ b/src/@awesome-cordova-plugins/plugins/sqlite-porter/index.ts @@ -5,7 +5,6 @@ import { Injectable } from '@angular/core'; * @name SQLite Porter * @description * This Cordova/Phonegap plugin can be used to import/export to/from a SQLite database using either SQL or JSON. - * * @usage * ```typescript * import { SQLitePorter } from '@awesome-cordova-plugins/sqlite-porter/ngx'; @@ -49,9 +48,10 @@ import { Injectable } from '@angular/core'; export class SQLitePorter extends AwesomeCordovaNativePlugin { /** * Executes a set of SQL statements against the defined database. Can be used to import data defined in the SQL statements into the database, and may additionally include commands to create the table structure. + * * @param db {Object} Database object * @param sql {string} SQL statements to execute against the database - * @return {Promise} + * @returns {Promise} */ @Cordova({ callbackStyle: 'object', @@ -64,8 +64,9 @@ export class SQLitePorter extends AwesomeCordovaNativePlugin { /** * Exports a SQLite DB as a set of SQL statements. + * * @param db {Object} Database object - * @return {Promise} + * @returns {Promise} */ @Cordova({ callbackStyle: 'object', @@ -78,9 +79,10 @@ export class SQLitePorter extends AwesomeCordovaNativePlugin { /** * Converts table structure and/or row data contained within a JSON structure into SQL statements that can be executed against a SQLite database. Can be used to import data into the database and/or create the table structure. + * * @param db {Object} Database object * @param json {Object|string} JSON structure containing row data and/or table structure as either a JSON object or string - * @return {Promise} + * @returns {Promise} */ @Cordova({ callbackStyle: 'object', @@ -93,8 +95,9 @@ export class SQLitePorter extends AwesomeCordovaNativePlugin { /** * Exports a SQLite DB as a JSON structure + * * @param db {Object} Database object - * @return {Promise} + * @returns {Promise} */ @Cordova({ callbackStyle: 'object', @@ -107,8 +110,9 @@ export class SQLitePorter extends AwesomeCordovaNativePlugin { /** * Wipes all data from a database by dropping all existing tables + * * @param db {Object} Database object - * @return {Promise} + * @returns {Promise} */ @Cordova({ callbackStyle: 'object', diff --git a/src/@awesome-cordova-plugins/plugins/sqlite/index.ts b/src/@awesome-cordova-plugins/plugins/sqlite/index.ts index 3b5d67df..dd6b48b0 100644 --- a/src/@awesome-cordova-plugins/plugins/sqlite/index.ts +++ b/src/@awesome-cordova-plugins/plugins/sqlite/index.ts @@ -117,6 +117,9 @@ export class SQLiteObject { /** * Execute SQL on the opened database. Note, you must call `create` first, and * ensure it resolved and successfully opened the database. + * + * @param statement + * @param params */ @CordovaInstance() executeSql(statement: string, params?: any[]): Promise { @@ -140,10 +143,8 @@ export class SQLiteObject { /** * @name SQLite - * * @description * Access SQLite databases on the device. - * * @usage * * ```typescript @@ -169,7 +170,6 @@ export class SQLiteObject { * .catch(e => console.log(e)); * * ``` - * * @classes * SQLiteObject * @interfaces @@ -191,7 +191,7 @@ export class SQLite extends AwesomeCordovaNativePlugin { * See the plugin docs for an explanation of all options: https://github.com/litehelpers/Cordova-sqlite-storage#opening-a-database * * @param config {SQLiteDatabaseConfig} database configuration - * @return Promise + * @returns Promise */ @CordovaCheck() create(config: SQLiteDatabaseConfig): Promise { @@ -202,6 +202,7 @@ export class SQLite extends AwesomeCordovaNativePlugin { /** * Verify that both the Javascript and native part of this plugin are installed in your application + * * @returns {Promise} */ @Cordova() @@ -211,6 +212,7 @@ export class SQLite extends AwesomeCordovaNativePlugin { /** * Automatically verify basic database access operations including opening a database + * * @returns {Promise} */ @Cordova() @@ -220,6 +222,7 @@ export class SQLite extends AwesomeCordovaNativePlugin { /** * Deletes a database + * * @param config {SQLiteDatabaseConfig} database configuration * @returns {Promise} */ diff --git a/src/@awesome-cordova-plugins/plugins/star-prnt/index.ts b/src/@awesome-cordova-plugins/plugins/star-prnt/index.ts index 0f287b4a..0e364b65 100644 --- a/src/@awesome-cordova-plugins/plugins/star-prnt/index.ts +++ b/src/@awesome-cordova-plugins/plugins/star-prnt/index.ts @@ -25,7 +25,7 @@ export interface Printer { /** * Array of Printer objects returned by the portDiscovery() function */ -export interface Printers extends Array {} +export type Printers = Array; export interface PrinterStatus { /** @@ -618,13 +618,12 @@ export enum BitmapConverterRotation { /** * Push a new PrintCommand object to the array for a separate instruction to the printer. Example [{append:"text"}, {"openCashDrawer: 1"}] */ -export interface CommandsArray extends Array {} +export type CommandsArray = Array; /** * @name StarPRNT * @description - * * Ionic Native wrappers for the starprnt cordova plugin for Star Micronics Bluetooth/LAN printers - * + * Ionic Native wrappers for the starprnt cordova plugin for Star Micronics Bluetooth/LAN printers * @usage * ```typescript * import { StarPRNT } from '@awesome-cordova-plugins/star-prnt/ngx'; @@ -851,8 +850,9 @@ export class StarPRNT extends AwesomeCordovaNativePlugin { /** * Find available printers + * * @param {string} type Interface Type: All, LAN, Bluetooth, USB - * @return {Promise} Returns a promise that resolves with an array of printers + * @returns {Promise} Returns a promise that resolves with an array of printers */ @Cordova() portDiscovery(type: string): Promise { @@ -861,9 +861,10 @@ export class StarPRNT extends AwesomeCordovaNativePlugin { /** * Checks the status of the printer + * * @param {string} port Printer name i.e BT:StarMicronics * @param {string} emulation StarPrinter Emulation type: "StarPRNT", "StarPRNTL", "StarLine", "StarGraphic", "EscPos", "EscPosMobile", "StarDotImpact" - * @return {Promise} Returns a promise that resolves with the PrinterStatus object + * @returns {Promise} Returns a promise that resolves with the PrinterStatus object */ @Cordova() checkStatus(port: string, emulation: string): Promise { @@ -872,10 +873,11 @@ export class StarPRNT extends AwesomeCordovaNativePlugin { /** * Prints plain text + * * @param {string} port Printer name i.e BT:StarMicronics. Send null to use a printer connected via StarIOExtManager using the connect() function * @param {string} emulation StarPrinter Emulation type: "StarPRNT", "StarPRNTL", "StarLine", "StarGraphic", "EscPos", "EscPosMobile", "StarDotImpact" * @param {PrintObj} printObj text:string, cutReceipt?:boolean, openCashDrawer?:boolean - * @return {Promise} Success! if printed correctly or error message string returned by the SDK. + * @returns {Promise} Success! if printed correctly or error message string returned by the SDK. */ @Cordova() printRawText(port: string, emulation: string, printObj: PrintObj): Promise { @@ -884,10 +886,11 @@ export class StarPRNT extends AwesomeCordovaNativePlugin { /** * Converts the text into a bitmap image and sends it to the printer + * * @param {string} port Printer name i.e BT:StarMicronics. Send null to use a printer connected via StarIOExtManager using the connect() function * @param {string} emulation StarPrinter Emulation type: "StarPRNT", "StarPRNTL", "StarLine", "StarGraphic", "EscPos", "EscPosMobile", "StarDotImpact" * @param {RasterObj} rasterObj text:string, cutReceipt?:boolean, openCashDrawer?:boolean, fontSize:number, paperWidth:number - * @return {Promise} Success! if printed correctly or error message string returned by the SDK. + * @returns {Promise} Success! if printed correctly or error message string returned by the SDK. */ @Cordova() printRasterReceipt(port: string, emulation: string, rasterObj: RasterObj): Promise { @@ -896,10 +899,11 @@ export class StarPRNT extends AwesomeCordovaNativePlugin { /** * Gets an image from a string URI and converts it to bitmap to send it to the printer + * * @param {string} port Printer name i.e BT:StarMicronics. Send null to use a printer connected via StarIOExtManager using the connect() function * @param {string} emulation StarPrinter Emulation type: "StarPRNT", "StarPRNTL", "StarLine", "StarGraphic", "EscPos", "EscPosMobile", "StarDotImpact" * @param {ImageObj} imageObj uri:string, paperWidth?:number, cutReceipt?:boolean, openCashDrawer?:boolean - * @return {Promise} Success! if printed correctly or error message string returned by the SDK. + * @returns {Promise} Success! if printed correctly or error message string returned by the SDK. */ @Cordova() printImage(port: string, emulation: string, imageObj: ImageObj): Promise { @@ -908,9 +912,10 @@ export class StarPRNT extends AwesomeCordovaNativePlugin { /** * sends an appendPeripheral command to the printer for channels No1 and No2 + * * @param {string} port Printer name i.e BT:StarMicronics. Send null to use a printer connected via StarIOExtManager using the connect() function * @param {string} emulation StarPrinter Emulation type: "StarPRNT", "StarPRNTL", "StarLine", "StarGraphic", "EscPos", "EscPosMobile", "StarDotImpact" - * @return {Promise} Success! if opened or error message string returned by the SDK. + * @returns {Promise} Success! if opened or error message string returned by the SDK. */ @Cordova() openCashDrawer(port: string, emulation: string): Promise { @@ -919,10 +924,11 @@ export class StarPRNT extends AwesomeCordovaNativePlugin { /** * Sends an Array of commands to the command buffer using the Android ICommandBuilderInterface or iOS ISCBBuilderInterface + * * @param {string} port Printer name i.e BT:StarMicronics. Send null to use a printer connected via StarIOExtManager using the connect() function * @param {string} emulation StarPrinter Emulation type: "StarPRNT", "StarPRNTL", "StarLine", "StarGraphic", "EscPos", "EscPosMobile", "StarDotImpact" * @param {CommandsArray} commandsArray each command in the array should be an instance of the PrintCommand object. Example [{append:"text"}, {"openCashDrawer: 1"}] - * @return {Promise} Success! if printed correctly or error message string returned by the SDK. + * @returns {Promise} Success! if printed correctly or error message string returned by the SDK. */ @Cordova() print(port: string, emulation: string, commandsArray: CommandsArray): Promise { @@ -931,9 +937,11 @@ export class StarPRNT extends AwesomeCordovaNativePlugin { /** * Allows you to connect to the printer, keep the connection alive and receive status updates through an observable + * * @param {string} port printer name i.e BT:StarMicronics. * @param {string} emulation StarPrinter Emulation type: "StarPRNT", "StarPRNTL", "StarLine", "StarGraphic", "EscPos", "EscPosMobile", "StarDotImpact" - * @return {Observable} Success! if connected or error message string returned by the SDK. + * @param hasBarcodeReader + * @returns {Observable} Success! if connected or error message string returned by the SDK. */ @Cordova({ observable: true, @@ -945,7 +953,8 @@ export class StarPRNT extends AwesomeCordovaNativePlugin { /** * Returns an observable with the device status events. Only fires when a printer is connnected through the connect() function - * @return {Observable} dataType: printerOnline, printerOffline, printerImpossible, printerPaperEmpty, printerPaperNearEmpty, printerPaperReady, printerCoverOpen, printerCoverClose, cashDrawerOpen, cashDrawerClose + * + * @returns {Observable} dataType: printerOnline, printerOffline, printerImpossible, printerPaperEmpty, printerPaperNearEmpty, printerPaperReady, printerCoverOpen, printerCoverClose, cashDrawerOpen, cashDrawerClose */ @Cordova({ eventObservable: true, @@ -958,7 +967,8 @@ export class StarPRNT extends AwesomeCordovaNativePlugin { /** * Allows to disconnect (close the connection to the peripherals), this is useful to avoid keeping alive a connection when not in the app to save device battery * (energy consumption). You should call this function when the app is paused or closed. - * @return {Promise} Success! if connected or error message string returned by the SDK. + * + * @returns {Promise} Success! if connected or error message string returned by the SDK. */ @Cordova() disconnect(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/status-bar/index.ts b/src/@awesome-cordova-plugins/plugins/status-bar/index.ts index 25f6daf3..fb2ebb50 100644 --- a/src/@awesome-cordova-plugins/plugins/status-bar/index.ts +++ b/src/@awesome-cordova-plugins/plugins/status-bar/index.ts @@ -9,7 +9,6 @@ import { Cordova, CordovaProperty, AwesomeCordovaNativePlugin, Plugin } from '@a * Manage the appearance of the native status bar. * * Requires Cordova plugin: `cordova-plugin-statusbar`. For more info, please see the [StatusBar plugin docs](https://github.com/apache/cordova-plugin-statusbar). - * * @usage * ```typescript * import { StatusBar } from '@awesome-cordova-plugins/status-bar/ngx'; @@ -24,7 +23,6 @@ import { Cordova, CordovaProperty, AwesomeCordovaNativePlugin, Plugin } from '@a * // set status bar to white * this.statusBar.backgroundColorByHexString('#ffffff'); * ``` - * */ @Plugin({ pluginName: 'StatusBar', diff --git a/src/@awesome-cordova-plugins/plugins/streaming-media/index.ts b/src/@awesome-cordova-plugins/plugins/streaming-media/index.ts index 06e16ec4..1961f3d1 100644 --- a/src/@awesome-cordova-plugins/plugins/streaming-media/index.ts +++ b/src/@awesome-cordova-plugins/plugins/streaming-media/index.ts @@ -50,7 +50,6 @@ export interface StreamingAudioOptions { * @name Streaming Media * @description * This plugin allows you to stream audio and video in a fullscreen, native player on iOS and Android. - * * @usage * ```typescript * import { StreamingMedia, StreamingVideoOptions } from '@awesome-cordova-plugins/streaming-media/ngx'; @@ -83,6 +82,7 @@ export interface StreamingAudioOptions { export class StreamingMedia extends AwesomeCordovaNativePlugin { /** * Streams a video + * * @param videoUrl {string} The URL of the video * @param options {StreamingVideoOptions} Options */ @@ -91,6 +91,7 @@ export class StreamingMedia extends AwesomeCordovaNativePlugin { /** * Streams an audio + * * @param audioUrl {string} The URL of the audio stream * @param options {StreamingAudioOptions} Options */ diff --git a/src/@awesome-cordova-plugins/plugins/stripe/index.ts b/src/@awesome-cordova-plugins/plugins/stripe/index.ts index a6acd1a8..c59cb16b 100644 --- a/src/@awesome-cordova-plugins/plugins/stripe/index.ts +++ b/src/@awesome-cordova-plugins/plugins/stripe/index.ts @@ -108,7 +108,6 @@ export interface StripeCardTokenRes { * @name Stripe * @description * A plugin that allows you to use Stripe's Native SDKs for Android and iOS. - * * @usage * ```typescript * import { Stripe } from '@awesome-cordova-plugins/stripe/ngx'; @@ -131,7 +130,6 @@ export interface StripeCardTokenRes { * .catch(error => console.error(error)); * * ``` - * * @interfaces * StripeCardTokenParams */ @@ -146,8 +144,9 @@ export interface StripeCardTokenRes { export class Stripe extends AwesomeCordovaNativePlugin { /** * Set publishable key + * * @param publishableKey {string} Publishable key - * @return {Promise} + * @returns {Promise} */ @Cordova() setPublishableKey(publishableKey: string): Promise { @@ -156,8 +155,9 @@ export class Stripe extends AwesomeCordovaNativePlugin { /** * Create Credit Card Token + * * @param params {StripeCardTokenParams} Credit card information - * @return {Promise} returns a promise that resolves with the token object, or rejects with an error + * @returns {Promise} returns a promise that resolves with the token object, or rejects with an error */ @Cordova() createCardToken(params: StripeCardTokenParams): Promise { @@ -166,8 +166,9 @@ export class Stripe extends AwesomeCordovaNativePlugin { /** * Create a bank account token + * * @param params {StripeBankAccountParams} Bank account information - * @return {Promise} returns a promise that resolves with the token, or rejects with an error + * @returns {Promise} returns a promise that resolves with the token, or rejects with an error */ @Cordova() createBankAccountToken(params: StripeBankAccountParams): Promise { @@ -176,8 +177,9 @@ export class Stripe extends AwesomeCordovaNativePlugin { /** * Validates a credit card number + * * @param cardNumber {string} Credit card number - * @return {Promise} returns a promise that resolves if the number is valid, and rejects if it's invalid + * @returns {Promise} returns a promise that resolves if the number is valid, and rejects if it's invalid */ @Cordova() validateCardNumber(cardNumber: string): Promise { @@ -186,8 +188,9 @@ export class Stripe extends AwesomeCordovaNativePlugin { /** * Validates a CVC number + * * @param cvc {string} CVC number - * @return {Promise} returns a promise that resolves if the number is valid, and rejects if it's invalid + * @returns {Promise} returns a promise that resolves if the number is valid, and rejects if it's invalid */ @Cordova() validateCVC(cvc: string): Promise { @@ -196,9 +199,10 @@ export class Stripe extends AwesomeCordovaNativePlugin { /** * Validates an expiry date + * * @param expMonth {string} expiry month (0 - 11) * @param expYear {string} expiry year - * @return {Promise} returns a promise that resolves if the date is valid, and rejects if it's invalid + * @returns {Promise} returns a promise that resolves if the date is valid, and rejects if it's invalid */ @Cordova() validateExpiryDate(expMonth: string, expYear: string): Promise { @@ -207,8 +211,9 @@ export class Stripe extends AwesomeCordovaNativePlugin { /** * Get a card type from card number + * * @param cardNumber {string} Card number - * @return {Promise} returns a promise that resolves with the credit card type + * @returns {Promise} returns a promise that resolves with the credit card type */ @Cordova() getCardType(cardNumber: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/sum-up/index.ts b/src/@awesome-cordova-plugins/plugins/sum-up/index.ts index d8f64677..60974b1f 100644 --- a/src/@awesome-cordova-plugins/plugins/sum-up/index.ts +++ b/src/@awesome-cordova-plugins/plugins/sum-up/index.ts @@ -72,7 +72,6 @@ export class SumUpKeys { * @name SumUp * @description * Plugin to communicate with a SumUp payment terminal - * * @usage * ```typescript * import { SumUp } from '@awesome-cordova-plugins/sum-up'; @@ -133,8 +132,9 @@ export class SumUp extends AwesomeCordovaNativePlugin { * Login a user with an optional access token. * If the access token is provided and valid, the user is logged in autmatically. * Otherwise the user has to type in the credentials + * * @param sumUpKeys {SumUpKeys} - * @return {Promise} Return a SumUpResponse object + * @returns {Promise} Return a SumUpResponse object */ @Cordova() login(sumUpKeys: SumUpKeys): Promise { @@ -143,8 +143,9 @@ export class SumUp extends AwesomeCordovaNativePlugin { /** * Authenticates the account with the given access token. Parameter accessToken is required. + * * @param accessToken {string} - * @return {Promise} Return a SumUpResponse object + * @returns {Promise} Return a SumUpResponse object */ @Cordova() auth(accessToken: string): Promise { @@ -153,7 +154,8 @@ export class SumUp extends AwesomeCordovaNativePlugin { /** * Opens a new window with the all account settings of an logged in user. - * @return {Promise} Return a SumUpResponse object + * + * @returns {Promise} Return a SumUpResponse object */ @Cordova() getSettings(): Promise { @@ -162,7 +164,8 @@ export class SumUp extends AwesomeCordovaNativePlugin { /** * Logout a user from the account. - * @return {Promise} Return a SumUpResponse object + * + * @returns {Promise} Return a SumUpResponse object */ @Cordova() logout(): Promise { @@ -171,7 +174,8 @@ export class SumUp extends AwesomeCordovaNativePlugin { /** * Checks whether the user is logged in or not and returns an object with the field isLoggedIn which is a boolean value. - * @return {Promise} Return a SumUpResponse object + * + * @returns {Promise} Return a SumUpResponse object */ @Cordova() isLoggedIn(): Promise { @@ -181,7 +185,8 @@ export class SumUp extends AwesomeCordovaNativePlugin { /** * Prepares the terminal for a payment. Checks whether the CardReader is ready to transmit and * if an instance of the CardReaderManager is available. - * @return {Promise} Return a SumUpResponse object + * + * @returns {Promise} Return a SumUpResponse object */ @Cordova() prepare(): Promise { @@ -190,7 +195,8 @@ export class SumUp extends AwesomeCordovaNativePlugin { /** * Tries to close the connection to the card terminal. - * @return {Promise} Return a SumUpResponse object + * + * @returns {Promise} Return a SumUpResponse object */ @Cordova() closeConnection(): Promise { @@ -200,9 +206,10 @@ export class SumUp extends AwesomeCordovaNativePlugin { /** * Opens a native SumUp window to proceed a payment. Parameter amount and currencycode are required. * If the Payment was successful it returns an SumUpPayment object with information about the payment. + * * @param amount {number} * @param currencycode {string} - * @return {Promise} Return a SumUpResponse object + * @returns {Promise} Return a SumUpResponse object */ @Cordova() pay(amount: number, currencycode: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/system-alert-window-permission/index.ts b/src/@awesome-cordova-plugins/plugins/system-alert-window-permission/index.ts index 2d9f9b54..460a0899 100644 --- a/src/@awesome-cordova-plugins/plugins/system-alert-window-permission/index.ts +++ b/src/@awesome-cordova-plugins/plugins/system-alert-window-permission/index.ts @@ -5,7 +5,6 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl * @name System Alert Window Permission * @description * This plugin does something - * * @usage * ```typescript * import { SystemAlertWindowPermission } from '@awesome-cordova-plugins/system-alert-window-permission/ngx'; @@ -39,7 +38,8 @@ import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-pl export class SystemAlertWindowPermission extends AwesomeCordovaNativePlugin { /** * Check permission - * @return {Promise} return 0 when dont have SYSTEM_ALERT_WINDOW permission, 1 when have SYSTEM_ALERT_WINDOW permission + * + * @returns {Promise} return 0 when dont have SYSTEM_ALERT_WINDOW permission, 1 when have SYSTEM_ALERT_WINDOW permission */ @Cordova() hasPermission(): Promise { @@ -48,7 +48,8 @@ export class SystemAlertWindowPermission extends AwesomeCordovaNativePlugin { /** * Request permission - * @return {Promise} Returns a promise that resolves when something happens + * + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() requestPermission(): Promise { @@ -57,7 +58,8 @@ export class SystemAlertWindowPermission extends AwesomeCordovaNativePlugin { /** * Open notification Settings - * @return {Promise} Returns a promise that resolves when something happens + * + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() openNotificationSettings(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/taptic-engine/index.ts b/src/@awesome-cordova-plugins/plugins/taptic-engine/index.ts index c1052d7d..f940ff6d 100644 --- a/src/@awesome-cordova-plugins/plugins/taptic-engine/index.ts +++ b/src/@awesome-cordova-plugins/plugins/taptic-engine/index.ts @@ -5,7 +5,6 @@ import { Injectable } from '@angular/core'; * @name Taptic Engine * @description * An Ionic plugin to use Taptic Engine API on iPhone 7, 7 Plus or newer. - * * @usage * ```typescript * import { TapticEngine } from '@awesome-cordova-plugins/taptic-engine/ngx'; @@ -35,6 +34,7 @@ import { Injectable } from '@angular/core'; export class TapticEngine extends AwesomeCordovaNativePlugin { /** * Use selection feedback generators to indicate a change in selection. + * * @returns {Promise} Returns a promise that resolves on success and rejects on error */ @Cordova() @@ -44,6 +44,7 @@ export class TapticEngine extends AwesomeCordovaNativePlugin { /** * Use this to indicate success/failure/warning to the user. + * * @param options {Object} should be of the type { type: 'success' } (or 'warning'/'error') * @param {'success' | 'warning' | 'error'} options.type * @returns {Promise} Returns a promise that resolves on success and rejects on error @@ -55,8 +56,10 @@ export class TapticEngine extends AwesomeCordovaNativePlugin { /** * Use this to indicate success/failure/warning to the user. + * * @param options {Object} should be of the type { style: 'light' } (or 'medium'/'heavy') * @param {'light' | 'medium' | 'heavy'} options.type + * @param options.style * @returns {Promise} Returns a promise that resolves on success and rejects on error */ @Cordova() @@ -66,6 +69,7 @@ export class TapticEngine extends AwesomeCordovaNativePlugin { /** * Tell the taptic engine that a gesture for a selection change is starting. + * * @returns {Promise} */ @Cordova() @@ -75,6 +79,7 @@ export class TapticEngine extends AwesomeCordovaNativePlugin { /** * Tell the taptic engine that a selection changed during a gesture. + * * @returns {Promise} */ @Cordova() @@ -84,6 +89,7 @@ export class TapticEngine extends AwesomeCordovaNativePlugin { /** * Tell the taptic engine we are done with a gesture. This needs to be called lest resources are not properly recycled. + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/tealium-adidentifier/index.ts b/src/@awesome-cordova-plugins/plugins/tealium-adidentifier/index.ts index d309b410..9c3c1c94 100644 --- a/src/@awesome-cordova-plugins/plugins/tealium-adidentifier/index.ts +++ b/src/@awesome-cordova-plugins/plugins/tealium-adidentifier/index.ts @@ -7,7 +7,6 @@ import { Injectable } from '@angular/core'; * @description * This module depends on the [Tealium Cordova Plugin](https://github.com/tealium/cordova-plugin). Without it, this module will not do anything. * Makes the IDFA and Google Ad Identifier available in the Tealium data layer. - * * @usage * ``` * import { TealiumAdIdentifier } from '@awesome-cordova-plugins/tealium-adidentifier/ngx'; @@ -36,8 +35,9 @@ import { Injectable } from '@angular/core'; export class TealiumAdIdentifier extends AwesomeCordovaNativePlugin { /** * This function stores the ad identifier information as persistent data + * * @param instanceName {string} Your arbitrary Tealium instance name provided at init time - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() setPersistent(instanceName: string): Promise { @@ -46,8 +46,9 @@ export class TealiumAdIdentifier extends AwesomeCordovaNativePlugin { /** * This function stores the ad identifier information as volatile data + * * @param instanceName {string} Your arbitrary Tealium instance name provided at init time - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() setVolatile(instanceName: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/tealium-installreferrer/index.ts b/src/@awesome-cordova-plugins/plugins/tealium-installreferrer/index.ts index 665fba44..913f8eaa 100644 --- a/src/@awesome-cordova-plugins/plugins/tealium-installreferrer/index.ts +++ b/src/@awesome-cordova-plugins/plugins/tealium-installreferrer/index.ts @@ -7,7 +7,6 @@ import { Injectable } from '@angular/core'; * @description * This module depends on the [Tealium Cordova Plugin](https://github.com/tealium/cordova-plugin). Without it, this module will not do anything. * Implements a Broadcast Receiver for the INSTALL_REFERRER intent. - * * @usage * ``` * import { TealiumInstallReferrer } from '@awesome-cordova-plugins/tealium-installreferrer/ngx'; @@ -36,8 +35,9 @@ import { Injectable } from '@angular/core'; export class TealiumInstallReferrer extends AwesomeCordovaNativePlugin { /** * This function stores the install referrer information as persistent data + * * @param instanceName {string} Your arbitrary Tealium instance name provided at init time - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() setPersistent(instanceName: string): Promise { @@ -46,8 +46,9 @@ export class TealiumInstallReferrer extends AwesomeCordovaNativePlugin { /** * This function stores the install referrer information as volatile data + * * @param instanceName {string} Your arbitrary Tealium instance name provided at init time - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() setVolatile(instanceName: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/tealium/index.ts b/src/@awesome-cordova-plugins/plugins/tealium/index.ts index 105b15e2..902f64ab 100644 --- a/src/@awesome-cordova-plugins/plugins/tealium/index.ts +++ b/src/@awesome-cordova-plugins/plugins/tealium/index.ts @@ -83,8 +83,9 @@ export class Tealium extends AwesomeCordovaNativePlugin { /** * This function initializes the Tealium Cordova plugin. * This should usually be done inside the "deviceReady" handler. + * * @param config {TealConfig} - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() init(config: TealConfig): Promise { @@ -93,9 +94,10 @@ export class Tealium extends AwesomeCordovaNativePlugin { /** * This function tracks a view event in the Tealium Cordova plugin + * * @param dataObject {any} The JSON data object containing your key-value pairs * @param instanceName {string} Your arbitrary Tealium instance name provided at init time - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() trackView(dataObject: any, instanceName: string): Promise { @@ -104,9 +106,10 @@ export class Tealium extends AwesomeCordovaNativePlugin { /** * This function tracks a link event in the Tealium Cordova plugin + * * @param dataObject {any} The JSON data object containing your key-value pairs * @param instanceName {string} Your arbitrary Tealium instance name provided at init time - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() trackEvent(dataObject: any, instanceName: string): Promise { @@ -115,10 +118,11 @@ export class Tealium extends AwesomeCordovaNativePlugin { /** * This function tracks a custom event in the Tealium Cordova plugin + * * @param eventType {string} The event type, link or view * @param dataObject {any} The JSON data object containing your key-value pairs * @param instanceName {string} Your arbitrary Tealium instance name provided at init time - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() track(eventType: string, dataObject: any, instanceName: string): Promise { @@ -127,10 +131,11 @@ export class Tealium extends AwesomeCordovaNativePlugin { /** * This function adds data to the Tealium persistent data store + * * @param keyName {string} The key name that this data will be stored under for later retrieval * @param value {any} The value to be stored as persistent data * @param instanceName {string} Your arbitrary Tealium instance name provided at init time - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() addPersistent(keyName: string, value: string | string[] | any, instanceName: string): Promise { @@ -139,10 +144,11 @@ export class Tealium extends AwesomeCordovaNativePlugin { /** * This function adds data to the Tealium volatile data store + * * @param keyName {string} The key name that this data will be stored under for later retrieval * @param value {any} The value to be stored as volatile data * @param instanceName {string} Your arbitrary Tealium instance name provided at init time - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() addVolatile(keyName: string, value: string | string[], instanceName: string): Promise { @@ -151,9 +157,10 @@ export class Tealium extends AwesomeCordovaNativePlugin { /** * This function removes data from the Tealium volatile data store + * * @param keyName {string} The key name that this data will removed from the Tealium data store * @param instanceName {string} Your arbitrary Tealium instance name provided at init time - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() removeVolatile(keyName: string, instanceName: string): Promise { @@ -162,9 +169,10 @@ export class Tealium extends AwesomeCordovaNativePlugin { /** * This function removes data from the Tealium persistent data store + * * @param keyName {string} The key name that this data will removed from the Tealium data store * @param instanceName {string} Your arbitrary Tealium instance name provided at init time - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() removePersistent(keyName: string, instanceName: string): Promise { @@ -173,10 +181,11 @@ export class Tealium extends AwesomeCordovaNativePlugin { /** * This function retrieves a value from the Tealium Persistent data store + * * @param keyName {string} The key name that this data will retrieved from the Tealium data store * @param instanceName {string} Your arbitrary Tealium instance name provided at init time * @param callback {any} A callback function that will be called when the data has been retrieved - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() getPersistent(keyName: string, instanceName: string, callback: any): Promise { @@ -184,10 +193,11 @@ export class Tealium extends AwesomeCordovaNativePlugin { } /** * This function retrieves a value from the Tealium Volatile data store + * * @param keyName {string} The key name that this data will retrieved from the Tealium data store * @param instanceName {string} Your arbitrary Tealium instance name provided at init time * @param callback {any} A callback function that will be called when the data has been retrieved - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() getVolatile(keyName: string, instanceName: string, callback: any): Promise { @@ -196,10 +206,11 @@ export class Tealium extends AwesomeCordovaNativePlugin { /** * This function adds a remote command for later execution + * * @param commandName {string} The command name for this Remote Command * @param instanceName {string} Your arbitrary Tealium instance name provided at init time * @param callback {any} A callback function that will be called when the data has been retrieved - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() addRemoteCommand(commandName: string, instanceName: string, callback: any): Promise { @@ -208,7 +219,8 @@ export class Tealium extends AwesomeCordovaNativePlugin { /** * This function retrieves the Tealium Visitor ID - * @return {Promise} Returns a promise that resolves when something happens + * + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() getVisitorId(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/text-to-speech-advanced/index.ts b/src/@awesome-cordova-plugins/plugins/text-to-speech-advanced/index.ts index 073ec145..4ddaffa6 100644 --- a/src/@awesome-cordova-plugins/plugins/text-to-speech-advanced/index.ts +++ b/src/@awesome-cordova-plugins/plugins/text-to-speech-advanced/index.ts @@ -29,7 +29,6 @@ export interface TTSVoice { * @name Text To Speech Advanced * @description * Text to Speech plugin - * * @usage * ```typescript * import { TextToSpeechAdvanced } from '@awesome-cordova-plugins/text-to-speech-advanced/ngx'; @@ -58,8 +57,9 @@ export interface TTSVoice { export class TextToSpeechAdvanced extends AwesomeCordovaNativePlugin { /** * This function speaks + * * @param textOrOptions {string | TTSOptions} Text to speak or TTSOptions - * @return {Promise} Returns a promise that resolves when the speaking finishes + * @returns {Promise} Returns a promise that resolves when the speaking finishes */ @Cordova({ successIndex: 1, @@ -71,7 +71,8 @@ export class TextToSpeechAdvanced extends AwesomeCordovaNativePlugin { /** * Stop any current TTS playback - * @return {Promise} + * + * @returns {Promise} */ @Cordova() stop(): Promise { @@ -80,7 +81,8 @@ export class TextToSpeechAdvanced extends AwesomeCordovaNativePlugin { /** * Get all voices - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getVoices(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/theme-detection/index.ts b/src/@awesome-cordova-plugins/plugins/theme-detection/index.ts index 67de7926..3dbccb8b 100644 --- a/src/@awesome-cordova-plugins/plugins/theme-detection/index.ts +++ b/src/@awesome-cordova-plugins/plugins/theme-detection/index.ts @@ -14,7 +14,6 @@ export interface ThemeDetectionResponse { * @name Theme Detection * @description * Cordova plugin to detect whether dark mode is enabled or not - * * @usage * ```typescript * import { ThemeDetection } from '@awesome-cordova-plugins/theme-detection'; @@ -50,7 +49,7 @@ export interface ThemeDetectionResponse { export class ThemeDetection extends AwesomeCordovaNativePlugin { /** * - * @return {Promise} + * @returns {Promise} * Returns a promise with an object that has a boolean property which gives information if the detection is available or not */ @Cordova() @@ -60,7 +59,7 @@ export class ThemeDetection extends AwesomeCordovaNativePlugin { /** * - * @return {Promise} + * @returns {Promise} * Returns a promise with an object that has a boolean property which gives information if dark mode is enabled or not */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/three-dee-touch/index.ts b/src/@awesome-cordova-plugins/plugins/three-dee-touch/index.ts index 4848324d..a81a5fb7 100644 --- a/src/@awesome-cordova-plugins/plugins/three-dee-touch/index.ts +++ b/src/@awesome-cordova-plugins/plugins/three-dee-touch/index.ts @@ -57,7 +57,6 @@ export interface ThreeDeeTouchForceTouch { * The 3D Touch plugin adds 3D Touch capabilities to your Cordova app. * * Requires Cordova plugin: `cordova-plugin-3dtouch`. For more info, please see the [3D Touch plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-3dtouch). - * * @usage * Please do refer to the original plugin's repo for detailed usage. The usage example here might not be sufficient. * ```typescript @@ -130,6 +129,7 @@ export interface ThreeDeeTouchForceTouch { export class ThreeDeeTouch extends AwesomeCordovaNativePlugin { /** * You need an iPhone 6S or some future tech to use the features of this plugin, so you can check at runtime if the user's device is supported. + * * @returns {Promise} returns a promise that resolves with a boolean that indicates whether the plugin is available or not */ @Cordova() @@ -139,6 +139,7 @@ export class ThreeDeeTouch extends AwesomeCordovaNativePlugin { /** * You can get a notification when the user force touches the webview. The plugin defines a Force Touch when at least 75% of the maximum force is applied to the screen. Your app will receive the x and y coordinates, so you have to figure out which UI element was touched. + * * @returns {Observable} Returns an observable that sends a `ThreeDeeTouchForceTouch` object */ @Cordova({ @@ -150,11 +151,13 @@ export class ThreeDeeTouch extends AwesomeCordovaNativePlugin { /** * setup the 3D-touch actions, takes an array of objects with the following + * * @param {string} type (optional) A type that can be used `onHomeIconPressed` callback * @param {string} title Title for your action * @param {string} subtitle (optional) A short description for your action * @param {string} iconType (optional) Choose between Prohibit, Contact, Home, MarkLocation, Favorite, Love, Cloud, Invitation, Confirmation, Mail, Message, Date, Time, CapturePhoto, CaptureVideo, Task, TaskCompleted, Alarm, Bookmark, Shuffle, Audio, Update * @param {string} iconTemplate (optional) Can be used to provide your own icon + * @param quickActions */ @Cordova({ sync: true, @@ -163,6 +166,7 @@ export class ThreeDeeTouch extends AwesomeCordovaNativePlugin { /** * When a home icon is pressed, your app launches and this JS callback is invoked. + * * @returns {Observable} returns an observable that notifies you when he user presses on the home screen icon */ @CordovaFunctionOverride() diff --git a/src/@awesome-cordova-plugins/plugins/toast/index.ts b/src/@awesome-cordova-plugins/plugins/toast/index.ts index 8963ee68..e7b7c302 100644 --- a/src/@awesome-cordova-plugins/plugins/toast/index.ts +++ b/src/@awesome-cordova-plugins/plugins/toast/index.ts @@ -42,7 +42,6 @@ export interface ToastOptions { * This plugin allows you to show a native Toast (a little text popup) on iOS, Android and WP8. It's great for showing a non intrusive native notification which is guaranteed always in the viewport of the browser. * * Requires Cordova plugin: `cordova-plugin-x-toast`. For more info, please see the [Toast plugin docs](https://github.com/EddyVerbruggen/Toast-PhoneGap-Plugin). - * * @usage * ```typescript * import { Toast } from '@awesome-cordova-plugins/toast/ngx'; @@ -87,6 +86,7 @@ export class Toast extends AwesomeCordovaNativePlugin { /** * Manually hide any currently visible toast. + * * @returns {Promise} Returns a Promise that resolves on success. */ @Cordova() @@ -102,7 +102,6 @@ export class Toast extends AwesomeCordovaNativePlugin { * duration Duration to show the toast, either 'short', 'long' or any number of milliseconds: '1500'. * position Where to position the toast, either 'top', 'center', or 'bottom'. * addPixelsY Offset in pixels to move the toast up or down from its specified position. - * * @returns {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. */ @Cordova({ @@ -115,6 +114,7 @@ export class Toast extends AwesomeCordovaNativePlugin { /** * Shorthand for `show(message, 'short', 'top')`. + * * @param message {string} * @returns {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. */ @@ -128,6 +128,7 @@ export class Toast extends AwesomeCordovaNativePlugin { /** * Shorthand for `show(message, 'short', 'center')`. + * * @param message {string} * @returns {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. */ @@ -141,6 +142,7 @@ export class Toast extends AwesomeCordovaNativePlugin { /** * Shorthand for `show(message, 'short', 'bottom')`. + * * @param message {string} * @returns {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. */ @@ -154,6 +156,7 @@ export class Toast extends AwesomeCordovaNativePlugin { /** * Shorthand for `show(message, 'long', 'top')`. + * * @param message {string} * @returns {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. */ @@ -167,6 +170,7 @@ export class Toast extends AwesomeCordovaNativePlugin { /** * Shorthand for `show(message, 'long', 'center')`. + * * @param message {string} * @returns {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. */ @@ -180,6 +184,7 @@ export class Toast extends AwesomeCordovaNativePlugin { /** * Shorthand for `show(message, 'long', 'bottom')`. + * * @param message {string} * @returns {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. */ diff --git a/src/@awesome-cordova-plugins/plugins/touch-id/index.ts b/src/@awesome-cordova-plugins/plugins/touch-id/index.ts index 16d94502..9cc873e9 100644 --- a/src/@awesome-cordova-plugins/plugins/touch-id/index.ts +++ b/src/@awesome-cordova-plugins/plugins/touch-id/index.ts @@ -7,7 +7,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * Scan the fingerprint of a user with the TouchID sensor. * * Requires Cordova plugin: `cordova-plugin-touch-id`. For more info, please see the [TouchID plugin docs](https://github.com/EddyVerbruggen/cordova-plugin-touch-id). - * * @usage * ```typescript * import { TouchID } from '@awesome-cordova-plugins/touch-id/ngx'; diff --git a/src/@awesome-cordova-plugins/plugins/unvired-cordova-sdk/index.ts b/src/@awesome-cordova-plugins/plugins/unvired-cordova-sdk/index.ts index 6e7c69c5..b1bc3f14 100644 --- a/src/@awesome-cordova-plugins/plugins/unvired-cordova-sdk/index.ts +++ b/src/@awesome-cordova-plugins/plugins/unvired-cordova-sdk/index.ts @@ -608,6 +608,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Write debug logs. + * * @param sourceClass Name of the class * @param method Name of the method * @param message The actual message @@ -625,6 +626,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Write error logs. + * * @param sourceClass Name of the class * @param method Name of the method * @param message The actual message @@ -642,6 +644,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Write Info logs. + * * @param sourceClass Name of the class * @param method Name of the method * @param message The actual message @@ -707,6 +710,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Set the log level of the app. + * * @param logLevel The log level to set */ @Cordova() @@ -716,6 +720,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * This api initializes the Unvired Application. + * * @param loginParameters Set of parameters to be passed the login() * For Example: * ``` @@ -732,6 +737,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * This api initializes the Unvired Application. + * * @param loginParameters Set of parameters to be passed the loginWithDemoData() * For Example: * ``` @@ -764,6 +770,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { * loginParameters.password = 'MY_PASSWORD' * await this.unviredSDK.authenticateAndActivate(loginParameters) * ``` + * * @param loginParameters LoginParamerter instance used to send username / password. */ @Cordova() @@ -774,6 +781,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Authenticates the user against the previously saved username & password. * For ADS Login, authentication is performed with the ADS Server. + * * @param loginParameters Send username & Password through LoginParameters * Example: * ``` @@ -797,6 +805,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Switch account + * * @param account The account to switch to */ @Cordova() @@ -806,6 +815,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Delete account + * * @param account The account to delete */ @Cordova() @@ -815,6 +825,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Get all InfoMessages linked to the header. + * * @param headerName Name of the header. Example: CUSTOMER_HEADER * @param lid LID of the header. */ @@ -857,6 +868,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Update System Credential + * * @param credentials The credential to update to */ @Cordova() @@ -922,6 +934,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Select records from Database + * * @param tableName table name. Example: CUSTOMER_HEADER * @param whereClause {Object} Browser: JSON object containing name-value pairs. * Mobile: Or a Sqlite whereClause ( without the 'where' keyword ) @@ -939,6 +952,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Insert record into database. * In browser platform this function always inserts or updates based on GID. + * * @param tableName Name of the table. * @param structureObject - JSON object containing name-value pairs. * @param isHeader {boolean} - is DataStructure a header or item? @@ -956,6 +970,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * insert or update the record ( if record exists ) into database. * In browser insert always inserts or updates based on gid + * * @param tableName Name of the table * @param structureObject - JSON object containing name-value pairs. * @param isHeader {boolean} - is DataStructure a header or item? @@ -972,6 +987,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Delete records from the database. + * * @param tableName Name of the table * @param whereClause {Object} Browser: JSON object containing name-value pairs. * Mobile: Or a Sqlite whereClause ( without the 'where' keyword ) @@ -988,6 +1004,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Update records in database. + * * @param tableName Name of the table * @param updatedObject JSON object containing updated name-value pairs. * @param whereClause {Object} Browser: JSON object containing name-value pairs. @@ -1005,6 +1022,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Execute a SQL statement + * * @param query {string} SQL Statement. * Example: * ``` @@ -1018,6 +1036,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Create Savepoint. For more info consult SQLite Documentation ( https://www.sqlite.org/lang_savepoint.html ) + * * @param savePoint {string} Name of savepoint * Example: * ``` @@ -1031,6 +1050,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Release Savepoint. For more info consult SQLite Documentation ( https://www.sqlite.org/lang_savepoint.html ) + * * @param savePoint {string} Name of savepoint * ``` * this.unviredSDK.dbReleaseSavePoint('MySavePointName') @@ -1043,6 +1063,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Rollback Savepoint. For more info consult SQLite Documentation ( https://www.sqlite.org/lang_savepoint.html ) + * * @param savePoint {string} Name of the savepoint * Example: * ``` @@ -1101,6 +1122,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Supported in Android & Windows only. * Launch a file from a file path + * * @param filePath file path */ @Cordova() @@ -1111,6 +1133,10 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Supported in Android & Windows only. * Write Base64 string to a file and launch. + * + * @param base64string + * @param fileName + * @param extension */ @Cordova() launchBase64(base64string: string, fileName: string, extension: string): Promise { @@ -1120,6 +1146,9 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Supported in Windows Only * Unzip file. + * + * @param srcPath + * @param destPath */ @Cordova() unzip(srcPath: string, destPath: string) { @@ -1139,6 +1168,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { * Saves attachment item in database and prepares it for uploading to server. This api is required to associate attachment file to a Business Entity. * This api copies the attachment file to a new path, links the attachment with the header in database. * To send the attachment item, just send the header using either syncForeground / syncBackground api and sdk will upload all the linked attachments. + * * @param tableName Table name of attachment item structure. This usually ends with _ATTACHMENT. * @param structureObject {Object} attachment item as a JSON object. Please check the example below. * Example: @@ -1168,6 +1198,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Upload attachment item to server. + * * @param tableName Table name of attachment item. * @param structureObject JSON object containing name-value pairs. * @param isAsync Flag which indicates whether the upload should happen in async. @@ -1179,6 +1210,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Download attachment from server. + * * @param tableName Table name of attachment item. * @param structureObject JSON object containing name-value pairs. */ @@ -1214,7 +1246,6 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { * } * } * ``` - * * @param customData {Object} Send a value for this parameter only if |reqType| is QUERY or PULL. For others, send an empty string. * This parameter represents the actual input which need to be sent to the server. Usually this is an input entity, but check with your Process Agent developer on the type of input. * @@ -1231,7 +1262,6 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { * ] * } * ``` - * * @param paFunction Name of the Process Agent function to be executed. Example: PA_MOBILE_EXECUTE_SALES_ORDER. * @param autoSave This defines whether to save the response to database. */ @@ -1282,7 +1312,6 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { * } * } * ``` - * * @param customData {Object} Send a value for this parameter only if |reqType| is QUERY or PULL. For others, send an empty string. * This parameter represents the actual input which need to be sent to the server. Usually this is an input entity, but check with your Process Agent developer on the type of input. * @@ -1299,7 +1328,6 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { * ] * } * ``` - * * @param paFunction Name of the Process Agent function to be executed. Example: PA_MOBILE_EXECUTE_SALES_ORDER. * @param beName Name of the Business Entity. Required for the RequestType RQST only. For others, send empty string. * @param belid LID of the Header datastructure. Required for the RequestType RQST only. For others, send empty string. @@ -1345,6 +1373,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * For Browser platform only. * Generate Unvired BusinessEntity json from header and items + * * @param headerName Header Table Name * @param header Header Datastructure object * @param itemName Item Table Name @@ -1358,6 +1387,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * For Browser platform only. * parseRawUBJson - Parse response json returned from syncForeground api. + * * @param json JSON string */ @Cordova() @@ -1368,6 +1398,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * For Browser platform only. * Returns a collection of all entities which belong to |tableName| + * * @param tableName Name of the table Exanple: CUSTOMER_HEADER */ @Cordova() @@ -1399,6 +1430,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Supported in mobile only * Check whether a Header datastructure is in outbox. + * * @param beLid LID of the Header datastructure. */ @Cordova() @@ -1419,6 +1451,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { * Supported in mobile only * Checks whether a Header datastructure is in sent and is waiting for response. * Typically you would use before allowing the user to update the Header datastructure. + * * @param beLid LID of the Business Entity */ @Cordova() @@ -1447,6 +1480,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Supported in mobile only * Delete outbox entry for a Header datastructure. + * * @param beLid LID of the Business Entity */ @Cordova() @@ -1511,6 +1545,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Mobile Platform only. * Lock sending of data for this BE. + * * @param beLid LID of the Business Entity */ @Cordova() @@ -1530,6 +1565,8 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Mobile Platform only. * Delete an outbox item based on header's lid. + * + * @param lid */ @Cordova() removeOutObjectBasedOnLid(lid: string): Promise { @@ -1559,6 +1596,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Use this function to set the SAP credentials to be sent to UMP. + * * @param credentials Array of |Credential| objects. */ @Cordova() @@ -1568,6 +1606,7 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Check for client credentials. + * * @returns Returns true if client credentials are set */ @Cordova() @@ -1577,6 +1616,8 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Encrypt a string with the key stored by the Unvired SDK. + * + * @param stringToBeEncrypted * @returns UnviredResult.data which should contains the encrypted string. */ @Cordova() @@ -1586,6 +1627,8 @@ export class UnviredCordovaSDK extends AwesomeCordovaNativePlugin { /** * Decrypt a string with the string encrypted with the key (key stored by the Unvired SDK) + * + * @param stringToBeDecrypted * @returns UnviredResult.data which should contains the decrypted string. */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/uptime/index.ts b/src/@awesome-cordova-plugins/plugins/uptime/index.ts index 1d792f29..38e685d3 100644 --- a/src/@awesome-cordova-plugins/plugins/uptime/index.ts +++ b/src/@awesome-cordova-plugins/plugins/uptime/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Uptime * @description * This plugin provides the time spent in milliseconds since boot (uptime). - * * @usage * ```typescript * import { Uptime } from '@awesome-cordova-plugins/uptime/ngx'; @@ -31,8 +30,9 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class Uptime extends AwesomeCordovaNativePlugin { /** * This function return system uptime + * * @param {boolean} includeDeepSleep Set to true to include system deep sleep - * @return {Promise} Returns a promise that return the uptime in milliseconds + * @returns {Promise} Returns a promise that return the uptime in milliseconds */ @Cordova() getUptime(includeDeepSleep: boolean): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/urbanairship/index.ts b/src/@awesome-cordova-plugins/plugins/urbanairship/index.ts index 5da6c06c..86e36eff 100644 --- a/src/@awesome-cordova-plugins/plugins/urbanairship/index.ts +++ b/src/@awesome-cordova-plugins/plugins/urbanairship/index.ts @@ -10,6 +10,7 @@ export interface TagGroupEditor { /** * Enum for notification types. + * * @readonly * @enum {number} */ @@ -22,6 +23,7 @@ export enum NotificationType { /** * Enum for presentation options. + * * @readonly * @enum {number} */ @@ -36,7 +38,6 @@ export enum PresentationOptions { * @name UrbanAirShip * @description * This plugin does something - * * @usage * ```typescript * import { UrbanAirShip } from '@awesome-cordova-plugins/urbanairship/ngx'; @@ -243,7 +244,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * notification. If set to false the message center must be manually launched. * * @param {boolean} enabled true to automatically launch the default message center, false to disable. - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -256,7 +257,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * Enables or disables user notifications. * * @param {boolean} enabled true to enable notifications, false to disable. - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -308,7 +309,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Returns the last notification that launched the application. * - * @param {Boolean} clear true to clear the notification. + * @param {boolean} clear true to clear the notification. * @param {function(push)} success The function to call on success. * @param {object} success.push The push message object containing data associated with a push notification. * @param {string} success.push.message The push alert message. @@ -325,7 +326,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Returns the last received deep link. * - * @param {Boolean} clear true to clear the deep link. + * @param {boolean} clear true to clear the deep link. * @param {function(push)} success The function to call on success. * @param {string} success.deepLink The deep link. * @param {failureCallback} [failure] The function to call on failure. @@ -340,7 +341,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * Returns the tags as an array. * * @param {function(tags)} success The function to call on success. - * @param {array} success.tags The tags as an array. + * @param {Array} success.tags The tags as an array. * @param {failureCallback} [failure] The function to call on failure. * @param {string} failure.message The error message. */ @@ -353,7 +354,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * Sets the tags. * * @param {Array} tags an array of strings. - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -366,7 +367,6 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * Returns the alias. * * @deprecated Deprecated since 6.7.0 - to be removed in a future version of the plugin - please use getNamedUser - * * @param {function(currentAlias)} success The function to call on success. * @param {string} success.currentAlias The alias as a string. * @param {function(message)} [failure] Failure callback. @@ -381,9 +381,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * Sets the alias. * * @deprecated Deprecated since 6.7.0 - to be removed in a future version of the plugin - please use setNamedUser - * - * @param {String} alias string - * @param {function} [success] Success callback. + * @param {string} alias string + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -408,8 +407,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Enables or disables quiet time. * - * @param {Boolean} enabled true to enable quiet time, false to disable. - * @param {function} [success] Success callback. + * @param {boolean} enabled true to enable quiet time, false to disable. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -452,11 +451,11 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Sets the quiet time. * - * @param {Number} startHour for quiet time. - * @param {Number} startMinute for quiet time. - * @param {Number} endHour for quiet time. - * @param {Number} endMinute for quiet time. - * @param {function} [success] Success callback. + * @param {number} startHour for quiet time. + * @param {number} startMinute for quiet time. + * @param {number} endHour for quiet time. + * @param {number} endMinute for quiet time. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -473,8 +472,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * enabled may not work properly if it's disabled (reports, region triggers, * location segmentation, push to local time). * - * @param {Boolean} enabled true to enable analytics, false to disable. - * @param {function} [success] Success callback. + * @param {boolean} enabled true to enable analytics, false to disable. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -512,8 +511,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Sets the named user ID. * - * @param {String} namedUser identifier string. - * @param {function} [success] Success callback. + * @param {string} namedUser identifier string. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -525,7 +524,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Runs an Urban Airship action. * - * @param {String} actionName action as a string. + * @param {string} actionName action as a string. * @param {*} actionValue * @param {function(result)} [success] The function to call on success. * @param {object} success.result The result's value. @@ -540,7 +539,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Creates an editor to modify the named user tag groups. * - * @return {TagGroupEditor} A tag group editor instance. + * @returns {TagGroupEditor} A tag group editor instance. */ @Cordova() editNamedUserTagGroups(): TagGroupEditor { @@ -550,7 +549,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Creates an editor to modify the channel tag groups. * - * @return {TagGroupEditor} A tag group editor instance. + * @returns {TagGroupEditor} A tag group editor instance. */ @Cordova() editChannelTagGroups(): TagGroupEditor { @@ -562,7 +561,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * * @param key Custom key for identifier. * @param identifier The identifier value. - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -576,8 +575,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Enables or disables Urban Airship location services. * - * @param {Boolean} enabled true to enable location, false to disable. - * @param {function} [success] Success callback. + * @param {boolean} enabled true to enable location, false to disable. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -602,8 +601,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Enables or disables background location. * - * @param {Boolean} enabled true to enable background location, false to disable. - * @param {function} [success] Success callback. + * @param {boolean} enabled true to enable background location, false to disable. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -628,7 +627,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Displays the message center. * - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -640,7 +639,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Dismiss the message center. * - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -652,7 +651,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Dismiss the inbox message. * - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -664,7 +663,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Dismiss the inbox message in the overlay. * - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -683,7 +682,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * "extras": object - String to String map of any message extras. * * @param {function(messages)} success The function to call on success. - * @param {array} success.messages The array of inbox messages. + * @param {Array} success.messages The array of inbox messages. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -695,8 +694,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Marks an inbox message read. * - * @param {String} messageId The ID of the message to mark as read. - * @param {function} [success] Success callback. + * @param {string} messageId The ID of the message to mark as read. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -708,8 +707,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Deletes an inbox message. * - * @param {String} messageId The ID of the message to delete. - * @param {function} [success] Success callback. + * @param {string} messageId The ID of the message to delete. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -721,8 +720,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Displays the inbox message using a full screen view. * - * @param {String} messageId The ID of the message to display. - * @param {function} [success] Success callback. + * @param {string} messageId The ID of the message to display. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -737,7 +736,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * associated with a message, but it can be useful when providing a refresh * button for the message listing. * - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -749,8 +748,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Displays the inbox message using an overlay display. * - * @param {String} messageId The ID of the message to display. - * @param {function} [success] Success callback. + * @param {string} messageId The ID of the message to display. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -763,7 +762,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * Clears a notification by identifier. * * @param {string} identifier The notification identifier. - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. */ @Cordova() @@ -774,7 +773,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Clears all notifications posted by the application. * - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -801,8 +800,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Enables or disables auto badge. Defaults to `NO`. * - * @param {Boolean} enabled true to enable auto badge, false to disable. - * @param {function} [success] Success callback. + * @param {boolean} enabled true to enable auto badge, false to disable. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -815,7 +814,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * Sets the badge number. * * @param count number specified badge to set. - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -840,7 +839,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Clears the badge. * - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -854,7 +853,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * badges, sound and alerts that are desired. * * @param types specified notification types. - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -868,7 +867,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * badges, sound and alerts that are desired. * * @param options types specified presentation options. - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -895,8 +894,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Enables or disables notification sound. * - * @param {Boolean} enabled true to enable sound, false to disable. - * @param {function} [success] Success callback. + * @param {boolean} enabled true to enable sound, false to disable. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -921,8 +920,8 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { /** * Enables or disables notification vibration. * - * @param {Boolean} enabled true to enable vibration, false to disable. - * @param {function} [success] Success callback. + * @param {boolean} enabled true to enable vibration, false to disable. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ @@ -939,7 +938,7 @@ export class UrbanAirShip extends AwesomeCordovaNativePlugin { * @param {number} [event.value] The event's value. * @param {string} [event.transactionId] The event's transaction ID. * @param {object} [event.properties] The event's properties. Only numbers, booleans, strings, and array of strings are supported. - * @param {function} [success] Success callback. + * @param {Function} [success] Success callback. * @param {function(message)} [failure] Failure callback. * @param {string} failure.message The error message. */ diff --git a/src/@awesome-cordova-plugins/plugins/usabilla-cordova-sdk/index.ts b/src/@awesome-cordova-plugins/plugins/usabilla-cordova-sdk/index.ts index 7d52e070..dc90337e 100644 --- a/src/@awesome-cordova-plugins/plugins/usabilla-cordova-sdk/index.ts +++ b/src/@awesome-cordova-plugins/plugins/usabilla-cordova-sdk/index.ts @@ -25,7 +25,6 @@ export interface UbResult { * This document describes library integration steps for your Cordova project. * * For more info see [Cordova plugin docs](https://github.com/usabilla/usabilla-u4a-cordova) - * * @usage * ```typescript * import { Usabilla } from '@awesome-cordova-plugins/usabilla-cordova-sdk/ngx'; @@ -63,6 +62,8 @@ export class Usabilla extends AwesomeCordovaNativePlugin { * * @name initialize * @param {appId} APP_ID unique app id to initialize + * @param appId + * @param customVars * @param {customVars} CUSTOM_VARIABLES for target based event trigger */ @Cordova({ @@ -77,6 +78,7 @@ export class Usabilla extends AwesomeCordovaNativePlugin { * Displays Feedback form based on unique form id after sdk initialization. * * @name loadFeedbackForm + * @param formId * @param {formId} FORM_ID to display Feedback form for */ @Cordova({ @@ -91,6 +93,7 @@ export class Usabilla extends AwesomeCordovaNativePlugin { * Displays Feedback form with current screen's snapshot and based on unique form id, after sdk initialization. * * @name loadFeedbackFormWithCurrentViewScreenshot + * @param formId * @param {formId} FORM_ID to display Feedback form for */ @Cordova({ @@ -105,6 +108,7 @@ export class Usabilla extends AwesomeCordovaNativePlugin { * Displays Campaign banner targetted based on specific event and variables, after sdk initialization. * * @name sendEvent + * @param eventId * @param {eventId} EVENT_ID to display Campaign banner for */ @Cordova({ @@ -119,7 +123,6 @@ export class Usabilla extends AwesomeCordovaNativePlugin { * Reset Campaign for next trigger. * * @name resetCampaignData - * */ @Cordova({ successIndex: 0, @@ -133,7 +136,6 @@ export class Usabilla extends AwesomeCordovaNativePlugin { * Dismiss or removes the Form/Banner from the view. * * @name dismiss - * */ @Cordova({ successIndex: 0, @@ -145,8 +147,8 @@ export class Usabilla extends AwesomeCordovaNativePlugin { /** * Get default masking strategy to be applied for data masking. - * @name getDefaultDataMasks * + * @name getDefaultDataMasks */ @Cordova({ successIndex: 0, @@ -161,6 +163,8 @@ export class Usabilla extends AwesomeCordovaNativePlugin { * * @name setDataMasking * @param {masks} Format regex to be applied for masking. + * @param masks + * @param maskCharacter * @param {maskCharacter} Character to be used as a masking character */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/vibes/index.ts b/src/@awesome-cordova-plugins/plugins/vibes/index.ts index d3e6eda6..c8739e1d 100644 --- a/src/@awesome-cordova-plugins/plugins/vibes/index.ts +++ b/src/@awesome-cordova-plugins/plugins/vibes/index.ts @@ -33,7 +33,6 @@ export interface InboxMessage { * @name Vibes * @description * This plugin enables integration with the Vibes Push SDK to your Cordova project with Android and iOS supported. - * * @usage * ```typescript * import { Vibes } from '@awesome-cordova-plugins/vibes/ngx'; @@ -76,7 +75,7 @@ export class Vibes extends AwesomeCordovaNativePlugin { /** * Register this device with the Vibes platform * - * @return {Promise} + * @returns {Promise} */ @Cordova() registerDevice(): Promise { @@ -86,7 +85,7 @@ export class Vibes extends AwesomeCordovaNativePlugin { /** * Unregister this device with the Vibes platform * - * @return {Promise} + * @returns {Promise} */ @Cordova() unregisterDevice(): Promise { @@ -97,7 +96,7 @@ export class Vibes extends AwesomeCordovaNativePlugin { * Associate an external ID with the current person. * * @param {string} externalPersonId - * @return {Promise} + * @returns {Promise} */ @Cordova() associatePerson(externalPersonId: string): Promise { @@ -107,7 +106,7 @@ export class Vibes extends AwesomeCordovaNativePlugin { /** * Register this device to receive push notifications * - * @return {Promise} + * @returns {Promise} */ @Cordova() registerPush(): Promise { @@ -117,7 +116,7 @@ export class Vibes extends AwesomeCordovaNativePlugin { /** * Unregister the device from receiving push notifications * - * @return {Promise} + * @returns {Promise} */ @Cordova() unregisterPush(): Promise { @@ -126,7 +125,7 @@ export class Vibes extends AwesomeCordovaNativePlugin { /** * Fetches a DeviceInfoResponse with details about the Vibes Device ID and Push Token * - * @return {Promise} + * @returns {Promise} */ @Cordova() getVibesDeviceInfo(): Promise { @@ -136,7 +135,7 @@ export class Vibes extends AwesomeCordovaNativePlugin { /** * Fetches the PersonResponse associated with this device currently * - * @return {Promise} + * @returns {Promise} */ @Cordova() getPerson(): Promise { @@ -146,7 +145,7 @@ export class Vibes extends AwesomeCordovaNativePlugin { /** * Get notified when the user opens a notification * - * @return {Observable} + * @returns {Observable} */ @Cordova({ observable: true, @@ -158,7 +157,7 @@ export class Vibes extends AwesomeCordovaNativePlugin { /** * Fetches an array of inbox messages for the person associated with this device. * - * @return {Promise} + * @returns {Promise} */ @Cordova() fetchInboxMessages(): Promise { @@ -169,7 +168,7 @@ export class Vibes extends AwesomeCordovaNativePlugin { * Fetches a single inbox message by it's id. * * @param {string} message_uid - * @return {Promise} + * @returns {Promise} */ @Cordova() fetchInboxMessage(message_uid: string): Promise { @@ -181,7 +180,8 @@ export class Vibes extends AwesomeCordovaNativePlugin { * * @param {string} message_uid * @param {string} An ISO-8601 formatted date string. - * @return {Promise} an updated version of the InboxMessage with expires_at date updated + * @param date + * @returns {Promise} an updated version of the InboxMessage with expires_at date updated */ @Cordova() expireInboxMessage(message_uid: string, date: string): Promise { @@ -192,7 +192,7 @@ export class Vibes extends AwesomeCordovaNativePlugin { * Marks an inbox message as read. * * @param {string} message_uid - * @return {Promise} an updated version of the InboxMessage with read field updated + * @returns {Promise} an updated version of the InboxMessage with read field updated */ @Cordova() markInboxMessageAsRead(message_uid: string): Promise { @@ -203,7 +203,7 @@ export class Vibes extends AwesomeCordovaNativePlugin { * Records an event for when the user opens an inbox message. * * @param inbox_message_stringified stringified version of the InboxMessage - * @return {Promise} + * @returns {Promise} */ @Cordova() onInboxMessageOpen(inbox_message_stringified: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/vibration/index.ts b/src/@awesome-cordova-plugins/plugins/vibration/index.ts index 3fac0c03..90d2c5f2 100644 --- a/src/@awesome-cordova-plugins/plugins/vibration/index.ts +++ b/src/@awesome-cordova-plugins/plugins/vibration/index.ts @@ -39,6 +39,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class Vibration extends AwesomeCordovaNativePlugin { /** * Vibrates the device for given amount of time. + * * @param time {number|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({ diff --git a/src/@awesome-cordova-plugins/plugins/video-editor/index.ts b/src/@awesome-cordova-plugins/plugins/video-editor/index.ts index 820b4b6b..a5fc4732 100644 --- a/src/@awesome-cordova-plugins/plugins/video-editor/index.ts +++ b/src/@awesome-cordova-plugins/plugins/video-editor/index.ts @@ -113,7 +113,6 @@ export interface VideoInfo { /** * @name Video Editor * @description Edit videos using native device APIs - * * @usage * ```typescript * import { VideoEditor } from '@awesome-cordova-plugins/video-editor/ngx'; @@ -161,6 +160,7 @@ export class VideoEditor extends AwesomeCordovaNativePlugin { /** * Transcode a video + * * @param options {TranscodeOptions} Options * @returns {Promise} Returns a promise that resolves to the path of the transcoded video */ @@ -173,6 +173,7 @@ export class VideoEditor extends AwesomeCordovaNativePlugin { /** * Trim a video + * * @param options {TrimOptions} Options * @returns {Promise} Returns a promise that resolves to the path of the trimmed video */ @@ -186,6 +187,7 @@ export class VideoEditor extends AwesomeCordovaNativePlugin { /** * Create a JPEG thumbnail from a video + * * @param options {CreateThumbnailOptions} Options * @returns {Promise} Returns a promise that resolves to the path to the jpeg image on the device */ @@ -198,6 +200,7 @@ export class VideoEditor extends AwesomeCordovaNativePlugin { /** * Get info on a video (width, height, orientation, duration, size, & bitrate) + * * @param options {GetVideoInfoOptions} Options * @returns {Promise} Returns a promise that resolves to an object containing info on the video */ diff --git a/src/@awesome-cordova-plugins/plugins/video-player/index.ts b/src/@awesome-cordova-plugins/plugins/video-player/index.ts index 6af2c3fa..b48d2ff5 100644 --- a/src/@awesome-cordova-plugins/plugins/video-player/index.ts +++ b/src/@awesome-cordova-plugins/plugins/video-player/index.ts @@ -23,7 +23,6 @@ export interface VideoOptions { * A Cordova plugin that simply allows you to immediately play a video in fullscreen mode. * * Requires Cordova plugin: `com.moust.cordova.videoplayer`. For more info, please see the [VideoPlayer plugin docs](https://github.com/moust/cordova-plugin-videoplayer). - * * @usage * ```typescript * import { VideoPlayer } from '@awesome-cordova-plugins/video-player/ngx'; @@ -54,6 +53,7 @@ export interface VideoOptions { export class VideoPlayer extends AwesomeCordovaNativePlugin { /** * Plays the video from the passed url. + * * @param fileUrl {string} File url to the video. * @param options {VideoOptions?} Optional video playback settings. See options above. * @returns {Promise} Resolves promise when the video was played successfully. diff --git a/src/@awesome-cordova-plugins/plugins/web-intent/index.ts b/src/@awesome-cordova-plugins/plugins/web-intent/index.ts index 6b7153b5..ab03dfb3 100644 --- a/src/@awesome-cordova-plugins/plugins/web-intent/index.ts +++ b/src/@awesome-cordova-plugins/plugins/web-intent/index.ts @@ -74,6 +74,7 @@ export interface IntentOptions { export class WebIntent extends AwesomeCordovaNativePlugin { /** * Convenience constant for actions + * * @type {string} */ @CordovaProperty() @@ -81,6 +82,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Convenience constant for actions + * * @type {string} */ @CordovaProperty() @@ -88,6 +90,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Convenience constant for extras + * * @type {string} */ @CordovaProperty() @@ -95,6 +98,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Convenience constant for extras + * * @type {string} */ @CordovaProperty() @@ -102,6 +106,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Convenience constant for extras + * * @type {string} */ @CordovaProperty() @@ -109,6 +114,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Convenience constant for extras + * * @type {string} */ @CordovaProperty() @@ -116,6 +122,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Convenience constant for actions + * * @type {string} */ @CordovaProperty() @@ -123,6 +130,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Convenience constant for actions + * * @type {string} */ @CordovaProperty() @@ -130,6 +138,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Convenience constant for actions + * * @type {string} */ @CordovaProperty() @@ -137,6 +146,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Convenience constant for actions + * * @type {string} */ @CordovaProperty() @@ -144,6 +154,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Convenience constant for actions + * * @type {string} */ @CordovaProperty() @@ -151,6 +162,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Convenience constant for actions + * * @type {string} */ @CordovaProperty() @@ -158,6 +170,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Launches an Android intent + * * @param options {IntentOptions} * @returns {Promise} */ @@ -168,6 +181,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Starts a new activity and return the result to the application + * * @param options {IntentOptions} * @returns {Promise} */ @@ -178,6 +192,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Checks if this app was invoked with specified extra + * * @param extra {string} * @returns {Promise} */ @@ -188,6 +203,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Gets the extra that this app was invoked with + * * @param extra {string} * @returns {Promise} */ @@ -198,6 +214,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Gets the Uri the app was invoked with + * * @returns {Promise} */ @Cordova() @@ -207,6 +224,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Returns the content of the intent used whenever the application activity is launched + * * @returns {Observable} */ @Cordova({ @@ -218,6 +236,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Sends a custom intent passing optional extras + * * @param options {IntentOptions} * @returns {Promise} */ @@ -228,6 +247,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Request that a given application service be started + * * @param options {IntentOptions} * @returns {Promise} */ @@ -238,6 +258,7 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Registers a broadcast receiver for the specified filters + * * @param filters {RegisterBroadcastReceiverOptions} * @returns {Observable} */ @@ -271,6 +292,9 @@ export class WebIntent extends AwesomeCordovaNativePlugin { /** * Send a result back to the Intent that started this Activity. * The data can be passed using 'extras'. + * + * @param root0 + * @param root0.extras * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/web-server/index.ts b/src/@awesome-cordova-plugins/plugins/web-server/index.ts index 5bd5cb15..2ee759b6 100644 --- a/src/@awesome-cordova-plugins/plugins/web-server/index.ts +++ b/src/@awesome-cordova-plugins/plugins/web-server/index.ts @@ -22,7 +22,6 @@ export interface Request { * @name Web Server * @description * This plugin allows you to start a local dynamic content web server for android and iOS devices. - * * @usage * ```typescript * import { WebServer } from '@awesome-cordova-plugins/web-server/ngx'; @@ -50,7 +49,6 @@ export interface Request { * .catch((error: any) => console.error(error)); * * ``` - * * @interfaces * Response * Request @@ -66,6 +64,7 @@ export interface Request { export class WebServer extends AwesomeCordovaNativePlugin { /** * This method will start your webserver. + * * @param port {number} Port number (default to 8080) */ @Cordova({ @@ -85,7 +84,8 @@ export class WebServer extends AwesomeCordovaNativePlugin { /** * This method returns an observable that streams HTTP requests to an observer. - * @return {Observable} Returns an observable to resolve as a Request object + * + * @returns {Observable} Returns an observable to resolve as a Request object */ @Cordova({ callbackOrder: 'reverse', @@ -98,9 +98,10 @@ export class WebServer extends AwesomeCordovaNativePlugin { /** * This method sends a response to a request. + * * @param requestId {string} Request ID to respond to * @param responseObject {Response} Response object - * @return {Promise} Returns a promise that resolves when something happens + * @returns {Promise} Returns a promise that resolves when something happens */ @Cordova() sendResponse(requestId: string, responseObject: Response): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/web-socket-server/index.ts b/src/@awesome-cordova-plugins/plugins/web-socket-server/index.ts index 1b89ee83..e45cc470 100644 --- a/src/@awesome-cordova-plugins/plugins/web-socket-server/index.ts +++ b/src/@awesome-cordova-plugins/plugins/web-socket-server/index.ts @@ -70,7 +70,6 @@ export interface HttpFields { * @name WebSocket Server * @description * This plugin allows you to run a single, lightweight, barebone WebSocket Server. - * * @usage * ```typescript * import { WebSocketServer } from '@awesome-cordova-plugins/web-socket-server'; @@ -111,7 +110,8 @@ export interface HttpFields { export class WebSocketServer extends AwesomeCordovaNativePlugin { /** * Return this device's interfaces - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getInterfaces(): Promise { @@ -120,9 +120,10 @@ export class WebSocketServer extends AwesomeCordovaNativePlugin { /** * Start websocket server + * * @param port {number} Local port on which the service runs. (0 means any free port) * @param options {WebSocketOptions} Additional options for websocket - * @return {Observable} Returns Observable where all generic error can be catched (mostly JSONExceptions) + * @returns {Observable} Returns Observable where all generic error can be catched (mostly JSONExceptions) */ @Cordova({ observable: true, @@ -142,7 +143,8 @@ export class WebSocketServer extends AwesomeCordovaNativePlugin { /** * Watches for new messages - * @return {Observable} + * + * @returns {Observable} */ watchMessage(): Observable { return this.onFunctionToObservable('onMessage'); @@ -150,7 +152,8 @@ export class WebSocketServer extends AwesomeCordovaNativePlugin { /** * Watches for new opened connections - * @return {Observable} + * + * @returns {Observable} */ watchOpen(): Observable { return this.onFunctionToObservable('onOpen'); @@ -158,7 +161,8 @@ export class WebSocketServer extends AwesomeCordovaNativePlugin { /** * Watches for closed connections - * @return {Observable} + * + * @returns {Observable} */ watchClose(): Observable { return this.onFunctionToObservable('onClose'); @@ -166,7 +170,8 @@ export class WebSocketServer extends AwesomeCordovaNativePlugin { /** * Watches for any websocket failures - * @return {Observable} + * + * @returns {Observable} */ watchFailure(): Observable { return this.onFunctionToObservable('onFailure'); @@ -174,7 +179,8 @@ export class WebSocketServer extends AwesomeCordovaNativePlugin { /** * Stop websocket server and closes all connections - * @return {Promise} + * + * @returns {Promise} */ @Cordova() stop(): Promise { @@ -183,9 +189,10 @@ export class WebSocketServer extends AwesomeCordovaNativePlugin { /** * Send Message to a connected device + * * @param conn {WebSocketIdentifier} Connection to send message to * @param msg {string} Message to send - * @return {Promise} + * @returns {Promise} */ @Cordova() send(conn: WebSocketIdentifier, msg: string): Promise { @@ -194,10 +201,11 @@ export class WebSocketServer extends AwesomeCordovaNativePlugin { /** * Close specific connection using uuid + * * @param conn {WebSocketIdentifier} Connection to close * @param code {number} Close code, determines if it was clean * @param reason {string} Reason for closing - * @return {Promise} + * @returns {Promise} */ @Cordova() close(conn: WebSocketIdentifier, code: number, reason: string): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/webengage/index.ts b/src/@awesome-cordova-plugins/plugins/webengage/index.ts index bb32c790..645c0e40 100644 --- a/src/@awesome-cordova-plugins/plugins/webengage/index.ts +++ b/src/@awesome-cordova-plugins/plugins/webengage/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Webengage * @description * Awesome Cordova Plugins wrapper that wraps Webengage Cordova plugin for Android and iOS - * * @usage * ```typescript * import { Webengage, WebengageUser, WebengagePush, WebengageNotification } from '@awesome-cordova-plugins/webengage/ngx'; @@ -29,8 +28,9 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class Webengage extends AwesomeCordovaNativePlugin { /** * Initializes WebEngage SDK + * * @param {any} [config] - * @return {Promise} + * @returns {Promise} */ @Cordova() engage(config?: any): Promise { @@ -39,9 +39,10 @@ export class Webengage extends AwesomeCordovaNativePlugin { /** * Sets WebEngage SDK configuration + * * @param {string} key * @param {any} value - * @return {Promise} + * @returns {Promise} */ @Cordova() options(key: string, value: any): Promise { @@ -50,9 +51,10 @@ export class Webengage extends AwesomeCordovaNativePlugin { /** * Tracks event + * * @param {string} eventName * @param {any} [attributes] - * @return {Promise} + * @returns {Promise} */ @Cordova() track(eventName: string, attributes?: any): Promise { @@ -61,9 +63,11 @@ export class Webengage extends AwesomeCordovaNativePlugin { /** * Tracks screen + * * @param {string} eventName + * @param screenName * @param {any} [screenData] - * @return {Promise} + * @returns {Promise} */ @Cordova() screen(screenName: string, screenData?: any): Promise { @@ -83,8 +87,9 @@ export class Webengage extends AwesomeCordovaNativePlugin { export class WebengageUser extends AwesomeCordovaNativePlugin { /** * Logs user in + * * @param {string} userId - * @return {Promise} + * @returns {Promise} */ @Cordova() login(userId: string): Promise { @@ -93,7 +98,8 @@ export class WebengageUser extends AwesomeCordovaNativePlugin { /** * Logs user out - * @return {Promise} + * + * @returns {Promise} */ @Cordova() logout(): Promise { @@ -102,9 +108,10 @@ export class WebengageUser extends AwesomeCordovaNativePlugin { /** * Sets user attribute + * * @param {string} key * @param {any} value - * @return {Promise} + * @returns {Promise} */ @Cordova() setAttribute(key: string, value: any): Promise { @@ -124,8 +131,9 @@ export class WebengageUser extends AwesomeCordovaNativePlugin { export class WebengagePush extends AwesomeCordovaNativePlugin { /** * Callback function is invoked when a push notification is clicked + * * @param {any} callback - * @return {Promise} + * @returns {Promise} */ @Cordova() onClick(callback: any): Promise { @@ -134,9 +142,10 @@ export class WebengagePush extends AwesomeCordovaNativePlugin { /** * Sets push notification configuration + * * @param {string} key * @param {any} value - * @return {Promise} + * @returns {Promise} */ @Cordova() options(key: string, value: any): Promise { @@ -156,8 +165,9 @@ export class WebengagePush extends AwesomeCordovaNativePlugin { export class WebengageNotification extends AwesomeCordovaNativePlugin { /** * Callback function is invoked when a in-app notification is shown + * * @param {any} callback - * @return {Promise} + * @returns {Promise} */ @Cordova() onShown(callback: any): Promise { @@ -166,8 +176,9 @@ export class WebengageNotification extends AwesomeCordovaNativePlugin { /** * Callback function is invoked when a in-app notification is clicked + * * @param {any} callback - * @return {Promise} + * @returns {Promise} */ @Cordova() onClick(callback: any): Promise { @@ -176,8 +187,9 @@ export class WebengageNotification extends AwesomeCordovaNativePlugin { /** * Callback function is invoked when a in-app notification is dismissed + * * @param {any} callback - * @return {Promise} + * @returns {Promise} */ @Cordova() onDismiss(callback: any): Promise { @@ -186,9 +198,10 @@ export class WebengageNotification extends AwesomeCordovaNativePlugin { /** * Sets in-app notification configuration + * * @param {string} key * @param {any} value - * @return {Promise} + * @returns {Promise} */ @Cordova() options(key: string, value: any): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/wechat/index.ts b/src/@awesome-cordova-plugins/plugins/wechat/index.ts index c4dfd924..f2e08e53 100644 --- a/src/@awesome-cordova-plugins/plugins/wechat/index.ts +++ b/src/@awesome-cordova-plugins/plugins/wechat/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Wechat * @description * A cordova plugin, a JS version of Wechat SDK - * * @usage * ```typescript * import { Wechat } from '@awesome-cordova-plugins/wechat/ngx'; @@ -63,6 +62,7 @@ export class Wechat extends AwesomeCordovaNativePlugin { /** * Share a message to wechat app * + * @param params * @example * * this.wechat.share({ @@ -93,6 +93,8 @@ export class Wechat extends AwesomeCordovaNativePlugin { /** * Sending an auth request to Wechat * + * @param scope + * @param state * @example * * this.wechat.auth.then((res) => { alert(res.code); }); @@ -106,6 +108,7 @@ export class Wechat extends AwesomeCordovaNativePlugin { /** * Send a payment request * + * @param params * @link https://pay.weixin.qq.com/wiki/doc/api/app.php?chapter=9_1 * @example * @@ -131,6 +134,7 @@ export class Wechat extends AwesomeCordovaNativePlugin { /** * jumpToBizProfile (跳转到某个微信公众号)2016-11-11 测试是失效的,囧 * + * @param url * @link https://segmentfault.com/a/1190000007204624 * @link https://segmentfault.com/q/1010000003907796 * @example @@ -159,6 +163,7 @@ export class Wechat extends AwesomeCordovaNativePlugin { /** * chooseInvoiceFromWX exq:choose invoices from Wechat card list * + * @param params * @example * * params: signType, cardSign, nonceStr, timeStamp all required @@ -177,6 +182,7 @@ export class Wechat extends AwesomeCordovaNativePlugin { /** * openMiniProgram exq:app opens wechat mini program * + * @param params * @example * * params: userName, path, miniprogramType all required diff --git a/src/@awesome-cordova-plugins/plugins/wheel-selector/index.ts b/src/@awesome-cordova-plugins/plugins/wheel-selector/index.ts index a5db6b0e..49f05699 100644 --- a/src/@awesome-cordova-plugins/plugins/wheel-selector/index.ts +++ b/src/@awesome-cordova-plugins/plugins/wheel-selector/index.ts @@ -66,7 +66,6 @@ export interface WheelSelectorData { * @beta * @name WheelSelector Plugin * @description Native wheel selector for Cordova (Android/iOS). - * * @usage * ``` * import { WheelSelector } from '@awesome-cordova-plugins/wheel-selector/ngx'; @@ -168,7 +167,6 @@ export interface WheelSelectorData { * } * * ``` - * * @interfaces * WheelSelectorOptions */ @@ -183,6 +181,7 @@ export interface WheelSelectorData { export class WheelSelector extends AwesomeCordovaNativePlugin { /** * Shows the wheel selector + * * @param {WheelSelectorOptions} options Options for the wheel selector * @returns {Promise} Returns a promise that resolves with the selected items, or an error. */ @@ -193,6 +192,7 @@ export class WheelSelector extends AwesomeCordovaNativePlugin { /** * Hide the selector + * * @returns {Promise} */ @Cordova({ diff --git a/src/@awesome-cordova-plugins/plugins/wifi-wizard-2/index.ts b/src/@awesome-cordova-plugins/plugins/wifi-wizard-2/index.ts index e3dd1290..e89d410c 100644 --- a/src/@awesome-cordova-plugins/plugins/wifi-wizard-2/index.ts +++ b/src/@awesome-cordova-plugins/plugins/wifi-wizard-2/index.ts @@ -24,7 +24,6 @@ export interface WifiScanOptions extends WifiScanResultsOptions { * WifiWizard2 enables Wifi management for both Android and iOS applications within Cordova/Phonegap projects. * * This project is a fork of the WifiWizard plugin with fixes and updates, as well as patches taken from the Cordova Network Manager plugin. - * * @usage * ```typescript * import { WifiWizard2 } from '@awesome-cordova-plugins/wifi-wizard-2/ngx'; @@ -52,7 +51,7 @@ export interface WifiScanOptions extends WifiScanResultsOptions { * - Helper async timeout delay, `delay` is optional, default is 2000ms = 2 seconds * - This method always returns a resolved promise after the delay, it will never reject or throw an error * - * **Example inside async function** + * Example inside async function** * ```typescript * async function example(){ * await this.wifiWizard2.timeout(4000); @@ -60,7 +59,7 @@ export interface WifiScanOptions extends WifiScanResultsOptions { * } * ``` * - * **Example inside standard non-async function** + * Example inside standard non-async function** * ```typescript * function example(){ * this.wifiWizard2.timeout(4000).then( function(){ @@ -69,7 +68,7 @@ export interface WifiScanOptions extends WifiScanResultsOptions { * } * ``` * - * **Thrown Errors** + * Thrown Errors** * * - `TIMEOUT_WAITING_FOR_SCAN` on timeout waiting for scan 10 seconds + * - `SCAN_FAILED` if unable to start scan @@ -111,7 +110,7 @@ export interface WifiScanOptions extends WifiScanResultsOptions { * - If unable to update network configuration (was added by user or other app), but a valid network ID exists, this method will still attempt to enable the network * - Promise will not be returned until method has verified that connection to WiFi was in completed state (waits up to 60 seconds) * - * **Thrown Errors** + * Thrown Errors** * * * - `CONNECT_FAILED_TIMEOUT` unable to verify connection, timed out after 60 seconds @@ -131,7 +130,7 @@ export interface WifiScanOptions extends WifiScanResultsOptions { * - If `ssid` is provided, this method will first attempt to `disable` and then `remove` the network * - If you do not want to remove network configuration, use `disable` instead * - * **Thrown Errors** + * Thrown Errors** * * - `DISCONNECT_NET_REMOVE_ERROR` Android returned error when removing wifi configuration * - `DISCONNECT_NET_DISABLE_ERROR` Unable to connect based on generated wifi config @@ -155,7 +154,7 @@ export interface WifiScanOptions extends WifiScanResultsOptions { * ``` * - `wifi` must be an object formatted by `formatWifiConfig`, this **must** be done before calling `enable` * - * **Thrown Errors** + * Thrown Errors** * * - `AUTH_TYPE_NOT_SUPPORTED` - Invalid auth type specified * - `ERROR_ADDING_NETWORK` - Android returned `-1` specifying error adding network @@ -167,7 +166,7 @@ export interface WifiScanOptions extends WifiScanResultsOptions { * - `ssid` can either be an SSID (string) or a network ID (integer) * - Please note, most newer versions of Android will only allow wifi to be removed if created by your application * - * **Thrown Errors** + * Thrown Errors** * * - `UNABLE_TO_REMOVE` Android returned failure in removing network * - `REMOVE_NETWORK_NOT_FOUND` Unable to determine network ID from passed SSID @@ -187,7 +186,7 @@ export interface WifiScanOptions extends WifiScanResultsOptions { * ``` * - It is recommended to just use the `scan` method instead of `startScan` * - * **Thrown Errors** + * Thrown Errors** * * - `STARTSCAN_FAILED` Android returned failure in starting scan * @@ -230,7 +229,7 @@ export interface WifiScanOptions extends WifiScanResultsOptions { * - Pass `true` for `enabled` parameter to set Wifi enabled * - You do not need to call this function to set WiFi enabled to call other methods that require wifi enabled. This plugin will automagically enable WiFi if a method is called that requires WiFi to be enabled. * - * **Thrown Errors** + * Thrown Errors** * * - `ERROR_SETWIFIENABLED` wifi state does not match call (enable or disable) * @@ -439,6 +438,7 @@ export interface WifiScanOptions extends WifiScanResultsOptions { export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Connect to network on iOS device + * * @param ssid * @param ssidPassword Password if connecting to WPA/WPA2 network (omit or use false to connect to open network) * @returns {Promise} @@ -453,6 +453,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Disconnect from SSID on iOS device + * * @param ssid * @returns {Promise} */ @@ -466,6 +467,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Add wifi network configuration + * * @param wifiConfig Must be object created by formatWifiConfig() * @returns {Promise} */ @@ -478,6 +480,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Remove wifi network configuration + * * @param {string|number} [ssid] * @returns {Promise} */ @@ -496,6 +499,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { * @param {string|number} [ssid] * @param {boolean} [bindAll=false] - Whether or not to bind all connections from app, through WiFi connection * @param {string} [password=] + * @param password * @param {string} [algorithm=NONE] - WPA, WPA (for WPA2), WEP or NONE (NONE by default) * @returns {Promise} */ @@ -526,6 +530,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Enable Network + * * @param {string|number} [ssid] * @param {boolean} [bindAll=false] - Whether or not to bind all network requests to this wifi network * @param {boolean} [waitForConnection=false] - Whether or not to wait before resolving promise until connection to wifi is verified @@ -541,6 +546,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Disable Network + * * @param {string|number} [ssid] * @returns {Promise} */ @@ -554,6 +560,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Reconnect to the currently active access point, even if we are already connected. + * * @returns {Promise} */ @Cordova({ @@ -566,6 +573,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Reconnect to the currently active access point, if we are currently disconnected. + * * @returns {Promise} */ @Cordova({ @@ -578,6 +586,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Returns currently configured networks + * * @returns {Promise} */ @Cordova({ @@ -589,6 +598,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Start network scan and return results + * * @param options * @returns {Promise} */ @@ -601,6 +611,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Start wifi network scan (results can be retrieved with getScanResults) + * * @returns {Promise} */ @Cordova({ @@ -612,6 +623,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Get wifi scan results (must call startScan first, or just use scan()) + * * @param options * @returns {Promise} */ @@ -624,6 +636,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Check if WiFi is enabled + * * @returns {Promise} */ @Cordova({ @@ -635,6 +648,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Enable or Disable WiFi + * * @param enabled * @returns {Promise} */ @@ -648,6 +662,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Enable WiFi + * * @returns {Promise} */ @Cordova({ @@ -660,6 +675,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Disable WiFi + * * @returns {Promise} */ @Cordova({ @@ -672,6 +688,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Unbind Network + * * @returns {Promise} */ @Cordova({ @@ -683,6 +700,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Bind Network + * * @returns {Promise} */ @Cordova({ @@ -694,6 +712,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Get Wifi Router IP from DHCP + * * @returns {Promise} */ @Cordova({ @@ -705,6 +724,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Get Wifi IP + * * @returns {Promise} */ @Cordova({ @@ -718,6 +738,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { * Get Wifi IP and Subnet Address * * This method returns a JSON object similar to: { "ip": "0.0.0.0", "subnet": "0.0.0.0" } + * * @returns {Promise} */ @Cordova({ @@ -729,6 +750,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Get Network ID from SSID + * * @param {string|number} [ssid] * @returns {Promise} */ @@ -741,6 +763,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Get currently connected network ID + * * @returns {Promise} */ @Cordova({ @@ -752,6 +775,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Get currently connected network SSID + * * @returns {Promise} */ @Cordova({ @@ -763,6 +787,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Get currently connected network BSSID/MAC + * * @returns {Promise} */ @Cordova({ @@ -774,6 +799,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Check if current WiFi connection has connection to the internet + * * @returns {Promise} */ @Cordova({ @@ -785,6 +811,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Check if we can ping current WiFi router IP address + * * @returns {Promise} */ @Cordova({ @@ -796,6 +823,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Check if we can connect via HTTP current WiFi router IP address + * * @returns {Promise} */ @Cordova({ @@ -807,6 +835,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Check if current WiFi connection can connect to internet (checks connection to google.com) + * * @returns {Promise} */ @Cordova({ @@ -833,6 +862,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Format WiFi configuration for Android Devices + * * @param {string|number} [ssid] * @param {string} [password] * @param {string} [algorithm] @@ -851,6 +881,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Format WPA WiFi configuration for Android Devices + * * @param {string|number} [ssid] * @param {string} password * @param {boolean} isHiddenSSID @@ -863,6 +894,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Format WiFi SSID String + * * @param ssid * @returns {*} */ @@ -873,6 +905,7 @@ export class WifiWizard2 extends AwesomeCordovaNativePlugin { /** * Synchronous Sleep/Timeout `await this.timeout()` + * * @param delay the amount of time to wait (default 2 seconds) */ @CordovaFunctionOverride() diff --git a/src/@awesome-cordova-plugins/plugins/wonderpush/index.ts b/src/@awesome-cordova-plugins/plugins/wonderpush/index.ts index 300c646b..f2752a39 100644 --- a/src/@awesome-cordova-plugins/plugins/wonderpush/index.ts +++ b/src/@awesome-cordova-plugins/plugins/wonderpush/index.ts @@ -52,6 +52,7 @@ class NestedObject { export class UserPreferencesMethods extends NestedObject { /** * Get the default channel id + * * @returns {Promise} */ getDefaultChannelId(): Promise { @@ -60,6 +61,7 @@ export class UserPreferencesMethods extends NestedObject { /** * Set the default channel id + * * @param {string} id * @returns {Promise} */ @@ -69,6 +71,7 @@ export class UserPreferencesMethods extends NestedObject { /** * Get a channel group + * * @param {string} groupId * @returns {Promise} */ @@ -78,6 +81,7 @@ export class UserPreferencesMethods extends NestedObject { /** * Get a channel + * * @param {string} channelId * @returns {Promise} */ @@ -87,6 +91,7 @@ export class UserPreferencesMethods extends NestedObject { /** * Create, update and remove channel existing groups to match the given channel groups + * * @param {WonderPushChannelGroup[]} channelGroups * @returns {Promise} */ @@ -96,6 +101,7 @@ export class UserPreferencesMethods extends NestedObject { /** * Create, update and remove channels to match the given channels + * * @param {WonderPushChannel[]} channels * @returns {Promise} */ @@ -105,6 +111,7 @@ export class UserPreferencesMethods extends NestedObject { /** * Create or update a channel group + * * @param {WonderPushChannelGroup} channelGroup * @returns {Promise} */ @@ -114,6 +121,7 @@ export class UserPreferencesMethods extends NestedObject { /** * Create or update a channel + * * @param {WonderPushChannel} channel * @returns {Promise} */ @@ -123,6 +131,7 @@ export class UserPreferencesMethods extends NestedObject { /** * Remove a channel group + * * @param {string} groupId * @returns {Promise} */ @@ -132,6 +141,7 @@ export class UserPreferencesMethods extends NestedObject { /** * Remove a channel + * * @param {string} channelId * @returns {Promise} */ @@ -154,7 +164,6 @@ export class UserPreferencesMethods extends NestedObject { * * [WonderPush push notifications](https://www.wonderpush.com) are the most effective way * to retain your users and grow your audience while remaining fully GDPR compliant. - * * @usage * ```typescript * import { WonderPush } from '@awesome-cordova-plugins/wonderpush'; @@ -201,7 +210,6 @@ export class UserPreferencesMethods extends NestedObject { * } * }); * ``` - * * @interfaces * WonderPushChannel * WonderPushChannelGroup @@ -241,6 +249,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Controls native SDK logging. + * * @param {boolean} enabled - Whether to enable logs. * @returns {Promise} */ @@ -251,6 +260,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Sets up a delegate for tighter integration, or removes it. + * * @param {?WonderPushDelegate} delegate - The delegate to set, or `null` to remove it. * @returns {Promise} */ @@ -261,6 +271,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Gets the current delegate. + * * @returns {Promise} A promise with the delegate of null */ @Cordova() @@ -270,6 +281,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Returns the userId currently in use, `null` by default. + * * @returns {Promise} A promise with the user ID or null */ @Cordova() @@ -281,6 +293,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { * Returns the installationId identifying your application on a device, bond to a specific userId. * If you want to store this information on your servers, keep the corresponding userId with it. * Will return `null` until the SDK is properly initialized. + * * @returns {Promise} A promise with the installation ID or null */ @Cordova() @@ -290,6 +303,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Returns the unique device identifier + * * @returns {Promise} A promise with the device ID or null */ @Cordova() @@ -299,6 +313,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Returns the push token. + * * @returns {Promise} A promise with the push token or `null` */ @Cordova() @@ -310,6 +325,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { * Returns the currently used access token. * Returns `null` until the SDK is properly initialized. * This together with your client secret gives entire control to the current installation and associated user, you should not disclose it unnecessarily. + * * @returns {Promise} */ @Cordova() @@ -333,6 +349,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Adds one or more tags to the installation. + * * @param {string|string[]} tag - The tags to add to the installation. You can use either a single string argument or an array of strings. * @returns {Promise} */ @@ -343,6 +360,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Removes one or more tags from the installation. + * * @param {string|string[]} tag - The tags to remove from the installation. You can use either a single string argument or an array of strings. * @returns {Promise} */ @@ -353,6 +371,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Removes all tags from the installation. + * * @returns {Promise} */ @Cordova() @@ -362,6 +381,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Returns all the tags of the installation. + * * @returns {Promise} */ @Cordova() @@ -371,6 +391,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Tests whether the installation has the given tag attached to it. + * * @param {string} tag - The tag to test. * @returns {Promise} */ @@ -472,6 +493,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Returns the latest known custom properties attached to the current installation object stored by WonderPush. + * * @returns {Promise<{[p: string]: any}>} */ @Cordova() @@ -504,7 +526,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { * Because in iOS you only have *one* chance for prompting the user, you should find a good timing for that. * For a start, you can systematically call it when the application starts, so that the user will be prompted directly at the first launch. * - * @return {Promise} Returns a promise that resolves upon successful subscription + * @returns {Promise} Returns a promise that resolves upon successful subscription */ @Cordova() subscribeToNotifications(): Promise { @@ -513,6 +535,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Returns whether the notifications are enabled. + * * @returns {Promise} */ @Cordova() @@ -534,6 +557,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Reads user consent state. * Returns undefined if no explicit consent was set. + * * @returns {Promise} */ @Cordova() @@ -545,6 +569,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { * Provides or withdraws user consent. * If the `requiresUserConsent` initialization option is true, * the whole SDK is paused and no data is sent to WonderPush, until consent is provided. + * * @param {boolean} consent - * @returns {Promise} */ @@ -555,6 +580,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Remove any local storage and ask the WonderPush servers to delete any data associated with the all local installations and related users. + * * @returns {Promise} */ @Cordova() @@ -564,6 +590,7 @@ export class WonderPush extends AwesomeCordovaNativePlugin { /** * Ask the WonderPush servers to delete any event associated with the all local installations. + * * @returns {Promise} */ @Cordova() diff --git a/src/@awesome-cordova-plugins/plugins/youtube-video-player/index.ts b/src/@awesome-cordova-plugins/plugins/youtube-video-player/index.ts index 47946666..8b301f32 100644 --- a/src/@awesome-cordova-plugins/plugins/youtube-video-player/index.ts +++ b/src/@awesome-cordova-plugins/plugins/youtube-video-player/index.ts @@ -4,7 +4,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Youtube Video Player * @description * Plays YouTube videos in Native YouTube App - * * @usage * For Android 5.0+ you will need to add the following to config.xml * ```xml @@ -36,6 +35,7 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class YoutubeVideoPlayer extends AwesomeCordovaNativePlugin { /** * Plays a YouTube video + * * @param videoId {string} Video ID */ @Cordova({ sync: true }) diff --git a/src/@awesome-cordova-plugins/plugins/zbar/index.ts b/src/@awesome-cordova-plugins/plugins/zbar/index.ts index 33395cb7..974c7d61 100644 --- a/src/@awesome-cordova-plugins/plugins/zbar/index.ts +++ b/src/@awesome-cordova-plugins/plugins/zbar/index.ts @@ -41,7 +41,6 @@ export interface ZBarOptions { * The ZBar Scanner Plugin allows you to scan 2d barcodes. * * Requires Cordova plugin: `cordova-plugin-cszbar`. For more info, please see the [zBar plugin docs](https://github.com/tjwoon/csZBar). - * * @usage * ```typescript * import { ZBar, ZBarOptions } from '@awesome-cordova-plugins/zbar/ngx'; @@ -64,7 +63,6 @@ export interface ZBarOptions { * }); * * ``` - * * @interfaces * ZBarOptions */ @@ -79,6 +77,7 @@ export interface ZBarOptions { export class ZBar extends AwesomeCordovaNativePlugin { /** * Open the scanner + * * @param options { ZBarOptions } Scan options * @returns {Promise} Returns a Promise that resolves with the scanned string, or rejects with an error. */ diff --git a/src/@awesome-cordova-plugins/plugins/zeroconf/index.ts b/src/@awesome-cordova-plugins/plugins/zeroconf/index.ts index 34aa9cca..b6082990 100644 --- a/src/@awesome-cordova-plugins/plugins/zeroconf/index.ts +++ b/src/@awesome-cordova-plugins/plugins/zeroconf/index.ts @@ -62,7 +62,8 @@ export interface ZeroconfResult { export class Zeroconf extends AwesomeCordovaNativePlugin { /** * Returns this device's hostname. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() getHostname(): Promise { @@ -71,12 +72,13 @@ export class Zeroconf extends AwesomeCordovaNativePlugin { /** * Publishes a new service. + * * @param type {string} Service type name, e.g. "_http._tcp". * @param domain {string} Domain scope of the service, typically "local.". * @param name {string} Unqualified service instance name. * @param port {number} Local port on which the service runs. * @param txtRecord {any} Arbitrary key/value pairs describing the service. - * @return {Promise} Returns a Promise that resolves with the registered service. + * @returns {Promise} Returns a Promise that resolves with the registered service. */ @Cordova() register(type: string, domain: string, name: string, port: number, txtRecord: any): Promise { @@ -85,10 +87,11 @@ export class Zeroconf extends AwesomeCordovaNativePlugin { /** * Unregisters a service. + * * @param type {string} Service type name, e.g. "_http._tcp". * @param domain {string} Domain scope of the service, typically "local.". * @param name {string} Unqualified service instance name. - * @return {Promise} + * @returns {Promise} */ @Cordova() unregister(type: string, domain: string, name: string): Promise { @@ -97,7 +100,8 @@ export class Zeroconf extends AwesomeCordovaNativePlugin { /** * Unregisters all published services. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() stop(): Promise { @@ -106,9 +110,10 @@ export class Zeroconf extends AwesomeCordovaNativePlugin { /** * Starts watching for services of the specified type. + * * @param type {string} Service type name, e.g. "_http._tcp". * @param domain {string} Domain scope of the service, typically "local.". - * @return {Observable} Returns an Observable that notifies of each service added or removed. + * @returns {Observable} Returns an Observable that notifies of each service added or removed. */ @Cordova({ observable: true, @@ -121,9 +126,10 @@ export class Zeroconf extends AwesomeCordovaNativePlugin { /** * Stops watching for services of the specified type. + * * @param type {string} Service type name, e.g. "_http._tcp". * @param domain {string} Domain scope of the service, typically "local.". - * @return {Promise} + * @returns {Promise} */ @Cordova() unwatch(type: string, domain: string): Promise { @@ -132,7 +138,8 @@ export class Zeroconf extends AwesomeCordovaNativePlugin { /** * Closes the service browser and stops watching. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() close(): Promise { @@ -141,7 +148,8 @@ export class Zeroconf extends AwesomeCordovaNativePlugin { /** * Re-initializes the plugin to clean service & browser state. - * @return {Promise} + * + * @returns {Promise} */ @Cordova() reInit(): Promise { diff --git a/src/@awesome-cordova-plugins/plugins/zoom/index.ts b/src/@awesome-cordova-plugins/plugins/zoom/index.ts index 47aea4ca..5d71603f 100755 --- a/src/@awesome-cordova-plugins/plugins/zoom/index.ts +++ b/src/@awesome-cordova-plugins/plugins/zoom/index.ts @@ -5,7 +5,6 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl * @name Zoom * @description * A Cordova plugin to use Zoom Video Conferencing services on Cordova applications. - * * @usage * ```typescript * import { Zoom } from '@awesome-cordova-plugins/zoom'; @@ -88,9 +87,10 @@ import { Cordova, AwesomeCordovaNativePlugin, Plugin } from '@awesome-cordova-pl export class Zoom extends AwesomeCordovaNativePlugin { /** * Initialize Zoom SDK. + * * @param appKey Zoom SDK app key. * @param appSecret Zoom SDK app secret. - * @return {Promise} + * @returns {Promise} */ @Cordova() initialize(appKey: string, appSecret: string): Promise { @@ -99,9 +99,10 @@ export class Zoom extends AwesomeCordovaNativePlugin { /** * Log user in with Zoom username and password. + * * @param username user's Zoom username. * @param password user's Zoom password. - * @return {Promise} + * @returns {Promise} */ @Cordova() login(username: string, password: string): Promise { @@ -110,7 +111,8 @@ export class Zoom extends AwesomeCordovaNativePlugin { /** * Log user out. - * @return {Promise} true if logout success / false if failed. + * + * @returns {Promise} true if logout success / false if failed. */ @Cordova() logout(): Promise { @@ -119,7 +121,8 @@ export class Zoom extends AwesomeCordovaNativePlugin { /** * Check whether the user is logged in. - * @return {Promise} true if is logged in / false if not. + * + * @returns {Promise} true if is logged in / false if not. */ @Cordova() isLoggedIn(): Promise { @@ -128,10 +131,12 @@ export class Zoom extends AwesomeCordovaNativePlugin { /** * Join a meeting for logged in user. + * * @param meetingNo meeting number. * @param meetingPassword meeting password. + * @param displayName * @param options meeting options. - * @return {Promise} + * @returns {Promise} */ @Cordova() joinMeeting(meetingNo: string, meetingPassword: string, displayName: string, options: any): Promise { @@ -140,13 +145,14 @@ export class Zoom extends AwesomeCordovaNativePlugin { /** * Start a meeting for non-login user. + * * @param meetingNo meeting number. * @param displayName display name shown in meeting. * @param zoomToken zoom token retrieved from Zoom Rest API. * @param zoomAccessToken zoom access token retrieved from Zoom Rest API. * @param userId user ID retrieved from Zoom Rest API. * @param options meeting options. - * @return {Promise} + * @returns {Promise} */ @Cordova() startMeetingWithZAK( @@ -162,9 +168,10 @@ export class Zoom extends AwesomeCordovaNativePlugin { /** * Start a meeting for logged in user. + * * @param meetingNo meeting number. * @param options meeting option. - * @return {Promise} + * @returns {Promise} */ @Cordova() startMeeting(meetingNo: string, options: any): Promise { @@ -173,8 +180,9 @@ export class Zoom extends AwesomeCordovaNativePlugin { /** * Start an instant meeting for logged in user. + * * @param options meeting option. - * @return {Promise} + * @returns {Promise} */ @Cordova() startInstantMeeting(options: any): Promise { @@ -183,8 +191,9 @@ export class Zoom extends AwesomeCordovaNativePlugin { /** * Set language. + * * @param languageTag language name. - * @return {Promise} + * @returns {Promise} */ @Cordova() setLocale(languageTag: string): Promise { diff --git a/tsconfig.json b/tsconfig.json index 5d63be26..aabac331 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -22,6 +22,5 @@ "include": ["src/@awesome-cordova-plugins/plugins/**/*.ts"], "angularCompilerOptions": { "genDir": "aot" - }, - "plugins": [{ "name": "typescript-tslint-plugin" }] + } } diff --git a/tslint.json b/tslint.json deleted file mode 100644 index 577c4ceb..00000000 --- a/tslint.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "extends": ["tslint-ionic-rules", "tslint-config-prettier"], - "rules": { - "no-empty": false, - "no-import-side-effect": false, - "no-redundant-jsdoc": false, - "ban-types": false, - "no-shadowed-variable": false, - "no-constant-condition": false, - "no-extra-boolean-cast": false, - "adjacent-overload-signatures": false, - "ter-no-proto": false, - "callable-types": false, - "ordered-imports": false, - "prefer-conditional-expression": false, - "max-classes-per-file": true - } -}