@hkdigital/lib-sveltekit 0.1.5 → 0.1.6

package/dist/util/image/index.js

@@ -1,86 +1,86 @@
-/**
- * Returns the unchanged image meta object or the last item of
- * an array of ImageMeta objects. This is assumed to be a list
- * of sorted responsive image formats, so it should be the
- * largest image.
- *
- * @param {ImageMeta|ImageMeta[]} imageMeta
- */
-export function toSingleImageMeta(imageMeta) {
-  if (Array.isArray(imageMeta)) {
-    if (!imageMeta.length) {
-      throw new Error('List of ImageMeta objects is empty');
-    }
-    imageMeta = imageMeta[imageMeta.length - 1];
-  }
-
-  if (typeof imageMeta === 'object') {
-    return imageMeta;
-  } else if (!imageMeta) {
-    throw new Error('Missing [imageMeta]');
-  }
-
-  throw new Error('Invalid value for parameter [imageMeta]');
-}
-
-/**
- * Calculate effective width based on container dimensions and fit mode
- *
- * @param {object} params
- * @param {number} [params.containerWidth] Container width in pixels
- * @param {number} [params.containerHeight] Container height in pixels
- * @param {number} params.imageAspectRatio Original image aspect ratio (width/height)
- * @param {'cover'|'contain'|'fill'} [params.fit='contain'] Fit mode
- * @returns {number} Effective width needed
- */
-export function calculateEffectiveWidth({
-  containerWidth,
-  containerHeight,
-  imageAspectRatio,
-  fit = 'contain'
-}) {
-  if (containerWidth && !containerHeight) {
-    // If only width is provided, use it
-
-    return containerWidth;
-  }
-
-  if (!containerWidth && containerHeight) {
-    // If only height is provided, calculate width based on aspect ratio
-
-    return containerHeight * imageAspectRatio;
-  }
-
-  if (containerWidth && containerHeight) {
-    // If both dimensions are provided, calculate based on fit mode
-
-    const containerAspectRatio = containerWidth / containerHeight;
-
-    switch (fit) {
-      case 'fill':
-        return containerWidth;
-
-      case 'contain':
-        if (containerAspectRatio > imageAspectRatio) {
-          // Height constrained, scale width accordingly
-
-          return containerHeight * imageAspectRatio;
-        }
-        return containerWidth;
-
-      case 'cover':
-        if (containerAspectRatio < imageAspectRatio) {
-          // Height constrained, scale width accordingly
-
-          return containerHeight * imageAspectRatio;
-        }
-        return containerWidth;
-
-      default:
-        return containerWidth;
-    }
-  }
-
-  // Fallback if neither dimension is provided
-  throw new Error('Either containerWidth or containerHeight must be provided');
-}
+/**
+ * Returns the unchanged image meta object or the last item of
+ * an array of ImageMeta objects. This is assumed to be a list
+ * of sorted responsive image formats, so it should be the
+ * largest image.
+ *
+ * @param {ImageMeta|ImageMeta[]} imageMeta
+ */
+export function toSingleImageMeta(imageMeta) {
+  if (Array.isArray(imageMeta)) {
+    if (!imageMeta.length) {
+      throw new Error('List of ImageMeta objects is empty');
+    }
+    imageMeta = imageMeta[imageMeta.length - 1];
+  }
+
+  if (typeof imageMeta === 'object') {
+    return imageMeta;
+  } else if (!imageMeta) {
+    throw new Error('Missing [imageMeta]');
+  }
+
+  throw new Error('Invalid value for parameter [imageMeta]');
+}
+
+/**
+ * Calculate effective width based on container dimensions and fit mode
+ *
+ * @param {object} params
+ * @param {number} [params.containerWidth] Container width in pixels
+ * @param {number} [params.containerHeight] Container height in pixels
+ * @param {number} params.imageAspectRatio Original image aspect ratio (width/height)
+ * @param {'cover'|'contain'|'fill'} [params.fit='contain'] Fit mode
+ * @returns {number} Effective width needed
+ */
+export function calculateEffectiveWidth({
+  containerWidth,
+  containerHeight,
+  imageAspectRatio,
+  fit = 'contain'
+}) {
+  if (containerWidth && !containerHeight) {
+    // If only width is provided, use it
+
+    return containerWidth;
+  }
+
+  if (!containerWidth && containerHeight) {
+    // If only height is provided, calculate width based on aspect ratio
+
+    return containerHeight * imageAspectRatio;
+  }
+
+  if (containerWidth && containerHeight) {
+    // If both dimensions are provided, calculate based on fit mode
+
+    const containerAspectRatio = containerWidth / containerHeight;
+
+    switch (fit) {
+      case 'fill':
+        return containerWidth;
+
+      case 'contain':
+        if (containerAspectRatio > imageAspectRatio) {
+          // Height constrained, scale width accordingly
+
+          return containerHeight * imageAspectRatio;
+        }
+        return containerWidth;
+
+      case 'cover':
+        if (containerAspectRatio < imageAspectRatio) {
+          // Height constrained, scale width accordingly
+
+          return containerHeight * imageAspectRatio;
+        }
+        return containerWidth;
+
+      default:
+        return containerWidth;
+    }
+  }
+
+  // Fallback if neither dimension is provided
+  throw new Error('Either containerWidth or containerHeight must be provided');
+}

package/dist/util/index.js

@@ -1,2 +1,2 @@
-export * as expect from './expect/index.js';
-export * as singleton from './singleton/index.js';
+export * as expect from './expect/index.js';
+export * as singleton from './singleton/index.js';

package/dist/util/is/index.js

@@ -1,140 +1,140 @@
-/** Internals */
-
-//
-// @see https://developer.mozilla.org/
-//    en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncFunction
-//
-const AsyncFunction = Object.getPrototypeOf(async () => {}).constructor;
-const objectToString = Object.prototype.toString;
-
-/** Exports */
-
-/**
- * Check if a value looks like an array
- *
- * @param {any} item - Item to check
- *
- * @return {boolean} true if the value looks like an array
- */
-export function isArrayLike(item) {
-	if (!(item instanceof Object)) {
-		return false;
-	}
-
-	if ('length' in item) {
-		return true;
-	}
-
-	return false;
-}
-
-/**
- * Check if a value is an Arguments object
- *
- * @param {any} value
- *
- * @returns {boolean} true if the value is an Arguments object
- */
-export function isArguments(value) {
-	return objectToString.call(value) === '[object Arguments]';
-}
-
-/**
- * Check if a value is an array that only contains primitives
- * - A primitive is a not-object value
- *
- * @param {any} value - value to check
- *
- * @return {boolean} true if the value is an array of primitives
- */
-export function isArrayOfPrimitives(arr) {
-	if (!Array.isArray(arr)) {
-		return false;
-	}
-
-	for (let j = 0, n = arr.length; j < n; j = j + 1) {
-		if (arr[j] instanceof Object) {
-			// current value is not a primitive
-			return false;
-		}
-	}
-
-	return true;
-}
-
-/**
- * Check if the supplied value is async iterable
- * - Aync iterable objects must implement the "@@asyncIterator" method
- *
- * @param {any} value
- *
- * @returns {boolean} true if the value is async iterable
- */
-export function isAsyncIterator(value) {
-	if (!(value instanceof Object) || typeof value[Symbol.asyncIterator] !== 'function') {
-		return false;
-	}
-
-	return true;
-}
-
-/**
- * Check if the supplied value is an async function
- * - Returns true for functions declared as "async function" or
- *   async () => {}
- *
- * @warning this function does not return [true] for (sync) functions that
- *   return a promise.
- *
- * @param {any} value
- *
- * @returns {boolean} true if the value is an async function
- */
-export function isAsyncFunction(value) {
-	if (value instanceof AsyncFunction) {
-		return true;
-	}
-
-	return false;
-}
-
-/**
- * Check if the supplied value is iterable
- * - Iterable objects must implement the "@@iterator" method
- * - Generators are also iterable
- *
- * @param {any} value
- *
- * @returns {boolean} true if the value is (not async) iterable
- */
-export function isIterable(value) {
-	if (!(value instanceof Object) || typeof value[Symbol.iterator] !== 'function') {
-		return false;
-	}
-
-	return true;
-}
-
-/**
- * Check if the supplied value is an object bu not a promise
- * - Promises return false
- * - Arrays return true
- *
- * @param {any} value
- *
- * @returns {boolean} true if the value is an Object, but not a Promise
- */
-export function isObject(value) {
-	if (!(value instanceof Object)) {
-		if (value && typeof value === 'object') {
-			// e.g. obj = Object.create(null);
-			return true;
-		}
-
-		return false;
-	} else if (value instanceof Promise) {
-		return false;
-	}
-
-	return true;
-}
+/** Internals */
+
+//
+// @see https://developer.mozilla.org/
+//    en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncFunction
+//
+const AsyncFunction = Object.getPrototypeOf(async () => {}).constructor;
+const objectToString = Object.prototype.toString;
+
+/** Exports */
+
+/**
+ * Check if a value looks like an array
+ *
+ * @param {any} item - Item to check
+ *
+ * @return {boolean} true if the value looks like an array
+ */
+export function isArrayLike(item) {
+	if (!(item instanceof Object)) {
+		return false;
+	}
+
+	if ('length' in item) {
+		return true;
+	}
+
+	return false;
+}
+
+/**
+ * Check if a value is an Arguments object
+ *
+ * @param {any} value
+ *
+ * @returns {boolean} true if the value is an Arguments object
+ */
+export function isArguments(value) {
+	return objectToString.call(value) === '[object Arguments]';
+}
+
+/**
+ * Check if a value is an array that only contains primitives
+ * - A primitive is a not-object value
+ *
+ * @param {any} value - value to check
+ *
+ * @return {boolean} true if the value is an array of primitives
+ */
+export function isArrayOfPrimitives(arr) {
+	if (!Array.isArray(arr)) {
+		return false;
+	}
+
+	for (let j = 0, n = arr.length; j < n; j = j + 1) {
+		if (arr[j] instanceof Object) {
+			// current value is not a primitive
+			return false;
+		}
+	}
+
+	return true;
+}
+
+/**
+ * Check if the supplied value is async iterable
+ * - Aync iterable objects must implement the "@@asyncIterator" method
+ *
+ * @param {any} value
+ *
+ * @returns {boolean} true if the value is async iterable
+ */
+export function isAsyncIterator(value) {
+	if (!(value instanceof Object) || typeof value[Symbol.asyncIterator] !== 'function') {
+		return false;
+	}
+
+	return true;
+}
+
+/**
+ * Check if the supplied value is an async function
+ * - Returns true for functions declared as "async function" or
+ *   async () => {}
+ *
+ * @warning this function does not return [true] for (sync) functions that
+ *   return a promise.
+ *
+ * @param {any} value
+ *
+ * @returns {boolean} true if the value is an async function
+ */
+export function isAsyncFunction(value) {
+	if (value instanceof AsyncFunction) {
+		return true;
+	}
+
+	return false;
+}
+
+/**
+ * Check if the supplied value is iterable
+ * - Iterable objects must implement the "@@iterator" method
+ * - Generators are also iterable
+ *
+ * @param {any} value
+ *
+ * @returns {boolean} true if the value is (not async) iterable
+ */
+export function isIterable(value) {
+	if (!(value instanceof Object) || typeof value[Symbol.iterator] !== 'function') {
+		return false;
+	}
+
+	return true;
+}
+
+/**
+ * Check if the supplied value is an object bu not a promise
+ * - Promises return false
+ * - Arrays return true
+ *
+ * @param {any} value
+ *
+ * @returns {boolean} true if the value is an Object, but not a Promise
+ */
+export function isObject(value) {
+	if (!(value instanceof Object)) {
+		if (value && typeof value === 'object') {
+			// e.g. obj = Object.create(null);
+			return true;
+		}
+
+		return false;
+	} else if (value instanceof Promise) {
+		return false;
+	}
+
+	return true;
+}