Skip to content

- Enhancement: jsdoc/typescript type for better clarity and specificty #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

- Enhancement: jsdoc/typescript type for better clarity and specificty #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8a9f1b2
- npm: Update devDeps.
brettz9 Jul 29, 2021
0f8ff1a
- Enhancement: jsdoc/typescript type for better clarity and specificty
brettz9 Jan 14, 2020
9b94dde
- Further type fixes/clarifications
brettz9 Jan 14, 2020
38c7be1
- Fix
brettz9 Jan 14, 2020
e1660d8
rename k to key
brettz9 Jul 29, 2021
2b6090a
- Update: Build
brettz9 Mar 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .remarkrc
View file
Open in desktop

This file was deleted.

14 changes: 7 additions & 7 deletions dist/index-browser-esm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ function _createForOfIteratorHelper(o, allowArrayLike) {

var hasOwnProp = Object.prototype.hasOwnProperty;
/**
* @typedef {null|boolean|number|string|PlainObject|GenericArray} JSONObject
* @typedef {null|boolean|number|string|object<string, JSON>|JSON[]} JSON
*/

/**
Expand Down Expand Up @@ -304,8 +304,8 @@ var NewError = /*#__PURE__*/function (_Error) {
}( /*#__PURE__*/_wrapNativeSuper(Error));
/**
* @typedef {PlainObject} ReturnObject
* @property {string} path
* @property {JSONObject} value
* @property {string[]} path
* @property {JSON} value
* @property {PlainObject|GenericArray} parent
* @property {string} parentProperty
*/
Expand All @@ -320,8 +320,8 @@ var NewError = /*#__PURE__*/function (_Error) {

/**
* @callback OtherTypeCallback
* @param {JSONObject} val
* @param {string} path
* @param {JSON} val
* @param {string[]} path
* @param {PlainObject|GenericArray} parent
* @param {string} parentPropName
* @returns {boolean}
Expand Down Expand Up @@ -549,8 +549,8 @@ JSONPath.prototype._handleCallback = function (fullRetObj, callback, type) {
/**
*
* @param {string} expr
* @param {JSONObject} val
* @param {string} path
* @param {JSON} val
* @param {string[]} path
* @param {PlainObject|GenericArray} parent
* @param {string} parentPropName
* @param {JSONPathCallback} callback
Expand Down
2 changes: 1 addition & 1 deletion dist/index-browser-esm.min.js.map
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions dist/index-browser-umd.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@

var hasOwnProp = Object.prototype.hasOwnProperty;
/**
* @typedef {null|boolean|number|string|PlainObject|GenericArray} JSONObject
* @typedef {null|boolean|number|string|object<string, JSON>|JSON[]} JSON
*/

/**
Expand Down Expand Up @@ -310,8 +310,8 @@
}( /*#__PURE__*/_wrapNativeSuper(Error));
/**
* @typedef {PlainObject} ReturnObject
* @property {string} path
* @property {JSONObject} value
* @property {string[]} path
* @property {JSON} value
* @property {PlainObject|GenericArray} parent
* @property {string} parentProperty
*/
Expand All @@ -326,8 +326,8 @@

/**
* @callback OtherTypeCallback
* @param {JSONObject} val
* @param {string} path
* @param {JSON} val
* @param {string[]} path
* @param {PlainObject|GenericArray} parent
* @param {string} parentPropName
* @returns {boolean}
Expand Down Expand Up @@ -555,8 +555,8 @@
/**
*
* @param {string} expr
* @param {JSONObject} val
* @param {string} path
* @param {JSON} val
* @param {string[]} path
* @param {PlainObject|GenericArray} parent
* @param {string} parentPropName
* @param {JSONPathCallback} callback
Expand Down
2 changes: 1 addition & 1 deletion dist/index-browser-umd.min.cjs.map
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions dist/index-node-cjs.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const {
hasOwnProperty: hasOwnProp
} = Object.prototype;
/**
* @typedef {null|boolean|number|string|PlainObject|GenericArray} JSONObject
* @typedef {null|boolean|number|string|object<string, JSON>|JSON[]} JSON
*/

/**
Expand Down Expand Up @@ -60,8 +60,8 @@ class NewError extends Error {
}
/**
* @typedef {PlainObject} ReturnObject
* @property {string} path
* @property {JSONObject} value
* @property {string[]} path
* @property {JSON} value
* @property {PlainObject|GenericArray} parent
* @property {string} parentProperty
*/
Expand All @@ -76,8 +76,8 @@ class NewError extends Error {

/**
* @callback OtherTypeCallback
* @param {JSONObject} val
* @param {string} path
* @param {JSON} val
* @param {string[]} path
* @param {PlainObject|GenericArray} parent
* @param {string} parentPropName
* @returns {boolean}
Expand Down Expand Up @@ -306,8 +306,8 @@ JSONPath.prototype._handleCallback = function (fullRetObj, callback, type) {
/**
*
* @param {string} expr
* @param {JSONObject} val
* @param {string} path
* @param {JSON} val
* @param {string[]} path
* @param {PlainObject|GenericArray} parent
* @param {string} parentPropName
* @param {JSONPathCallback} callback
Expand Down
14 changes: 7 additions & 7 deletions dist/index-node-esm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const {
hasOwnProperty: hasOwnProp
} = Object.prototype;
/**
* @typedef {null|boolean|number|string|PlainObject|GenericArray} JSONObject
* @typedef {null|boolean|number|string|object<string, JSON>|JSON[]} JSON
*/

/**
Expand Down Expand Up @@ -52,8 +52,8 @@ class NewError extends Error {
}
/**
* @typedef {PlainObject} ReturnObject
* @property {string} path
* @property {JSONObject} value
* @property {string[]} path
* @property {JSON} value
* @property {PlainObject|GenericArray} parent
* @property {string} parentProperty
*/
Expand All @@ -68,8 +68,8 @@ class NewError extends Error {

/**
* @callback OtherTypeCallback
* @param {JSONObject} val
* @param {string} path
* @param {JSON} val
* @param {string[]} path
* @param {PlainObject|GenericArray} parent
* @param {string} parentPropName
* @returns {boolean}
Expand Down Expand Up @@ -298,8 +298,8 @@ JSONPath.prototype._handleCallback = function (fullRetObj, callback, type) {
/**
*
* @param {string} expr
* @param {JSONObject} val
* @param {string} path
* @param {JSON} val
* @param {string[]} path
* @param {PlainObject|GenericArray} parent
* @param {string} parentPropName
* @param {JSONPathCallback} callback
Expand Down
24 changes: 10 additions & 14 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,25 +58,25 @@
"vm": false
},
"devDependencies": {
"@babel/core": "^7.14.6",
"@babel/preset-env": "^7.14.7",
"@babel/core": "^7.14.8",
"@babel/preset-env": "^7.14.8",
"@brettz9/eslint-plugin": "^1.0.3",
"@rollup/plugin-babel": "^5.3.0",
"c8": "^7.7.3",
"c8": "^7.8.0",
"chai": "^4.3.4",
"core-js-bundle": "^3.15.2",
"coveradge": "^0.7.0",
"eslint": "^7.30.0",
"eslint-config-ash-nazg": "^30.1.0",
"eslint": "^7.31.0",
"eslint-config-ash-nazg": "^31.1.1",
"eslint-config-standard": "^16.0.3",
"eslint-plugin-array-func": "^3.1.7",
"eslint-plugin-chai-expect": "^2.2.0",
"eslint-plugin-chai-friendly": "^0.7.1",
"eslint-plugin-compat": "^3.9.0",
"eslint-plugin-compat": "^3.11.1",
"eslint-plugin-eslint-comments": "^3.2.0",
"eslint-plugin-html": "^6.1.2",
"eslint-plugin-import": "^2.23.4",
"eslint-plugin-jsdoc": "^35.4.1",
"eslint-plugin-jsdoc": "^36.0.6",
"eslint-plugin-markdown": "^2.2.0",
"eslint-plugin-no-unsanitized": "^3.1.5",
"eslint-plugin-no-use-extend-native": "^0.5.0",
Expand All @@ -87,16 +87,13 @@
"eslint-plugin-unicorn": "^34.0.1",
"http-server": "^0.12.3",
"license-badger": "^0.19.0",
"mocha": "^9.0.2",
"mocha": "^9.0.3",
"mocha-badge-generator": "^0.9.0",
"mocha-multi-reporters": "^1.5.1",
"open-cli": "^7.0.0",
"remark-cli": "^9.0.0",
"remark-lint-code-block-style": "^2.0.1",
"remark-lint-ordered-list-marker-value": "^2.0.1",
"rollup": "2.52.7",
"rollup": "2.55.0",
"rollup-plugin-terser": "^7.0.2",
"typedoc": "^0.21.2",
"typedoc": "^0.21.4",
"typescript": "^4.3.5"
},
"keywords": [
Expand Down Expand Up @@ -132,7 +129,6 @@
"license-badge": "license-badger --corrections --uncategorizedLicenseTemplate \"\\${license} (\\${name} (\\${version}))\" --filteredTypes=nonempty --textTemplate \"License types\n(project, deps, and bundled devDeps)\" --packageJson --production badges/licenses-badge.svg",
"license-badge-dev": "license-badger --corrections --filteredTypes=nonempty --textTemplate \"License types\n(all devDeps)\" --allDevelopment badges/licenses-badge-dev.svg",
"license-badges": "npm run license-badge && npm run license-badge-dev",
"remark": "remark -q -f .",
"build-docs": "typedoc --out docs/ts src --excludeExternals --tsconfig src/tsconfig.json",
"open-docs": "open-cli http://localhost:8084/docs/ts/ && npm start",
"coverage": "open-cli http://localhost:8084/coverage/ && npm start",
Expand Down
Loading