Skip to content

Commit

Permalink
fix jsdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
stanislav-atr committed Nov 15, 2022
1 parent c7b0de8 commit 4d2cb8f
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/helpers/object-utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export const safeGetDescriptor = (obj, prop) => {
* Set getter and setter to property if it's configurable
* @param {Object} object target object with property
* @param {string} property property name
* @param {Object} descriptor contains getter and setter functions
* @param {PropertyDescriptor} descriptor contains getter and setter functions
* @returns {boolean} is operation successful
*/
export function setPropertyAccess(object, property, descriptor) {
Expand Down
2 changes: 1 addition & 1 deletion src/helpers/observer.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { throttle } from './throttle';
/**
* DOM tree changes observer. Used for 'remove-attr' and 'remove-class' scriptlets
* @param {Function} callback
* @param {Boolean} observeAttrs - optional parameter - should observer check attributes changes
* @param {boolean} observeAttrs - optional parameter - should observer check attributes changes
*/
export const observeDOMChanges = (callback, observeAttrs = false, attrsToObserve = []) => {
/**
Expand Down
5 changes: 5 additions & 0 deletions src/helpers/storage-utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ export const setStorageItem = (storage, key, value, shouldLog) => {
}
};

/**
* Gets supported storage item value
* @param {string} value input item value
* @returns {string|null|undefined|boolean} valid item value if ok OR null if not
*/
export const getLimitedStorageItemValue = (value) => {
if (!value) {
return null;
Expand Down
2 changes: 1 addition & 1 deletion src/scriptlets/prevent-xhr.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ export function preventXHR(source, propsToMatch, customResponseText) {
responseUrl = xhrData.url;
if (typeof propsToMatch === 'undefined') {
// Log if no propsToMatch given
logMessage(`log: xhr( ${objectToString(xhrData)} )`);
logMessage(`xhr( ${objectToString(xhrData)} )`);
hit(source);
} else {
shouldPrevent = matchRequestProps(propsToMatch, xhrData);
Expand Down

0 comments on commit 4d2cb8f

Please sign in to comment.