Module: utilities/src
Interfaces
References
filterNullAndUndefined
Renames and re-exports filterNullish
filterNullAndUndefinedAndEmpty
Renames and re-exports filterNullishOrEmpty
filterNullAndUndefinedAndZero
Renames and re-exports filterNullishOrZero
isNullOrUndefined
Renames and re-exports isNullish
isNullOrUndefinedOrEmpty
Renames and re-exports isNullishOrEmpty
isNullOrUndefinedOrZero
Renames and re-exports isNullishOrZero
Type aliases
AbstractConstructor
Ƭ AbstractConstructor<T
>: (...args
: any
[]) => T
Type parameters
Name |
---|
T |
Type declaration
• (...args
)
A generic abstract constructor without parameters
Parameters
Name | Type |
---|---|
...args | any [] |
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:64
AbstractCtor
Ƭ AbstractCtor<A
, R
>: (...args
: A
) => R
Type parameters
Name | Type |
---|---|
A | extends Arr = readonly any [] |
R | any |
Type declaration
• (...args
)
A generic abstract constructor with parameters
Parameters
Name | Type |
---|---|
...args | A |
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:54
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/utilityTypes.ts:38
Arr
Ƭ Private
Arr: readonly any
[]
A readonly array of any values.
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:44
ArrayElementType
Ƭ ArrayElementType<T
>: T
extends infer K[] ? K
: T
extends readonly infer RK[] ? RK
: T
Gets a union type of all the keys that are in an array.
example
const sample = [1, 2, '3', true];
type arrayUnion = ArrayElementType<typeof sample>;
// Expected: string | number | boolean
Type parameters
Name |
---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:176
Awaitable
Ƭ Awaitable<T
>: PromiseLike
<T
> | T
ReturnType for a function that can return either a value or a Promise
with that value
Type parameters
Name |
---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:79
Builtin
Ƭ Builtin: Primitive
| Function
| Date
| Error
| RegExp
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:4
Constructor
Ƭ Constructor<T
>: (...args
: any
[]) => T
Type parameters
Name |
---|
T |
Type declaration
• (...args
)
A generic constructor without parameters
Parameters
Name | Type |
---|---|
...args | any [] |
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:59
Ctor
Ƭ Ctor<A
, R
>: (...args
: A
) => R
Type parameters
Name | Type |
---|---|
A | extends Arr = readonly any [] |
R | any |
Type declaration
• (...args
)
A generic constructor with parameters
Parameters
Name | Type |
---|---|
...args | A |
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.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/utilityTypes.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/utilityTypes.ts:6
FirstArgument
Ƭ FirstArgument<T
>: T
extends (arg1
: infer U, ...args
: unknown
[]) => unknown
? U
: unknown
Gets the first argument of any given function
Type parameters
Name |
---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:69
Mutable
Ƭ Mutable<T
>: { -readonly [P in keyof T]: T[P] extends unknown[] | NonNullObject ? Mutable<T[P]> : T[P] }
Transforms a readonly
type to be mutable
example
interface Sample {
id: string;
hobbies: readonly string[];
}
type BB = Mutable<Sample>;
// Expected:
// {
// id: string;
// hobbies: string[];
// }
Type parameters
Name |
---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:139
NonNullObject
Ƭ NonNullObject: {} & object
An object that is non nullable, to bypass TypeScript not easily working with {@link Record}<{@link PropertyKey}, unknown> in various instances.
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:98
NonNullableProperties
Ƭ NonNullableProperties<T
>: { [P in keyof T]: NonNullable<T[P]> }
Similar to the built in {@link NonNullable}, but properly removes null
from all keys in the class or interface
This does not recurse deeply, for that use DeepRequired
Type parameters
Name | Type |
---|---|
T | unknown |
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:90
Nullish
Ƭ Nullish: null
| undefined
Type union for the full 2 billion dollar mistake in the JavaScript ecosystem
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.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/utilityTypes.ts:28
PickByValue
Ƭ PickByValue<T
, V
>: { [P in keyof T]: T[P] extends V ? P : never }[keyof T
] & keyof T
Gets all the keys (as a string union) from a type T
that match value V
example
interface Sample {
id: string;
name: string | null;
middleName?: string;
lastName: string;
hobbies: readonly string[];
}
type BB = PickByValue<Sample, string>;
// Expected:
// "id" | "lastName"
Type parameters
Name |
---|
T |
V |
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:117
Primitive
Ƭ Primitive: string
| number
| boolean
| bigint
| symbol
| undefined
| null
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.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/utilityTypes.ts:26
SecondArgument
Ƭ SecondArgument<T
>: T
extends (arg1
: unknown
, arg2
: infer U, ...args
: unknown
[]) => unknown
? U
: unknown
Gets the second argument of any given function
Type parameters
Name |
---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:74
StrictRequired
Ƭ StrictRequired<T
>: { [P in keyof T]-?: NonNullable<T[P]> }
Transforms every key in an object to be strictly required, essentially removing undefined
and null
from the type.
example
interface Sample {
id: string;
name: string | null;
middleName?: string;
}
type BB = StrictRequired<Sample>;
// Expected:
// {
// id: string;
// name: string;
// middleName: string;
// }
Type parameters
Name |
---|
T |
Defined in
projects/utilities/packages/utilities/src/lib/utilityTypes.ts:162
Functions
arrayStrictEquals
▸ arrayStrictEquals<T
>(arr1
, arr2
): boolean
Compare if both arrays are strictly equal
Type parameters
Name | Type |
---|---|
T | extends readonly unknown [] |
Parameters
Name | Type | Description |
---|---|---|
arr1 | T | The array to compare to |
arr2 | T | The array to compare with |
Returns
boolean
Defined in
projects/utilities/packages/utilities/src/lib/arrayStrictEquals.ts:6
cast
▸ cast<T
>(value
): T
Casts any value to T
Note that this function is not type-safe, and may cause runtime errors if used incorrectly. Also note that this function is effectively useless in a JavaScript project, it only serves a purpose for TypeScript projects.
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
value | unknown | The value to cast to another type |
Returns
T
The value but as type T
Defined in
projects/utilities/packages/utilities/src/lib/cast.ts:10
chunk
▸ chunk<T
>(array
, chunkSize
): T
[][]
Splits up an array into chunks
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
array | readonly T [] | The array to chunk up |
chunkSize | number | The size of each individual chunk |
Returns
T
[][]
Defined in
projects/utilities/packages/utilities/src/lib/chunk.ts:6
classExtends
▸ classExtends<T
>(value
, base
): value is T
Checks whether or not the value class extends the base class.
Type parameters
Name | Type |
---|---|
T | extends Ctor <readonly any [], any > |
Parameters
Name | Type | Description |
---|---|---|
value | Ctor <readonly any [], any > | The constructor to be checked against. |
base | T | The base constructor. |
Returns
value is T
Defined in
projects/utilities/packages/utilities/src/lib/classExtends.ts:8
codeBlock
▸ codeBlock<T
>(language
, expression
): string
Wraps text in a markdown codeblock with optionally a language indicator for syntax highlighting
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
language | string | The codeblock language |
expression | T | The expression to be wrapped in the codeblock |
Returns
string
Defined in
projects/utilities/packages/utilities/src/lib/codeBlock.ts:8
cutText
▸ cutText(str
, length
): string
Split a text by its latest space character in a range from the character 0 to the selected one.
copyright
2019 Antonio Román
license
Apache-2.0
Parameters
Name | Type | Description |
---|---|---|
str | string | The text to split. |
length | number | The length of the desired string. |
Returns
string
Defined in
projects/utilities/packages/utilities/src/lib/cutText.ts:10
debounce
▸ debounce<FnArgumentsType
, FnReturnType
>(func
, options?
): DebouncedFunc
<FnArgumentsType
, FnReturnType
>
Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked. The debounced function comes with a cancel method to cancel delayed invocations and a flush method to immediately invoke them. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the debounced function return the result of the last func invocation.
Note: If leading and trailing options are true, func is invoked on the trailing edge of the timeout only if the the debounced function is invoked more than once during the wait timeout.
See David Corbacho’s article for details over the differences between .debounce and .throttle.
Type parameters
Name | Type |
---|---|
FnArgumentsType | extends any [] |
FnReturnType | FnReturnType |
Parameters
Name | Type | Description |
---|---|---|
func | (...args : FnArgumentsType ) => FnReturnType | The function to debounce. |
options | DebounceSettings | The options object. |
Returns
DebouncedFunc
<FnArgumentsType
, FnReturnType
>
Returns the new debounced function.
Defined in
projects/utilities/packages/utilities/src/lib/debounce/index.ts:68
deepClone
▸ deepClone<T
>(source
): T
Deep clone an object
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
source | T | The object to clone |
Returns
T
Defined in
projects/utilities/packages/utilities/src/lib/deepClone.ts:7
filterNullish
▸ filterNullish<TValue
>(value
): value is TValue
Checks whether a value is not null
nor undefined
.
This can be used in {@link Array.filter} to remove null
and undefined
from the array type
example
// TypeScript Type: (string | undefined | null)[]
const someArray = ['one', 'two', undefined, null, 'five'];
// TypeScript Type: string[]
const filteredArray = someArray.filter(filterNullAndUndefined);
// Result: ['one', 'two', 'five']
Type parameters
Name |
---|
TValue |
Parameters
Name | Type | Description |
---|---|---|
value | TValue | Nullish | The value to verify that is neither null nor undefined |
Returns
value is TValue
A boolean that is true
if the value is neither null
nor undefined
, false otherwise.
Defined in
projects/utilities/packages/utilities/src/lib/filterNullAndUndefined.ts:19
filterNullishOrEmpty
▸ filterNullishOrEmpty<TValue
>(value
): value is TValue
Checks whether a value is not null
nor undefined
nor ''
(empty string).
This can be used in {@link Array.filter} to remove null
, undefined
from the array type
example
// TypeScript Type: (string | undefined | null)[]
const someArray = ['one', 'two', undefined, null, ''];
// TypeScript Type: string[]
const filteredArray = someArray.filter(filterNullAndUndefinedAndEmpty);
// Result: ['one', 'two']
Type parameters
Name |
---|
TValue |
Parameters
Name | Type | Description |
---|---|---|
value | "" | Nullish | TValue | The value to verify that is neither null , undefined nor '' (empty string) |
Returns
value is TValue
A boolean that is true
if the value is neither null
, undefined
nor ''
(empty string), false otherwise.
Defined in
projects/utilities/packages/utilities/src/lib/filterNullAndUndefinedAndEmpty.ts:19
filterNullishOrZero
▸ filterNullishOrZero<TValue
>(value
): value is TValue
Checks whether a value is not null
nor undefined
nor 0
.
This can be used in {@link Array.filter} to remove null
, undefined
from the array type
example
// TypeScript Type: (string | number | undefined | null)[]
const someArray = ['one', 'two', undefined, null, 0, 1];
// TypeScript Type: (string | number)[]
const filteredArray = someArray.filter(filterNullAndUndefinedAndZero);
// Result: ['one', 'two', 1]
Type parameters
Name |
---|
TValue |
Parameters
Name | Type | Description |
---|---|---|
value | 0 | Nullish | TValue | The value to verify that is neither null , undefined nor 0 |
Returns
value is TValue
A boolean that is true
if the value is neither null
, undefined
nor 0
, false otherwise.
Defined in
projects/utilities/packages/utilities/src/lib/filterNullAndUndefinedAndZero.ts:19
hasAtLeastOneKeyInMap
▸ hasAtLeastOneKeyInMap<T
>(map
, keys
): boolean
Checks whether any of the keys are in the {@link map}
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
map | ReadonlyMap <T , any > | The map to check |
keys | readonly T [] | The keys to find in the map |
Returns
boolean
true
if at least one of the keys is in the {@link map}, false
otherwise.
Defined in
projects/utilities/packages/utilities/src/lib/hasAtLeastOneKeyInMap.ts:7
inlineCodeBlock
▸ inlineCodeBlock(input
): string
Wraps text in a markdown inline codeblock
Parameters
Name | Type |
---|---|
input | string |
Returns
string
Defined in
projects/utilities/packages/utilities/src/lib/inlineCodeBlock.ts:7
isClass
▸ isClass(input
): input is Ctor<readonly any[], any>
Verify if the input is a class constructor.
Parameters
Name | Type | Description |
---|---|---|
input | unknown | The function to verify |
Returns
input is Ctor<readonly any[], any>
Defined in
projects/utilities/packages/utilities/src/lib/isClass.ts:7
isFunction
▸ isFunction(input
): input is Function
Verify if the input is a function.
Parameters
Name | Type | Description |
---|---|---|
input | unknown | The function to verify |
Returns
input is Function
Defined in
projects/utilities/packages/utilities/src/lib/isFunction.ts:6
isNullish
▸ isNullish(value
): value is Nullish
Checks whether or not a value is null
or undefined
Parameters
Name | Type | Description |
---|---|---|
value | unknown | The value to check |
Returns
value is Nullish
Defined in
projects/utilities/packages/utilities/src/lib/isNullOrUndefined.ts:7
isNullishOrEmpty
▸ isNullishOrEmpty(value
): value is "" | Nullish
Checks whether or not a value is null
, undefined
or ''
, []
Parameters
Name | Type | Description |
---|---|---|
value | unknown | The value to check |
Returns
value is "" | Nullish
Defined in
projects/utilities/packages/utilities/src/lib/isNullOrUndefinedOrEmpty.ts:8
isNullishOrZero
▸ isNullishOrZero(value
): value is 0 | Nullish
Checks whether or not a value is null
, undefined
or 0
Parameters
Name | Type | Description |
---|---|---|
value | unknown | The value to check |
Returns
value is 0 | Nullish
Defined in
projects/utilities/packages/utilities/src/lib/isNullOrUndefinedOrZero.ts:8
isNumber
▸ isNumber(input
): input is number
Verify if a number is a finite number.
Parameters
Name | Type | Description |
---|---|---|
input | unknown | The number to verify |
Returns
input is number
Defined in
projects/utilities/packages/utilities/src/lib/isNumber.ts:5
isObject
▸ isObject(input
, constructorType?
): input is NonNullObject
Verify if the input is an object literal (or class).
Parameters
Name | Type | Description |
---|---|---|
input | unknown | The object to verify |
constructorType? | ObjectConstructor | The type of the constructor of the object. Use this if you want a class of your choosing to pass the check as well. |
Returns
input is NonNullObject
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
Check whether a value is a primitive
Parameters
Name | Type | Description |
---|---|---|
input | unknown | The input to check |
Returns
input is string | number | bigint | boolean
Defined in
projects/utilities/packages/utilities/src/lib/isPrimitive.ts:7
isThenable
▸ isThenable(input
): input is Thenable
Verify if an object is a promise.
Parameters
Name | Type | Description |
---|---|---|
input | unknown | The promise to verify |
Returns
input is Thenable
Defined in
projects/utilities/packages/utilities/src/lib/isThenable.ts:21
makeObject
▸ makeObject(path
, value
, obj?
): Record
<string
, unknown
>
Turn a dotted path into a json object.
Parameters
Name | Type | Description |
---|---|---|
path | string | The dotted path |
value | unknown | The value |
obj | Record <string , unknown > | The object to edit |
Returns
Record
<string
, unknown
>
Defined in
projects/utilities/packages/utilities/src/lib/makeObject.ts:7
mergeDefault
▸ mergeDefault<A
, B
>(base
, overwrites?
): DeepRequired
<A
& B
>
Deep merges 2 objects. Properties from the second parameter are applied to the first.
remark
overwrites
is also mutated!
remark
If the value of a key in overwrites
is undefined
then the value of that same key in base
is used instead!
remark
This is essentially { ...base, ...overwrites }
but recursively
example
const base = { a: 0, b: 1 };
const overwrites = {}; // will be { a: 0, b: 1 } after merge
mergeDefault(base, overwrites) // { a: 0, b: 1 }
example
const base = { a: 0, b: 1 };
const overwrites = { a: 2, i: 3 };
mergeDefault(base, overwrites) // { a: 2, i: 3, b: 1 };
example
const base = { a: 0, b: 1 };
const overwrites = { a: null };
mergeDefault(base, overwrites) // { a: null, b: 1 };
example
const base = { a: 0, b: 1 };
const overwrites = { a: undefined };
mergeDefault(base, overwrites) // { a: 0, b: 1 };
example
const base = { a: null };
const overwrites = { a: { b: 5 } };
mergeDefault(base, overwrites) // { a: { b: 5 } };
Type parameters
Name | Type |
---|---|
A | extends NonNullObject |
B | extends Partial <A > |
Parameters
Name | Type | Description |
---|---|---|
base | A | Base object |
overwrites? | B | Overwrites to apply |
Returns
DeepRequired
<A
& B
>
Defined in
projects/utilities/packages/utilities/src/lib/mergeDefault.ts:43
mergeObjects
▸ mergeObjects<A
, B
>(objTarget
, objSource
): A
& B
Merges two objects
Type parameters
Name | Type |
---|---|
A | extends object |
B | extends object |
Parameters
Name | Type | Description |
---|---|---|
objTarget | A | The object to be merged |
objSource | Readonly <B > | The object to merge |
Returns
A
& B
Defined in
projects/utilities/packages/utilities/src/lib/mergeObjects.ts:9
noop
▸ noop(): void
Returns
void
Defined in
projects/utilities/packages/utilities/src/lib/noop.ts:2
objectToTuples
▸ objectToTuples(original
, prefix?
): [string
, unknown
][]
Convert an object to a tuple
Parameters
Name | Type | Default value | Description |
---|---|---|---|
original | Record <string , unknown > | undefined | - |
prefix | string | '' | The prefix for the key |
Returns
[string
, unknown
][]
Defined in
projects/utilities/packages/utilities/src/lib/objectToTuples.ts:8
parseURL
▸ parseURL(url
): URL
| null
Parses an URL, returns null if invalid.
Parameters
Name | Type | Description |
---|---|---|
url | string | The url to parse |
Returns
URL
| null
Defined in
projects/utilities/packages/utilities/src/lib/parseUrl.ts:7
partition
▸ partition<T
>(array
, predicate
): T
[][]
Partitions array
into a tuple of two arrays,
where one array contains all elements that satisfies predicate
,
and the other contains all elements that do not satisfy predicate
.
Type parameters
Name |
---|
T |
Parameters
Name | Type | Description |
---|---|---|
array | T [] | The array to partition. This array is not mutated. |
predicate | (value : T , index : number ) => boolean | The predicate function to determine in which partition the item should be placed. The function should return true for items that should be placed in the first partition, and false for those that should be placed in the second partition. |
Returns
T
[][]
A tuple of two arrays.
Defined in
projects/utilities/packages/utilities/src/lib/partition.ts:12
range
▸ range(min
, max
, step
): number
[]
Get an array of numbers with the selected range
Parameters
Name | Type | Description |
---|---|---|
min | number | The minimum value |
max | number | The maximum value |
step | number | The step value |
Returns
number
[]
Defined in
projects/utilities/packages/utilities/src/lib/range.ts:7
regExpEsc
▸ regExpEsc(str
): string
Cleans a string from regex injection
Parameters
Name | Type | Description |
---|---|---|
str | string | The string to clean |
Returns
string
Defined in
projects/utilities/packages/utilities/src/lib/regExpEsc.ts:8
roundNumber
▸ roundNumber(num
, scale?
): number
Properly rounds up or down a number. Also supports strings using an exponent to indicate large or small numbers.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
num | string | number | undefined | The number to round off |
scale | number | 0 | The amount of decimals to retain |
Returns
number
Defined in
projects/utilities/packages/utilities/src/lib/roundNumber.ts:7
splitText
▸ splitText(str
, length
, char?
): string
Split a string by its latest space character in a range from the character 0 to the selected one.
copyright
2019 Antonio Román
license
Apache-2.0
Parameters
Name | Type | Default value | Description |
---|---|---|---|
str | string | undefined | The text to split. |
length | number | undefined | The length of the desired string. |
char | string | ' ' | The character to split with |
Returns
string
Defined in
projects/utilities/packages/utilities/src/lib/splitText.ts:9
toTitleCase
▸ toTitleCase(str
, options?
): string
Converts a string to Title Case
description
This is designed to also ensure common Discord PascalCased strings
are put in their TitleCase {@link baseVariants}.
You can also provide your own variants to merge with the {@link baseVariants} for your own functionality use.
Parameters
Name | Type | Description |
---|---|---|
str | string | The string to title case |
options | ToTitleCaseOptions | The options to use when converting the string |
Returns
string
Defined in
projects/utilities/packages/utilities/src/lib/toTitleCase.ts:35
tryParse
▸ tryParse(value
): object
| string
Try parse a stringified JSON string.
Parameters
Name | Type | Description |
---|---|---|
value | string | The value to parse |
Returns
object
| string