@oscarpalmer/atoms 0.74.1 → 0.76.0

package/types/string/index.d.cts

@@ -1,29 +1,5 @@
 // Generated by dts-bundle-generator v9.5.1
 
-/**
- * Convert a string to camel case _(thisIsCamelCase)_
- */
-export declare function camelCase(value: string): string;
-/**
- * Capitalise the first letter of a string _(and lowercase the rest)_
- */
-export declare function capitalise(value: string): string;
-/**
- * Convert a string to kebab case _(this-is-kebab-case)_
- */
-export declare function kebabCase(value: string): string;
-/**
- * Convert a string to pascal case _(ThisIsPascalCase)_
- */
-export declare function pascalCase(value: string): string;
-/**
- * Convert a string to snake case _(this_is_snake_case)_
- */
-export declare function snakeCase(value: string): string;
-/**
- * Convert a string to title case _(capitalising every word)_
- */
-export declare function titleCase(value: string): string;
 /**
 Represents an object with `unknown` value. You probably want this instead of `{}`.
 
@@ -56,6 +32,30 @@ isObject('hello');
 */
 export type UnknownRecord = Record<PropertyKey, unknown>;
 export type PlainObject = UnknownRecord;
+/**
+ * Convert a string to camel case _(thisIsCamelCase)_
+ */
+export declare function camelCase(value: string): string;
+/**
+ * Capitalise the first letter of a string _(and lowercase the rest)_
+ */
+export declare function capitalise(value: string): string;
+/**
+ * Convert a string to kebab case _(this-is-kebab-case)_
+ */
+export declare function kebabCase(value: string): string;
+/**
+ * Convert a string to pascal case _(ThisIsPascalCase)_
+ */
+export declare function pascalCase(value: string): string;
+/**
+ * Convert a string to snake case _(this_is_snake_case)_
+ */
+export declare function snakeCase(value: string): string;
+/**
+ * Convert a string to title case _(capitalising every word)_
+ */
+export declare function titleCase(value: string): string;
 export type Options = {
 	/**
 	 * Ignore case when searching for variables?
@@ -66,6 +66,9 @@ export type Options = {
 	 */
 	pattern?: RegExp;
 };
+/**
+ * Render a string from a template with variables
+ */
 export declare function template(value: string, variables: PlainObject, options?: Partial<Options>): string;
 /**
  * Create a new UUID
@@ -76,15 +79,15 @@ export declare function createUuid(): string;
  */
 export declare function getString(value: unknown): string;
 /**
- * Joins an array into a string while ignoring empty values _(with an optional delimiter)_
+ * Join an array into a string while ignoring empty values _(with an optional delimiter)_
  */
 export declare function join(value: unknown[], delimiter?: string): string;
 /**
- * Parses a JSON string into its proper value _(or `undefined` if it fails)_
+ * Parse a JSON string into its proper value _(or `undefined` if it fails)_
  */
 export declare function parse(value: string, reviver?: (this: unknown, key: string, value: unknown) => unknown): unknown;
 /**
- * Truncates a string to a specified length, when possible
+ * Truncate a string to a specified length, when possible
  * - Returned as-is if the string is already short enough
  * - A suffix may be appended to the truncated string, e.g., an ellipsis
  */

package/types/string/index.d.ts

@@ -7,15 +7,15 @@ export declare function createUuid(): string;
  */
 export declare function getString(value: unknown): string;
 /**
- * Joins an array into a string while ignoring empty values _(with an optional delimiter)_
+ * Join an array into a string while ignoring empty values _(with an optional delimiter)_
  */
 export declare function join(value: unknown[], delimiter?: string): string;
 /**
- * Parses a JSON string into its proper value _(or `undefined` if it fails)_
+ * Parse a JSON string into its proper value _(or `undefined` if it fails)_
  */
 export declare function parse(value: string, reviver?: (this: unknown, key: string, value: unknown) => unknown): unknown;
 /**
- * Truncates a string to a specified length, when possible
+ * Truncate a string to a specified length, when possible
  * - Returned as-is if the string is already short enough
  * - A suffix may be appended to the truncated string, e.g., an ellipsis
  */

package/types/string/template.d.cts

@@ -0,0 +1,50 @@
+// Generated by dts-bundle-generator v9.5.1
+
+/**
+Represents an object with `unknown` value. You probably want this instead of `{}`.
+
+Use case: You have an object whose keys and values are unknown to you.
+
+@example
+```
+import type {UnknownRecord} from 'type-fest';
+
+function toJson(object: UnknownRecord) {
+	return JSON.stringify(object);
+}
+
+toJson({hello: 'world'});
+//=> '{"hello":"world"}'
+
+function isObject(value: unknown): value is UnknownRecord {
+	return typeof value === 'object' && value !== null;
+}
+
+isObject({hello: 'world'});
+//=> true
+
+isObject('hello');
+//=> false
+```
+
+@category Type
+@category Object
+*/
+export type UnknownRecord = Record<PropertyKey, unknown>;
+export type PlainObject = UnknownRecord;
+export type Options = {
+	/**
+	 * Ignore case when searching for variables?
+	 */
+	ignoreCase?: boolean;
+	/**
+	 * Custom pattern for outputting variables
+	 */
+	pattern?: RegExp;
+};
+/**
+ * Render a string from a template with variables
+ */
+export declare function template(value: string, variables: PlainObject, options?: Partial<Options>): string;
+
+export {};

package/types/string/template.d.ts

@@ -1,4 +1,4 @@
-import type { PlainObject } from '../models';
+import type { PlainObject } from '~/models';
 type Options = {
     /**
      * Ignore case when searching for variables?
@@ -9,5 +9,8 @@ type Options = {
      */
     pattern?: RegExp;
 };
+/**
+ * Render a string from a template with variables
+ */
 export declare function template(value: string, variables: PlainObject, options?: Partial<Options>): string;
 export {};

package/types/value/clone.d.cts

@@ -0,0 +1,8 @@
+// Generated by dts-bundle-generator v9.5.1
+
+/**
+ * Clone any kind of value _(deeply, if needed)_
+ */
+export declare function clone(value: unknown): {} | null | undefined;
+
+export {};

package/types/value/clone.d.ts

@@ -1,2 +1,4 @@
-export declare function clone(fn: (...args: unknown[]) => unknown): null;
-export declare function clone<Value>(value: Value): Value;
+/**
+ * Clone any kind of value _(deeply, if needed)_
+ */
+export declare function clone(value: unknown): {} | null | undefined;

package/types/value/compare.d.cts

@@ -0,0 +1,8 @@
+// Generated by dts-bundle-generator v9.5.1
+
+/**
+ * Compare two values _(for sorting purposes)_
+ */
+export declare function compare(first: unknown, second: unknown): number;
+
+export {};

package/types/value/diff.d.cts

@@ -0,0 +1,25 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export type DiffType = "full" | "none" | "partial";
+export type DiffResult<First, Second = First> = {
+	original: DiffValue<First, Second>;
+	type: DiffType;
+	values: Record<string, DiffValue>;
+};
+export type DiffValue<First = unknown, Second = First> = {
+	from: First;
+	to: Second;
+};
+/**
+ * - Find the differences between two values
+ * - Returns an object holding the result:
+ * 	- `original` holds the original values
+ * 	- `type` is the type of difference:
+ * 		- `full` if the values are completely different
+ * 		- `none` if the values are the same
+ * 		- `partial` if the values are partially different
+ * 	- `values` holds the differences with dot notation keys
+ */
+export declare function diff<First, Second = First>(first: First, second: Second): DiffResult<First, Second>;
+
+export {};

package/types/value/equal.d.cts

@@ -0,0 +1,12 @@
+// Generated by dts-bundle-generator v9.5.1
+
+/**
+ * Are two strings equal? _(Case-sensitive by default)_
+ */
+export declare function equal(first: string, second: string, ignoreCase?: boolean): boolean;
+/**
+ * Are two values equal? _(Does a deep comparison, if needed)_
+ */
+export declare function equal(first: unknown, second: unknown): boolean;
+
+export {};