objects | @ariesclark/utils

Index

Type aliases

Functions

Type aliases

Cast

Cast<X, Y>: X extends Y ? X : Y

Type parameters

Entries

Entries<T>: { [ K in Keys<T>]: [K, T[K]] }[Keys<T>][]

Array<[key, value]>

Type parameters

FilterPredicate

FilterPredicate<T>: (key: Keys<T>, value: T[typeof key], object: T) => boolean

Type parameters

Type declaration

- (key: Keys<T>, value: T[typeof key], object: T): boolean
- Parameters
  - key: Keys<T>
  - value: T[typeof key]
  - object: T
  Returns boolean

Flatten

Flatten<T, Z>: T extends object ? Expand<UnionToIntersection<{ [ P in keyof T]: P extends string | number ? T[P] extends object ? Flatten<T[P], `${Z}${P}.`> : { [ Q in `${Z}${P}`]: T[P] } : never }[keyof T & (T extends readonly unknown[] ? number : unknown)]>> : T

Type parameters

T
Z: string = ""

FromEntries

FromEntries<T>: T extends [infer Key, any][] ? { [ K in Cast<Key, PropertyKey>]: Extract<T[number], [K, any]>[1] } : never

Type parameters

Keys

Keys<T>: keyof T

Type parameters

KeysAssignableToType

KeysAssignableToType<T, V>: { [ K in Keys<T>]-?: T[K] extends V ? K : never }[Keys<T>]

Type parameters

MapCallback

MapCallback<T>: (key: Keys<T>, value: T[typeof key], object: T) => [key: PropertyKey, value: any]

Type parameters

Type declaration

- (key: Keys<T>, value: T[typeof key], object: T): [key: PropertyKey, value: any]
- Parameters
  - key: Keys<T>
  - value: T[typeof key]
  - object: T
  Returns [key: PropertyKey, value: any]

Merge

Merge<A, B>: { [ K in Keys<A> | Keys<B>]: A[K & Keys<A>] | B[K & Keys<B>] }

Type parameters

OmitByType

OmitByType<T, V>: Omit<T, KeysAssignableToType<T, V>>

Type parameters

Unflatten

Unflatten<T>: Expand<UnionToIntersection<UnflattenDirect<T> | UnflattenIndirect<T, PrefixKeyof<T>>>>

Type parameters

T: {}

Functions

create

create<T>(object?: Readonly<T>): T

- Defined in objects.ts:84
Create an object without a prototype.

Type parameters
- T
Parameters
- Optional object: Readonly<T>
  
  The original object.
Returns T

entries

entries<T>(object: T): Entries<T>

- Defined in objects.ts:68
Returns an array of key/values of the enumerable properties of an object.

Type parameters
- T
Parameters
- object: T
  
  The original object.
Returns Entries<T>

filter

filter<T, R>(object: Readonly<T>, predicate: FilterPredicate<T>): R

- Defined in objects.ts:96
Remove keys from an object based on a function predicate without mutating the original.

Type parameters
- T
- R
Parameters
- object: Readonly<T>
  
  The original object.
- predicate: FilterPredicate<T>
  
  A predicate function to determine which keys to retain. The filter method calls the predicate function one time for each element in the array.
Returns R

flatten

flatten<T>(object: T): Flatten<T>

- Defined in objects.ts:142
Turn an object into a single depth object.

Type parameters
- T
Parameters
- object: T
  
  The original object.
Returns Flatten<T>

fromEntries

fromEntries<T>(entries: T): FromEntries<T>

- Defined in objects.ts:76
Returns an object created by key-value entries for properties and methods

Type parameters
- T
Parameters
- entries: T
  
  An iterable object that contains key-value entries for properties and methods.
Returns FromEntries<T>

keys

keys<T>(object: T): keyof T[]

- Defined in objects.ts:61
Returns the names of the enumerable string properties and methods of an object.

Type parameters
- T
Parameters
- object: T
  
  The original object.
Returns keyof T[]

map

map<T, R>(object: Readonly<T>, callback: MapCallback<T>): R

- Defined in objects.ts:106
Transform an object without mutating the original.

Type parameters
- T
- R
Parameters
- object: Readonly<T>
  
  The original object.
- callback: MapCallback<T>
  
  The map method calls the callback function one time for each element in the array.
Returns R

omit

omit<T, K>(object: Readonly<T>, keys: K): Omit<T, K[number]>

- Defined in objects.ts:131
Remove keys from an object. This function creates a new object without the specified keys. The original object is not mutated.

Type parameters
- T
- K: keyof T[]
Parameters
- object: Readonly<T>
  
  The original object.
- keys: K
  
  An array of keys to remove.
Returns Omit<T, K[number]>

pick

pick<T, K>(object: Readonly<T>, keys: K): Pick<T, K[number]>

- Defined in objects.ts:117
Pick keys from an object. This function creates a new object with the specified keys. The original object is not mutated.

Type parameters
- T
- K: keyof T[]
Parameters
- object: Readonly<T>
  
  The original object.
- keys: K
  
  An array of keys to keep.
Returns Pick<T, K[number]>

unflatten

unflatten<T>(object: T): Unflatten<T>

- Defined in objects.ts:167
Revert a flattened object to a nested object.

todo
This currently doesn't deal with arrays.

Type parameters
- T: {}
Parameters
- object: T
  
  The flattened object.
Returns Unflatten<T>

Index

Type aliases

Functions

Type aliases

Cast

Type parameters

X

Y

Entries

Type parameters

T

FilterPredicate

Type parameters

T

Type declaration

Parameters

key: Keys<T>

value: T[typeof key]

object: T

Returns boolean

Flatten

Type parameters

T

Z: string = ""

FromEntries

Type parameters

T

Keys

Type parameters

T

KeysAssignableToType

Type parameters

T

V

MapCallback

Type parameters

T

Type declaration

Parameters

key: Keys<T>

value: T[typeof key]

object: T

Returns [key: PropertyKey, value: any]

Merge

Type parameters

A

B

OmitByType

Type parameters

T

V

Unflatten

Type parameters

T: {}

Functions

create

Type parameters

T

Parameters

Optional object: Readonly<T>

Returns T

entries

Type parameters

T

Parameters

object: T

Returns Entries<T>

filter

Type parameters

T

R

Parameters

object: Readonly<T>

predicate: FilterPredicate<T>

Returns R

flatten

Type parameters

T

Parameters

object: T