@oscarpalmer/atoms 0.176.0 → 0.178.0

package/src/is.ts

@@ -30,15 +30,64 @@ export function isEmpty(value: unknown): boolean {
 	return true;
 }
 
+/**
+ * Is the value not empty, or holding non-empty values?
+ * @param value Value to check
+ * @returns `true` if the value is not considered empty, otherwise `false`
+ */
+export function isNonEmpty(value: unknown): boolean {
+	return !isEmpty(value);
+}
+
 /**
  * Is the value not `undefined` or `null`?
  * @param value Value to check
  * @returns `true` if the value is not `undefined` or `null`, otherwise `false`
  */
-export function isNonNullable(value: unknown): value is Exclude<unknown, undefined | null> {
+export function isNonNullable<Value>(value: Value): value is Exclude<Value, undefined | null> {
 	return value != null;
 }
 
+/**
+ * Is the value not `undefined`, `null`, or stringified as an empty _(no whitespace)_ string?
+ * @param value Value to check
+ * @returns `true` if the value is not `undefined`, `null`, or matches an empty string, otherwise `false`
+ */
+export function isNonNullableOrEmpty<Value>(
+	value: Value,
+): value is Exclude<Value, undefined | null | ''> {
+	return value != null && getString(value) !== '';
+}
+
+/**
+ * Is the value not `undefined`, `null`, or stringified as a whitespace-only string?
+ * @param value Value to check
+ * @returns `true` if the value is not `undefined`, `null`, or matches a whitespace-only string, otherwise `false`
+ */
+export function isNonNullableOrWhitespace<Value>(
+	value: Value,
+): value is Exclude<Value, undefined | null | ''> {
+	return value != null && !EXPRESSION_WHITESPACE.test(getString(value));
+}
+
+/**
+ * Is the value not a number or a number-like string?
+ * @param value Value to check
+ * @returns `true` if the value is not a number or a number-like string, otherwise `false`
+ */
+export function isNonNumerical<Value>(value: Value): value is Exclude<Value, number | `${number}`> {
+	return !isNumerical(value);
+}
+
+/**
+ * Is the value not an object _(or function)_?
+ * @param value Value to check
+ * @returns `true` if the value is not an object, otherwise `false`
+ */
+export function isNonObject<Value>(value: Value): value is Exclude<Value, object> {
+	return !isObject(value);
+}
+
 /**
  * Is the value `undefined` or `null`?
  * @param value Value to check
@@ -49,18 +98,18 @@ export function isNullable(value: unknown): value is undefined | null {
 }
 
 /**
- * Is the value `undefined`, `null`, or an empty _(no whitespace)_ string?
+ * Is the value `undefined`, `null`, or stringified as an empty _(no whitespace)_ string?
  * @param value Value to check
- * @returns `true` if the value is nullable or an empty string, otherwise `false`
+ * @returns `true` if the value is nullable or matches an empty string, otherwise `false`
  */
 export function isNullableOrEmpty(value: unknown): value is undefined | null | '' {
 	return value == null || getString(value) === '';
 }
 
 /**
- * Is the value `undefined`, `null`, or a whitespace-only string?
+ * Is the value `undefined`, `null`, or stringified as a whitespace-only string?
  * @param value Value to check
- * @returns `true` if the value is nullable or a whitespace-only string, otherwise `false`
+ * @returns `true` if the value is nullable or matches a whitespace-only string, otherwise `false`
  */
 export function isNullableOrWhitespace(value: unknown): value is undefined | null | '' {
 	return value == null || EXPRESSION_WHITESPACE.test(getString(value));
@@ -69,7 +118,7 @@ export function isNullableOrWhitespace(value: unknown): value is undefined | nul
 /**
  * Is the value a number or a number-like string?
  * @param value Value to check
- * @returns `true` if the value is a number or a parseable string, otherwise `false`
+ * @returns `true` if the value is a number or a number-like string, otherwise `false`
  */
 export function isNumerical(value: unknown): value is number | `${number}` {
 	return (
@@ -102,6 +151,14 @@ export {
 	isConstructor,
 	isInstanceOf,
 	isKey,
+	isNonArrayOrPlainObject,
+	isNonConstructor,
+	isNonInstanceOf,
+	isNonKey,
+	isNonNumber,
+	isNonPlainObject,
+	isNonPrimitive,
+	isNonTypedArray,
 	isNumber,
 	isPlainObject,
 	isPrimitive,

package/src/string/index.ts

@@ -1,5 +1,63 @@
+import {isTemplateStringsArray} from '../internal/is';
+import {getString} from '../internal/string';
+
 // #region Functions
 
+export function dedent(strings: TemplateStringsArray, ...values: unknown[]): string;
+
+export function dedent(value: string): string;
+
+export function dedent(value: string | TemplateStringsArray, ...values: unknown[]): string {
+	let actual: string;
+
+	if (isTemplateStringsArray(value)) {
+		actual = interpolate(value, values);
+	} else {
+		actual = value;
+	}
+
+	if (typeof actual !== 'string') {
+		return '';
+	}
+
+	const lines = actual.split('\n');
+	const {length} = lines;
+
+	if (length === 1) {
+		return actual.trim();
+	}
+
+	const lastIndex = length - 1;
+
+	const lengths: number[] = [];
+
+	for (let index = 0; index < length; index += 1) {
+		const [, indentation] = /^(\s+)/.exec(lines[index]) ?? [];
+
+		if (indentation != null) {
+			lengths.push(indentation.length);
+		}
+	}
+
+	if (lengths.length === 0) {
+		return actual.trim();
+	}
+
+	const minimum = Math.min(...lengths);
+
+	const pattern = new RegExp(`^\\s{0,${minimum}}`);
+
+	let result = '';
+
+	for (let index = 0; index < length; index += 1) {
+		const line = lines[index];
+
+		result += line.replace(pattern, '') + (index === lastIndex ? '' : '\n');
+	}
+
+	return result.trim();
+}
+
 /**
  * Get a new UUID-string _(version 4)_
  * @returns UUID string
@@ -24,6 +82,18 @@ export function getUuid(): string {
 	].join('-');
 }
 
+function interpolate(strings: TemplateStringsArray, values: unknown[]): string {
+	const {length} = strings;
+
+	let interpolated = '';
+
+	for (let index = 0; index < length; index += 1) {
+		interpolated += `${strings[index]}${getString(values[index])}`;
+	}
+
+	return interpolated;
+}
+
 /**
  * Parse a JSON string into its proper value _(or `undefined` if it fails)_
  * @param value JSON string to parse
@@ -78,6 +148,8 @@ export function truncate(value: string, length: number, suffix?: string): string
 	return `${value.slice(0, truncatedLength)}${actualSuffix}`;
 }
 
+// #endregion
+
 // #region Variables
 
 const ZERO = '0';
@@ -86,4 +158,8 @@ const ZERO = '0';
 
 // #endregion
 
+// #region Exports
+
 export {getString, join, words} from '../internal/string';
+
+// #endregion