Module: utilities/src
Classes
Interfaces
References
filterNullish
Renames and re-exports filterNullAndUndefined
filterNullishAndEmpty
Renames and re-exports filterNullAndUndefinedAndEmpty
filterNullishAndZero
Renames and re-exports filterNullAndUndefinedAndZero
filterNullishOrEmpty
Renames and re-exports filterNullAndUndefinedAndEmpty
filterNullishOrZero
Renames and re-exports filterNullAndUndefinedAndZero
isNullish
Renames and re-exports isNullOrUndefined
isNullishOrEmpty
Renames and re-exports isNullOrUndefinedOrEmpty
isNullishOrZero
Renames and re-exports isNullOrUndefinedOrZero
parseURL
Renames and re-exports tryParseURL
tryParse
Renames and re-exports tryParseJSON
Type Aliases
AbstractConstructor
Ƭ AbstractConstructor<T>: (...args: any[]) => T
Type parameters
| Name |
|---|
T |
Type declaration
• (...args)
Parameters
| Name | Type |
|---|---|
...args | any[] |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:64
AbstractCtor
Ƭ AbstractCtor<A, R>: (...args: A) => R
Type parameters
| Name | Type |
|---|---|
A | extends Arr = readonly any[] |
R | any |
Type declaration
• (...args)
Parameters
| Name | Type |
|---|---|
...args | A |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:54
AnyObject
Ƭ AnyObject<T>: { [K in keyof T]: T[K] }
Type parameters
| Name |
|---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:106
ArgumentTypes
Ƭ ArgumentTypes<F>: F extends (...args: infer A) => any ? A : never
Type parameters
| Name | Type |
|---|---|
F | extends (...args: any[]) => unknown |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:38
Arr
Ƭ Private Arr: readonly any[]
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:44
ArrayElementType
Ƭ ArrayElementType<T>: T extends infer K[] ? K : T extends readonly infer RK[] ? RK : T
Type parameters
| Name |
|---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:186
Awaitable
Ƭ Awaitable<T>: PromiseLike<T> | T
Type parameters
| Name |
|---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:79
Builtin
Ƭ Builtin: Primitive | Function | Date | Error | RegExp
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:4
Constructor
Ƭ Constructor<T>: (...args: any[]) => T
Type parameters
| Name |
|---|
T |
Type declaration
• (...args)
Parameters
| Name | Type |
|---|---|
...args | any[] |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:59
Ctor
Ƭ Ctor<A, R>: (...args: A) => R
Type parameters
| Name | Type |
|---|---|
A | extends Arr = readonly any[] |
R | any |
Type declaration
• (...args)
Parameters
| Name | Type |
|---|---|
...args | A |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:49
DeepPartial
Ƭ DeepPartial<T>: { [P in keyof T]?: T[P] extends (infer U)[] ? DeepPartial<U>[] : T[P] extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : DeepPartial<T[P]> }
Type parameters
| Name |
|---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:30
DeepRequired
Ƭ DeepRequired<T>: T extends Builtin ? NonNullable<T> : T extends Map<infer K, infer V> ? Map<DeepRequired<K>, DeepRequired<V>> : T extends ReadonlyMap<infer K, infer V> ? ReadonlyMap<DeepRequired<K>, DeepRequired<V>> : T extends WeakMap<infer K, infer V> ? WeakMap<DeepRequired<K>, DeepRequired<V>> : T extends Set<infer U> ? Set<DeepRequired<U>> : T extends ReadonlySet<infer U> ? ReadonlySet<DeepRequired<U>> : T extends WeakSet<infer U> ? WeakSet<DeepRequired<U>> : T extends Promise<infer U> ? Promise<DeepRequired<U>> : T extends {} ? { [K in keyof T]-?: DeepRequired<T[K]> } : NonNullable<T>
Type parameters
| Name |
|---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:6
FirstArgument
Ƭ FirstArgument<T>: T extends (arg1: infer U, ...args: unknown[]) => unknown ? U : unknown
Type parameters
| Name |
|---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:69
Mutable
Ƭ Mutable<T>: { -readonly [P in keyof T]: T[P] extends unknown[] | NonNullObject ? Mutable<T[P]> : T[P] }
Type parameters
| Name |
|---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:149
NonNullObject
Ƭ NonNullObject: {} & object
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:98
NonNullableProperties
Ƭ NonNullableProperties<T>: { [P in keyof T]: NonNullable<T[P]> }
Type parameters
| Name | Type |
|---|---|
T | unknown |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:90
Nullish
Ƭ Nullish: null | undefined
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:84
PartialRequired
Ƭ PartialRequired<T, K>: Partial<Omit<T, K>> & Required<Pick<T, K>>
Type parameters
| Name | Type |
|---|---|
T | T |
K | extends keyof T |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:28
PickByValue
Ƭ PickByValue<T, V>: { [P in keyof T]: T[P] extends V ? P : never }[keyof T] & keyof T
Type parameters
| Name |
|---|
T |
V |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:127
Primitive
Ƭ Primitive: string | number | boolean | bigint | symbol | undefined | null
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:1
RequiredExcept
Ƭ RequiredExcept<T, K>: Partial<Pick<T, K>> & Required<Omit<T, K>>
Type parameters
| Name | Type |
|---|---|
T | T |
K | extends keyof T |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:26
SecondArgument
Ƭ SecondArgument<T>: T extends (arg1: unknown, arg2: infer U, ...args: unknown[]) => unknown ? U : unknown
Type parameters
| Name |
|---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:74
StrictRequired
Ƭ StrictRequired<T>: { [P in keyof T]-?: NonNullable<T[P]> }
Type parameters
| Name |
|---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/types.ts:172
ThrottleFn
Ƭ ThrottleFn<T>: T & { flush: () => void }
Type parameters
| Name | Type |
|---|---|
T | extends (...args: any[]) => any |
Defined in
projects/utilities/packages/utilities/src/lib/throttle.ts:1
Functions
arrayStrictEquals
▸ arrayStrictEquals<T>(arr1, arr2): boolean
Type parameters
| Name | Type |
|---|---|
T | extends readonly unknown[] |
Parameters
| Name | Type | Description |
|---|---|---|
arr1 | T | |
arr2 | T |
Returns
boolean
Defined in
projects/utilities/packages/utilities/src/lib/arrayStrictEquals.ts:6
cast
▸ cast<T>(value): T
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
value | unknown |
Returns
T
Defined in
projects/utilities/packages/utilities/src/lib/cast.ts:10
chunk
▸ chunk<T>(array, chunkSize): T[][]
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
array | readonly T[] | |
chunkSize | number |
Returns
T[][]
Defined in
projects/utilities/packages/utilities/src/lib/chunk.ts:6
classExtends
▸ classExtends<T>(value, base): value is T
Type parameters
| Name | Type |
|---|---|
T | extends Ctor<readonly any[], any> |
Parameters
| Name | Type | Description |
|---|---|---|
value | Ctor<readonly any[], any> | |
base | T |
Returns
value is T
Defined in
projects/utilities/packages/utilities/src/lib/classExtends.ts:8
codeBlock
▸ codeBlock<C>(content): ````
${C}
````
Type parameters
| Name | Type |
|---|---|
C | extends string |
Parameters
| Name | Type | Description |
|---|---|---|
content | C |
Returns
```` ${C} ````
Defined in
projects/utilities/packages/utilities/src/lib/codeBlock.ts:14
▸ codeBlock<L, C>(language, content): ````${L}
${C}
````
Type parameters
| Name | Type |
|---|---|
L | extends string |
C | extends string |
Parameters
| Name | Type | Description |
|---|---|---|
language | L | |
content | C |
Returns
````${L} ${C} ````
Defined in
projects/utilities/packages/utilities/src/lib/codeBlock.ts:28
cutText
▸ cutText(str, length): string
Parameters
| Name | Type | Description |
|---|---|---|
str | string | |
length | number |
Returns
string
Defined in
projects/utilities/packages/utilities/src/lib/cutText.ts:10
debounce
▸ debounce<FnArgumentsType, FnReturnType>(func, options?): DebouncedFunc<FnArgumentsType, FnReturnType>
Type parameters
| Name | Type |
|---|---|
FnArgumentsType | extends any[] |
FnReturnType | FnReturnType |
Parameters
| Name | Type | Description |
|---|---|---|
func | (...args: FnArgumentsType) => FnReturnType | |
options | DebounceSettings |
Returns
DebouncedFunc<FnArgumentsType, FnReturnType>
Defined in
projects/utilities/packages/utilities/src/lib/debounce/debounce.ts:68
deepClone
▸ deepClone<T>(source): T
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
source | T |
Returns
T
Defined in
projects/utilities/packages/utilities/src/lib/deepClone.ts:7
filterNullAndUndefined
▸ filterNullAndUndefined<TValue>(value): value is TValue
Type parameters
| Name |
|---|
TValue |
Parameters
| Name | Type | Description |
|---|---|---|
value | Nullish | TValue |
Returns
value is TValue
Defined in
projects/utilities/packages/utilities/src/lib/filterNullAndUndefined.ts:19
filterNullAndUndefinedAndEmpty
▸ filterNullAndUndefinedAndEmpty<TValue>(value): value is TValue
Type parameters
| Name |
|---|
TValue |
Parameters
| Name | Type | Description |
|---|---|---|
value | "" | Nullish | TValue |
Returns
value is TValue
Defined in
projects/utilities/packages/utilities/src/lib/filterNullAndUndefinedAndEmpty.ts:19
filterNullAndUndefinedAndZero
▸ filterNullAndUndefinedAndZero<TValue>(value): value is TValue
Type parameters
| Name |
|---|
TValue |
Parameters
| Name | Type | Description |
|---|---|---|
value | 0 | Nullish | TValue |
Returns
value is TValue
Defined in
projects/utilities/packages/utilities/src/lib/filterNullAndUndefinedAndZero.ts:19
getDeepObjectKeys
▸ getDeepObjectKeys<T>(obj, options?): string[]
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
obj | AnyObject<T> | |
options? | GetDeepObjectKeysOptions |
Returns
string[]
Defined in
projects/utilities/packages/utilities/src/lib/getDeepObjectKeys.ts:15
hasAtLeastOneKeyInMap
▸ hasAtLeastOneKeyInMap<T>(map, keys): boolean
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
map | ReadonlyMap<T, any> | |
keys | readonly T[] |
Returns
boolean
Defined in
projects/utilities/packages/utilities/src/lib/hasAtLeastOneKeyInMap.ts:7
inlineCodeBlock
▸ inlineCodeBlock<C>(content): ``${C}``
Type parameters
| Name | Type |
|---|---|
C | extends string |
Parameters
| Name | Type | Description |
|---|---|---|
content | C |
Returns
``${C}``
Defined in
projects/utilities/packages/utilities/src/lib/inlineCodeBlock.ts:7
isClass
▸ isClass(input): input is Ctor<readonly any[], any>
Parameters
| Name | Type | Description |
|---|---|---|
input | unknown |
Returns
input is Ctor<readonly any[], any>
Defined in
projects/utilities/packages/utilities/src/lib/isClass.ts:7
isFunction
▸ isFunction(input): input is Function
Parameters
| Name | Type | Description |
|---|---|---|
input | unknown |
Returns
input is Function
Defined in
projects/utilities/packages/utilities/src/lib/isFunction.ts:6
isNullOrUndefined
▸ isNullOrUndefined(value): value is Nullish
Parameters
| Name | Type | Description |
|---|---|---|
value | unknown |
Returns
value is Nullish
Defined in
projects/utilities/packages/utilities/src/lib/isNullOrUndefined.ts:7
isNullOrUndefinedOrEmpty
▸ isNullOrUndefinedOrEmpty(value): value is "" | Nullish
Parameters
| Name | Type | Description |
|---|---|---|
value | unknown |
Returns
value is "" | Nullish
Defined in
projects/utilities/packages/utilities/src/lib/isNullOrUndefinedOrEmpty.ts:8
isNullOrUndefinedOrZero
▸ isNullOrUndefinedOrZero(value): value is 0 | Nullish
Parameters
| Name | Type | Description |
|---|---|---|
value | unknown |
Returns
value is 0 | Nullish
Defined in
projects/utilities/packages/utilities/src/lib/isNullOrUndefinedOrZero.ts:8
isNumber
▸ isNumber(input): input is number
Parameters
| Name | Type | Description |
|---|---|---|
input | unknown |
Returns
input is number
Defined in
projects/utilities/packages/utilities/src/lib/isNumber.ts:5
isObject
▸ isObject(input, constructorType?): input is object
Parameters
| Name | Type | Description |
|---|---|---|
input | unknown | |
constructorType? | ObjectConstructor |
Returns
input is object
Defined in
projects/utilities/packages/utilities/src/lib/isObject.ts:8
▸ isObject<T>(input, constructorType): input is InstanceType<T>
Type parameters
| Name | Type |
|---|---|
T | extends Constructor<unknown> |
Parameters
| Name | Type |
|---|---|
input | unknown |
constructorType | T |
Returns
input is InstanceType<T>
Defined in
projects/utilities/packages/utilities/src/lib/isObject.ts:9
isPrimitive
▸ isPrimitive(input): input is string | number | bigint | boolean
Parameters
| Name | Type | Description |
|---|---|---|
input | unknown |
Returns
input is string | number | bigint | boolean
Defined in
projects/utilities/packages/utilities/src/lib/isPrimitive.ts:7
isThenable
▸ isThenable(input): input is Thenable
Parameters
| Name | Type | Description |
|---|---|---|
input | unknown |
Returns
input is Thenable
Defined in
projects/utilities/packages/utilities/src/lib/isThenable.ts:21
lazy
▸ lazy<T>(cb): () => T
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
cb | () => T |
Returns
fn
▸ (): T
Returns
T
Defined in
projects/utilities/packages/utilities/src/lib/lazy.ts:6
makeObject
▸ makeObject(path, value, obj?): Record<string, unknown>
Parameters
| Name | Type | Description |
|---|---|---|
path | string | |
value | unknown | |
obj | Record<string, unknown> |
Returns
Record<string, unknown>
Defined in
projects/utilities/packages/utilities/src/lib/makeObject.ts:7
mergeDefault
▸ mergeDefault<A, B>(base, overwrites?): DeepRequired<A & B>
Type parameters
| Name | Type |
|---|---|
A | extends object |
B | extends Partial<A> |
Parameters
| Name | Type | Description |
|---|---|---|
base | A | |
overwrites? | B |
Returns
DeepRequired<A & B>
Defined in
projects/utilities/packages/utilities/src/lib/mergeDefault.ts:43
mergeObjects
▸ mergeObjects<A, B>(objTarget, objSource): A & B
Type parameters
| Name | Type |
|---|---|
A | extends object |
B | extends object |
Parameters
| Name | Type | Description |
|---|---|---|
objTarget | A | |
objSource | Readonly<B> |
Returns
A & B
Defined in
projects/utilities/packages/utilities/src/lib/mergeObjects.ts:8
noop
▸ noop(): void
Returns
void
Defined in
projects/utilities/packages/utilities/src/lib/noop.ts:2
objectEntries
▸ objectEntries<T>(obj): T extends ArrayLike<any> ? [`${number}`, T[number]][] : [keyof T, T[keyof T]][]
Type parameters
| Name | Type |
|---|---|
T | extends object |
Parameters
| Name | Type |
|---|---|
obj | T |
Returns
T extends ArrayLike<any> ? [`${number}`, T[number]][] : [keyof T, T[keyof T]][]
Defined in
projects/utilities/packages/utilities/src/lib/objectEntries.ts:3
objectKeys
▸ objectKeys<T>(obj): T extends ArrayLike<any> ? `${number}`[] : keyof T[]
Type parameters
| Name | Type |
|---|---|
T | extends object |
Parameters
| Name | Type |
|---|---|
obj | T |
Returns
T extends ArrayLike<any> ? `${number}`[] : keyof T[]
Defined in
projects/utilities/packages/utilities/src/lib/objectKeys.ts:3
objectToTuples
▸ objectToTuples<T>(obj, prefix?): [keyof T, T[keyof T]][]
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
obj | AnyObject<T> | undefined | |
prefix | string | '' |
Returns
[keyof T, T[keyof T]][]
Defined in
projects/utilities/packages/utilities/src/lib/objectToTuples.ts:9
objectValues
▸ objectValues<T>(obj): T extends ArrayLike<any> ? T[number][] : T[keyof T][]
Type parameters
| Name | Type |
|---|---|
T | extends object |
Parameters
| Name | Type |
|---|---|
obj | T |
Returns
T extends ArrayLike<any> ? T[number][] : T[keyof T][]
Defined in
projects/utilities/packages/utilities/src/lib/objectValues.ts:3
partition
▸ partition<T>(array, predicate): T[][]
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
array | T[] | |
predicate | (value: T, index: number) => boolean |
Returns
T[][]
Defined in
projects/utilities/packages/utilities/src/lib/partition.ts:12
pickRandom
▸ pickRandom<T>(array, amount?): T
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
array | readonly T[] | |
amount? | 1 |
Returns
T
Defined in
projects/utilities/packages/utilities/src/lib/pickRandom.ts:6
▸ pickRandom<T>(array, amount): T[]
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
array | readonly T[] |
amount | number |
Returns
T[]
Defined in
projects/utilities/packages/utilities/src/lib/pickRandom.ts:7
range
▸ range(min, max, step): number[]
Parameters
| Name | Type | Description |
|---|---|---|
min | number | |
max | number | |
step | number |
Returns
number[]
Defined in
projects/utilities/packages/utilities/src/lib/range.ts:7
regExpEsc
▸ regExpEsc(str): string
Parameters
| Name | Type | Description |
|---|---|---|
str | string |
Returns
string
Defined in
projects/utilities/packages/utilities/src/lib/regExpEsc.ts:7
roundNumber
▸ roundNumber(num, scale?): number
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
num | string | number | undefined | |
scale | number | 0 |
Returns
number
Defined in
projects/utilities/packages/utilities/src/lib/roundNumber.ts:7
sleep
▸ sleep<T>(ms, value?, options?): Promise<T>
Type parameters
| Name | Type |
|---|---|
T | undefined |
Parameters
| Name | Type | Description |
|---|---|---|
ms | number | |
value? | T | |
options? | SleepOptions | - |
Returns
Promise<T>
Defined in
projects/utilities/packages/utilities/src/lib/sleep.ts:35
sleepSync
▸ sleepSync<T>(ms, value?): T
Type parameters
| Name | Type |
|---|---|
T | undefined |
Parameters
| Name | Type | Description |
|---|---|---|
ms | number | |
value? | T |
Returns
T
Defined in
projects/utilities/packages/utilities/src/lib/sleep.ts:64
splitText
▸ splitText(str, length, char?): string
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
str | string | undefined | |
length | number | undefined | |
char | string | ' ' |
Returns
string
Defined in
projects/utilities/packages/utilities/src/lib/splitText.ts:9
throttle
▸ throttle<T>(func, wait): ThrottleFn<T>
Type parameters
| Name | Type |
|---|---|
T | extends (...args: any[]) => any |
Parameters
| Name | Type | Description |
|---|---|---|
func | T | |
wait | number |
Returns
ThrottleFn<T>
Defined in
projects/utilities/packages/utilities/src/lib/throttle.ts:13
toTitleCase
▸ toTitleCase(str, options?): string
Parameters
| Name | Type | Description |
|---|---|---|
str | string | |
options | ToTitleCaseOptions |
Returns
string
Defined in
projects/utilities/packages/utilities/src/lib/toTitleCase.ts:35
tryParseJSON
▸ tryParseJSON(value): object | string | number
Parameters
| Name | Type | Description |
|---|---|---|
value | string |
Returns
object | string | number
Defined in
projects/utilities/packages/utilities/src/lib/tryParseJSON.ts:5
tryParseURL
▸ tryParseURL(value): URL | null
Parameters
| Name | Type | Description |
|---|---|---|
value | string |
Returns
URL | null
Defined in
projects/utilities/packages/utilities/src/lib/tryParseURL.ts:6