@oscarpalmer/atoms 0.74.1 → 0.76.0

package/types/value/get.d.ts

@@ -1,5 +1,5 @@
 import type { ToString } from 'type-fest/source/internal/string';
-import type { Get, Paths, PlainObject } from '../models';
+import type { Get, Paths, PlainObject } from '~/models';
 /**
  * - Get the value from an object using a known path
  * - You can retrieve a nested value by using dot notation, e.g., `foo.bar.baz`

package/types/value/index.d.cts

@@ -1396,8 +1396,10 @@ export type Get<
 > = GetWithPath<BaseType, Path extends string ? ToPath<Path> : Path, Options>;
 export type ArrayOrPlainObject = UnknownArray | UnknownRecord;
 export type PlainObject = UnknownRecord;
-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;
 /**
  * Compare two values _(for sorting purposes)_
  */
@@ -1466,7 +1468,7 @@ export type MergeOptions = {
 	skipNullable?: boolean;
 };
 /**
- * Merges multiple arrays or objects into a single one
+ * Merge multiple arrays or objects into a single one
  */
 export declare function merge<Model extends ArrayOrPlainObject>(
 	values: Model[],
@@ -1499,7 +1501,7 @@ export type Smushed<Value> = Simplify<{
 	[Key in Paths<Value>]: Get<Value, ToString<Key>>;
 }>;
 /**
- * Smushes an object into a flat object with dot notation keys
+ * Smush an object into a flat object that uses dot notation keys
  */
 export declare function smush<Value extends PlainObject>(
 	value: Value,
@@ -1513,13 +1515,13 @@ export type Unsmushed<Value extends PlainObject> = Simplify<
 	>
 >;
 /**
- * Unsmushes a smushed object _(turning dot notation keys into nested keys)_
+ * Unsmush a smushed object _(turning dot notation keys into nested keys)_
  */
 export declare function unsmush<Value extends PlainObject>(
 	value: Value,
 ): Unsmushed<Value>;
 /**
- * Creates a new object with only the specified keys
+ * Create a new object with only the specified keys
  */
 export declare function partial<
 	Value extends PlainObject,

package/types/value/index.d.ts

@@ -1,6 +1,6 @@
-import type { PlainObject } from '../models';
+import type { PlainObject } from '~/models';
 /**
- * Creates a new object with only the specified keys
+ * Create a new object with only the specified keys
  */
 export declare function partial<Value extends PlainObject, Key extends keyof Value>(value: Value, keys: Key[]): Pick<Value, Key>;
 export * from './clone';

package/types/value/merge.d.cts

@@ -0,0 +1,72 @@
+// 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>;
+/**
+Represents an array with `unknown` value.
+
+Use case: You want a type that all arrays can be assigned to, but you don't care about the value.
+
+@example
+```
+import type {UnknownArray} from 'type-fest';
+
+type IsArray<T> = T extends UnknownArray ? true : false;
+
+type A = IsArray<['foo']>;
+//=> true
+
+type B = IsArray<readonly number[]>;
+//=> true
+
+type C = IsArray<string>;
+//=> false
+```
+
+@category Type
+@category Array
+*/
+export type UnknownArray = readonly unknown[];
+export type ArrayOrPlainObject = UnknownArray | UnknownRecord;
+export type MergeOptions = {
+	/**
+	 * - Skip nullable values when merging arrays?
+	 * - E.g. `merge([1, 2, 3], [null, null, 99])` => `[1, 2, 99]`
+	 */
+	skipNullable?: boolean;
+};
+/**
+ * Merge multiple arrays or objects into a single one
+ */
+export declare function merge<Model extends ArrayOrPlainObject>(values: Model[], options?: Partial<MergeOptions>): Model;
+
+export {};

package/types/value/merge.d.ts

@@ -1,4 +1,4 @@
-import type { ArrayOrPlainObject } from '../models';
+import type { ArrayOrPlainObject } from '~/models';
 type MergeOptions = {
     /**
      * - Skip nullable values when merging arrays?
@@ -7,7 +7,7 @@ type MergeOptions = {
     skipNullable?: boolean;
 };
 /**
- * Merges multiple arrays or objects into a single one
+ * Merge multiple arrays or objects into a single one
  */
 export declare function merge<Model extends ArrayOrPlainObject>(values: Model[], options?: Partial<MergeOptions>): Model;
 export {};