@instructure/ui-utils 11.6.0 → 11.6.1-pr-snapshot-1779894247159

package/lib/index.js

@@ -1,173 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "camelize", {
-  enumerable: true,
-  get: function () {
-    return _camelize.camelize;
-  }
-});
-Object.defineProperty(exports, "capitalizeFirstLetter", {
-  enumerable: true,
-  get: function () {
-    return _capitalizeFirstLetter.capitalizeFirstLetter;
-  }
-});
-Object.defineProperty(exports, "cloneArray", {
-  enumerable: true,
-  get: function () {
-    return _cloneArray.cloneArray;
-  }
-});
-Object.defineProperty(exports, "combineDataCid", {
-  enumerable: true,
-  get: function () {
-    return _combineDataCid.combineDataCid;
-  }
-});
-Object.defineProperty(exports, "createChainedFunction", {
-  enumerable: true,
-  get: function () {
-    return _createChainedFunction.createChainedFunction;
-  }
-});
-Object.defineProperty(exports, "deepEqual", {
-  enumerable: true,
-  get: function () {
-    return _deepEqual.deepEqual;
-  }
-});
-Object.defineProperty(exports, "generateId", {
-  enumerable: true,
-  get: function () {
-    return _generateId.generateId;
-  }
-});
-Object.defineProperty(exports, "getBrowser", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.getBrowser;
-  }
-});
-Object.defineProperty(exports, "hash", {
-  enumerable: true,
-  get: function () {
-    return _hash.hash;
-  }
-});
-Object.defineProperty(exports, "isAndroidOrIOS", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isAndroidOrIOS;
-  }
-});
-Object.defineProperty(exports, "isBaseTheme", {
-  enumerable: true,
-  get: function () {
-    return _isBaseTheme.isBaseTheme;
-  }
-});
-Object.defineProperty(exports, "isChromium", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isChromium;
-  }
-});
-Object.defineProperty(exports, "isEdge", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isEdge;
-  }
-});
-Object.defineProperty(exports, "isEmpty", {
-  enumerable: true,
-  get: function () {
-    return _isEmpty.isEmpty;
-  }
-});
-Object.defineProperty(exports, "isFirefox", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isFirefox;
-  }
-});
-Object.defineProperty(exports, "isIE", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isIE;
-  }
-});
-Object.defineProperty(exports, "isMac", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isMac;
-  }
-});
-Object.defineProperty(exports, "isSafari", {
-  enumerable: true,
-  get: function () {
-    return _getBrowser.isSafari;
-  }
-});
-Object.defineProperty(exports, "mergeDeep", {
-  enumerable: true,
-  get: function () {
-    return _mergeDeep.mergeDeep;
-  }
-});
-Object.defineProperty(exports, "ms", {
-  enumerable: true,
-  get: function () {
-    return _ms.ms;
-  }
-});
-Object.defineProperty(exports, "parseUnit", {
-  enumerable: true,
-  get: function () {
-    return _parseUnit.parseUnit;
-  }
-});
-Object.defineProperty(exports, "pascalize", {
-  enumerable: true,
-  get: function () {
-    return _pascalize.pascalize;
-  }
-});
-Object.defineProperty(exports, "px", {
-  enumerable: true,
-  get: function () {
-    return _px.px;
-  }
-});
-Object.defineProperty(exports, "shallowEqual", {
-  enumerable: true,
-  get: function () {
-    return _shallowEqual.shallowEqual;
-  }
-});
-Object.defineProperty(exports, "within", {
-  enumerable: true,
-  get: function () {
-    return _within.within;
-  }
-});
-var _capitalizeFirstLetter = require("./capitalizeFirstLetter");
-var _cloneArray = require("./cloneArray");
-var _createChainedFunction = require("./createChainedFunction");
-var _deepEqual = require("./deepEqual");
-var _hash = require("./hash");
-var _generateId = require("./generateId");
-var _isEmpty = require("./isEmpty");
-var _mergeDeep = require("./mergeDeep");
-var _ms = require("./ms");
-var _parseUnit = require("./parseUnit");
-var _px = require("./px");
-var _shallowEqual = require("./shallowEqual");
-var _within = require("./within");
-var _camelize = require("./camelize");
-var _pascalize = require("./pascalize");
-var _isBaseTheme = require("./isBaseTheme");
-var _getBrowser = require("./getBrowser");
-var _combineDataCid = require("./combineDataCid");

package/lib/isBaseTheme.js

@@ -1,50 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isBaseTheme = exports.default = void 0;
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-const baseThemeProps = ['borders', 'breakpoints', 'colors', 'forms', 'media', 'shadows', 'spacing', 'stacking', 'transitions', 'typography'];
-
-/**
- * Checks if the given param is an object with all the keys needed for an
- * Instructure theme.
- * @param theme Anything. This function will throw an error if it's not a theme
- * object.
- */
-const isBaseTheme = theme => {
-  if (Array.isArray(theme) || typeof theme === 'function') {
-    throw new Error();
-  }
-  try {
-    return 'key' in theme && baseThemeProps.every(prop => prop in theme);
-  } catch {
-    throw new Error();
-  }
-};
-exports.isBaseTheme = isBaseTheme;
-var _default = exports.default = isBaseTheme;

package/lib/mergeDeep.js

@@ -1,83 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.mergeDeep = mergeDeep;
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/utils
- * ---
- * Deep merge N objects into a single result object.
- * Merging creates a new object, so that none of the arguments are modified.
- *
- * @module mergeDeep
- *
- * @param {Object} args objects to merge
- * @returns {Object} a new object with items from all arguments
- */
-function mergeDeep(...args) {
-  // note: This could be typed as the union of its args, but since
-  // its barely used its not worth the effort currently
-  let target = {};
-  args.forEach(arg => {
-    target = mergeSourceIntoTarget(target, arg);
-  });
-  return target;
-}
-function mergeSourceIntoTarget(target, source) {
-  if (isObject(source)) {
-    const keys = [...Object.keys(source), ...Object.getOwnPropertySymbols(source)];
-    const merged = {
-      ...target
-    };
-    keys.forEach(key => {
-      if (isObject(target[key]) && isObject(source[key])) {
-        merged[key] = mergeSourceIntoTarget(target[key], source[key]);
-      } else if (isArray(source[key]) && isArray(target[key])) {
-        merged[key] = [...new Set([...target[key], ...source[key]])];
-      } else if (isArray(target[key])) {
-        merged[key] = [...new Set([...target[key], ...[source[key]]])];
-      } else {
-        merged[key] = source[key];
-      }
-    });
-    return merged;
-  } else {
-    return {
-      ...target
-    };
-  }
-}
-function isObject(item) {
-  return item && (typeof item === 'object' || typeof item === 'function') && !Array.isArray(item);
-}
-function isArray(item) {
-  return Array.isArray(item);
-}
-var _default = exports.default = mergeDeep;

package/lib/ms.js

@@ -1,67 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.ms = ms;
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-var _parseUnit3 = require("./parseUnit");
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/utils
- * ---
- * Converts a unit value time combination (s, ms) to a number representing ms
- *
- * @module ms
- *
- * Example inputs:
- *  - '100s'
- *  - '20ms'
- *
- * @param {String|Number} val
- * @returns {Number} Returns numerical representation of milliseconds
- */
-function ms(val) {
-  // TODO: throw an error if val is not number or string
-  if (!val || typeof val === 'number') {
-    return val;
-  }
-  const _parseUnit = (0, _parseUnit3.parseUnit)(val),
-    _parseUnit2 = (0, _slicedToArray2.default)(_parseUnit, 2),
-    num = _parseUnit2[0],
-    unit = _parseUnit2[1];
-  if (unit === 'ms') {
-    return num;
-  } else if (unit === 's') {
-    return num * 1000;
-  } else {
-    return num;
-  }
-}
-var _default = exports.default = ms;

package/lib/package.json

@@ -1 +0,0 @@
-{"type":"commonjs"}

package/lib/parseUnit.js

@@ -1,57 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.parseUnit = parseUnit;
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/utils
- * ---
- * Converts a CSS unit value combination into an array of type [ value, unit ]
- *
- * @module parseUnit
- *
- * Example inputs:
- *  - '100px'
- *  - '20rem'
- *  - '10vh'
- *  - '400vmin'
- *
- * @param {string|number} str
- * @returns {Array} Returns array of shape [ value, unit ] Unit is '' if it could
- * not be parsed
- */
-
-function parseUnit(str) {
-  const value = `${str}`;
-  // eslint-disable-next-line no-useless-escape
-  const match = value.match(/[\d.\-\+]*\s*(.*)/);
-  return [parseFloat(value), match && match.length > 0 ? match[1] : ''];
-}
-var _default = exports.default = parseUnit;

package/lib/pascalize.js

@@ -1,55 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.pascalize = pascalize;
-var _capitalizeFirstLetter = require("./capitalizeFirstLetter");
-var _camelize = require("./camelize");
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/utils
- * ---
- * Converts a hyphenated or camel cased string to pascal case
- *
- * Example inputs:
- *  - 'foo-bar'
- *  - 'baz-qux'
- *
- * Example outputs:
- *  - 'FooBar'
- *  - 'BazQux'
- *
- * @module pascalize
- * @param {String} str
- * @returns {String} Returns pascal cased string
- */
-function pascalize(str) {
-  return (0, _capitalizeFirstLetter.capitalizeFirstLetter)((0, _camelize.camelize)(str));
-}
-var _default = exports.default = pascalize;

package/lib/px.js

@@ -1,73 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.px = px;
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-var _canUseDOM = require("@instructure/ui-dom-utils/lib/canUseDOM.js");
-var _getFontSize = require("@instructure/ui-dom-utils/lib/getFontSize.js");
-var _parseUnit3 = require("./parseUnit");
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/utils
- * ---
- * Converts a unit value size combination (em, rem, px) to a number representing px
- *
- * Example inputs:
- *  - '100rem'
- *  - '20em'
- *  - '40px'
- *
- * @module px
- *
- * @param {String|number} val The value to look up. If it's a number its just returned as is.
- * @param {Document|Window|Node|React.ReactElement |React.Component|null} el - containing element, for context measure is em (defaults to `document.body`)
- * @returns {Number} Returns numerical representation of pixels
- */
-function px(val, el) {
-  // TODO !val should not be needed
-  if (!val || typeof val === 'number') {
-    return val;
-  }
-  const _parseUnit = (0, _parseUnit3.parseUnit)(val),
-    _parseUnit2 = (0, _slicedToArray2.default)(_parseUnit, 2),
-    num = _parseUnit2[0],
-    unit = _parseUnit2[1];
-  if (unit === 'rem') {
-    return num * (0, _getFontSize.getFontSize)();
-  } else if (unit === 'em') {
-    const doc = _canUseDOM.canUseDOM ? document.body : null;
-    const container = el || doc;
-    return num * (0, _getFontSize.getFontSize)(container);
-  } else {
-    return num;
-  }
-}
-var _default = exports.default = px;

package/lib/shallowEqual.js

@@ -1,85 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.shallowEqual = shallowEqual;
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-// https://github.com/facebook/fbjs/blob/master/packages/fbjs/src/core/shallowEqual.js
-const hasOwnProperty = Object.prototype.hasOwnProperty;
-
-/**
- * ---
- * category: utilities/utils
- * ---
- * Performs equality by iterating through keys on an object and returning false
- * when any key has values which are not strictly equal between the arguments.
- *
- * @module shallowEqual
- *
- * @param {Object} objA
- * @param {Object} objB
- * @returns {Boolean} Returns true when the values of all keys are strictly equal
- */
-function shallowEqual(objA, objB) {
-  if (is(objA, objB)) {
-    return true;
-  }
-  if (typeof objA !== 'object' || objA === null || typeof objB !== 'object' || objB === null) {
-    return false;
-  }
-  const keysA = Object.keys(objA);
-  const keysB = Object.keys(objB);
-  if (keysA.length !== keysB.length) {
-    return false;
-  }
-
-  // Test for A's keys different from B.
-  for (let i = 0; i < keysA.length; i++) {
-    if (!hasOwnProperty.call(objB, keysA[i]) || !is(objA[keysA[i]], objB[keysA[i]])) {
-      return false;
-    }
-  }
-  return true;
-}
-
-/*
- * inlined Object.is polyfill to avoid requiring consumers ship their own
- * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is
- */
-function is(x, y) {
-  // SameValue algorithm
-  if (x === y) {
-    // Steps 1-5, 7-10
-    // Steps 6.b-6.e: +0 != -0
-    return x !== 0 || y !== 0 || 1 / x === 1 / y;
-  } else {
-    // Step 6.a: NaN == NaN
-    return x !== x && y !== y;
-  }
-}
-var _default = exports.default = shallowEqual;

package/lib/within.js

@@ -1,48 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.within = within;
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/utils
- * ---
- * Determines if one numerical value (a) is within a designated range (diff) of another (b)
- *
- * @module within
- *
- * @param {number} a
- * @param {number} b
- * @param {number} [diff=1]
- * @returns {Boolean} Returns true if a is within the diff range of b
- */
-function within(a, b, diff = 1) {
-  return a + diff >= b && b >= a - diff;
-}
-var _default = exports.default = within;