@vangware/utils

Index

Functions

Type aliases

ArrayOrIterable

ArrayOrIterable<Item>: ArrayLike<Item> | Iterable<Item>

ArrayLike or Iterable alias.

Type parameters

Item

Type of items in the ArrayLike or Iterable.

DecimalTuple

DecimalTuple: readonly [coefficient: number, exponent: number]

2-Tuple to represent decimals [coefficient, exponent].

Entries

Entries<Source>: ReadonlyArray<Entry<Source>>

Array of Entries (Entry type).

Type parameters

Source

Source object to which the entities belong to.

Entry

Entry<Source>: readonly [key: string, value: Source[keyof Source]]

Entity tuple [key, object[key]].

Type parameters

Source

Source object to which the entity belongs to.

Falsy

Falsy: Nullish | "" | 0 | false

Types that evaluates to false in JS.

FilterTuple

FilterTuple<Item, Filtered>: readonly [filteredIn: ReadonlyArray<Filtered>, filteredOut: ReadonlyArray<OptionalExclude<Item, Filtered>>]

Tuple generated by arrayFilterTuple, which contains matching and non matching values.

Type parameters

Item

Type of the items being filtered.
Filtered: Item = Item

Type of the matching items.

Filterer

Filterer<Item, Filtered>: GuardedFilterer<Item, Filtered> | UnguardedFilterer<Item>

Filterer function.

Type parameters

Item

Type of the items in the source array.
Filtered: Item

Type of filtered items.

Grouped

Grouped<Item>: ImmutableRecord<ReadonlyArray<Item>, string>

Group object.

example

{
    [groupName]: [...valuesOfGroupName]
}

Type parameters

Item

Type of the items in the source array.

Grouper

Grouper<Item>: (item: Item) => number | string

Type parameters

Item

Type of the items in the source array.

Type declaration

- (item: Item): number | string
- Grouper function.
  
  Parameters
  - item: Item
    
    Item of the source array.
  Returns number | string
  Group name.

GuardedFilterer

GuardedFilterer<Item, Filtered>: (item: Item) => item is Filtered

Type parameters

Item

Type of the items in the source array.
Filtered: Item

Type of filtered items.

Type declaration

- (item: Item): item is Filtered
- Guarded filterer function.
  
  Parameters
  - item: Item
  Returns item is Filtered

ImmutableRecord

ImmutableRecord<Value, Key>: Readonly<Record<Key, Value>>

Readonly Record wrapper.

Type parameters

Value = unknown

Possible values of the given Record.
Key: number | string | symbol = number | string | symbol

Key type of given Record.

Mapper

Mapper<Item, Output>: (item: Item) => Output

Type parameters

Item

Type of the items in the source array.
Output

Type of the output (same as the input by default).

Type declaration

- (item: Item): Output
- Mapper function.
  
  Parameters
  - item: Item
    
    Item of the source array.
  Returns Output
  Mapped value.

Nullish

Nullish: null | undefined

Union of null and undefined.

OptionalExclude

OptionalExclude<Type, Exclusion>: Exclude<Type, Exclusion> extends never ? Exclusion : Exclude<Type, Exclusion>

Excludes only if it doesn't return never. Fallback to Exclusion.

Type parameters

Type

Type to apply exclusion on.
Exclusion

Exclusion object.

Radix

Radix: 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36

Valid radix values (from 2 to 36).

Reducer

Reducer<Item, Output>: (accumulator: Output) => Mapper<Item, Output>

Type parameters

Item

Type of the items in the source array.
Output = ReadonlyArray<Item>

Type of the output (same as the input by default).

Type declaration

- (accumulator: Output): Mapper<Item, Output>
- Reducer function.
  
  Parameters
  - accumulator: Output
    
    Reducer accumulator.
  Returns Mapper<Item, Output>
  Mapper with accumulator context.

Sorter

Sorter<Item>: (next: Item) => Mapper<Item, number>

Type parameters

Item

Type declaration

- (next: Item): Mapper<Item, number>
- Sorter function.
  
  Parameters
  - next: Item
    
    Item following the current one.
  Returns Mapper<Item, number>
  Mapped value.

StringReplaceMap

StringReplaceMap: ImmutableRecord<number | string, string>

String replace dictionary.

example

{
    [searchString]: "replacingString"
}

Truthy

Truthy<Actual>: Actual extends Falsy ? never : Actual

Generic type to check if value is not Falsy (evaluates to true in JS).

Type parameters

Actual = unknown

Actual type (if not truthy).

TypeOf

Possible types returned by typeof.

UnguardedFilterer

UnguardedFilterer<Item>: (item: Item) => boolean

Type parameters

Item

Type of the items in the source array.

Type declaration

- (item: Item): boolean
- Unguarded filter function.
  
  Parameters
  - item: Item
  Returns boolean

Functions

arrayEvery

arrayEvery<Item, Predicated>(predicate: Filterer<Item, Predicated>): (source: readonly Item[]) => source is readonly Predicated[]

- Defined in array/arrayEvery.ts:17
Curried wrapper for Array.prototype.every.
example
```
const everyNumber = arrayEvery(isNumber);
everyNumber([0, 1, 2]); // true
everyNumber([0, 1, "foo", 2]); // false
```
Type parameters
- Item
  
  Type of items in source array.
- Predicated
  
  Type of predicated items.
Parameters
- predicate: Filterer<Item, Predicated>
  
  Function predicate to test every item.
Returns (source: readonly Item[]) => source is readonly Predicated[]
Curried function with predicate in context.
- - (source: readonly Item[]): source is readonly Predicated[]
  - Parameters
    - source: readonly Item[]
    Returns source is readonly Predicated[]

arrayFilterIn

arrayFilterIn<Item, Filtered>(filterer: Filterer<Item, Filtered>): (source: readonly Item[]) => Filtered[]

- Defined in array/arrayFilterIn.ts:19
Takes a positive filterer and applies it to given source array.
example
```
const filterInEven = arrayFilterIn((item: number) => item % 2 === 0);
const filterOutEmpty = arrayFilterIn((item: string) => item !== "");

filterInEven([0, 1, 2, 3]); // [0, 2]
filterOutEmpty(["hello", "", "", "world"]); // ["hello", "world"]
```
Type parameters
- Item
  
  Type of items in source array.
- Filtered
  
  Type of filtered items.
Parameters
- filterer: Filterer<Item, Filtered>
  
  Filterer function.
Returns (source: readonly Item[]) => Filtered[]
Curried function with filter set in context.
- - (source: readonly Item[]): Filtered[]
  - Parameters
    - source: readonly Item[]
    Returns Filtered[]

arrayFilterOut

arrayFilterOut<Item, Filtered>(filterer: Filterer<Item, Filtered>): (source: readonly Item[]) => OptionalExclude<Item, Filtered>[]

- Defined in array/arrayFilterOut.ts:20
Takes a negative filterer and applies it to given source array.
example
```
const filterOutEven = arrayFilterOut((item: number) => item % 2 === 0);
const filterOutEmpty = arrayFilterOut((item: string) => item === "");

filterOutEven([0, 1, 2, 3]); // [1, 3]
filterOutEmpty(["hello", "", "", "world"]); // ["hello", "world"]
```
Type parameters
- Item
  
  Type of items in source array.
- Filtered
  
  Type of filtered items.
Parameters
- filterer: Filterer<Item, Filtered>
  
  Filterer out function.
Returns (source: readonly Item[]) => OptionalExclude<Item, Filtered>[]
Curried function with filter set in context.
- - (source: readonly Item[]): OptionalExclude<Item, Filtered>[]
  - Parameters
    - source: readonly Item[]
    Returns OptionalExclude<Item, Filtered>[]

arrayFilterTuple

arrayFilterTuple<Item, Filtered>(filterer: Filterer<Item, Filtered>): (source: readonly Item[]) => FilterTuple<Item, Filtered>

- Defined in array/arrayFilterTuple.ts:21
Takes a filterer and applies it to a source array returning a [matching, nonMatching] tuple.
example
```
const filterEvenOdd = arrayFilterTuple((item: number) => item % 2 === 0);

filterEvenOdd([0, 1, 2, 3]); // [[0, 2], [1, 3]]
```
Type parameters
- Item
  
  Type of items in source array.
- Filtered
  
  Type of filtered items.
Parameters
- filterer: Filterer<Item, Filtered>
  
  Filterer function.
Returns (source: readonly Item[]) => FilterTuple<Item, Filtered>
Curried function with filter in context.
- - (source: readonly Item[]): FilterTuple<Item, Filtered>
  - Parameters
    - source: readonly Item[]
    Returns FilterTuple<Item, Filtered>

arrayFlat

arrayFlat<Depth>(depth: Depth): <Item>(source: readonly Item[]) => FlatArray<readonly Item[], Depth>[]

- Defined in array/arrayFlat.ts:13
Curried wrapper for Array.prototype.flat.
example
```
const flatten = arrayFlat(1);
flatten([["foo", "bar"], [1, 2]]); // ["foo", "bar", 1, 2]
```
Type parameters
- Depth: number
  
  Recursion depth type.
Parameters
- depth: Depth
  
  The maximum recursion depth.
Returns <Item>(source: readonly Item[]) => FlatArray<readonly Item[], Depth>[]
Curried function with depth in context.
- - <Item>(source: readonly Item[]): FlatArray<readonly Item[], Depth>[]
  - Type parameters
    - Item
    Parameters
    - source: readonly Item[]
    Returns FlatArray<readonly Item[], Depth>[]

arrayFrom

arrayFrom<Item>(source: ArrayOrIterable<Item>): readonly Item[]

- Defined in array/arrayFrom.ts:14
Given an ArrayLike or Iterable, return an array.
example
```
arrayFrom("hello"); // ["h", "e", "l", "l", "o"]
```
Type parameters
- Item
  
  Type of items in source array.
Parameters
- source: ArrayOrIterable<Item>
  
  Source value (must be an ArrayLike or Iterable).
Returns readonly Item[]
Frozen array made with given ArrayLike or Iterable.

arrayGroup

arrayGroup<Item>(grouper: Grouper<Item>): (source: readonly Item[]) => Readonly<Record<string, readonly Item[]>>

- Defined in array/arrayGroup.ts:23
Takes grouper and applies it to given source array.
example
```
const groupEvenOdd = arrayGroup(
    (item: number) => item % 2 === 0 "even" : "odd"
);

groupEvenOdd([0, 1, 2, 3]); // { even: [0, 2], odd: [1, 3] }
```
Type parameters
- Item
  
  Type of items in source array.
Parameters
- grouper: Grouper<Item>
  
  Grouper function.
Returns (source: readonly Item[]) => Readonly<Record<string, readonly Item[]>>
Curried function with grouper in context.
- - (source: readonly Item[]): Readonly<Record<string, readonly Item[]>>
  - Curried function with reducer set.
    example
    const sumStartingInZero = sum(0); sumStartingInZero([1, 2, 3]);
    Parameters
    - source: readonly Item[]
    Returns Readonly<Record<string, readonly Item[]>>
    Curried function with reducer and initialValue in context.

arrayInsert

arrayInsert(index: number): <Item>(item: Item) => <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]

- Defined in array/arrayInsert.ts:21
Takes an index and an item and makes a copy of given source array with that new item in the given index.
example
```
const insertLast = arrayInsert(Infinity);
const insertFirst = arrayInsert(0);
const insertValueLast = insertLast("value");
const insertValueFirst = insertFirst("value");

insertValueLast([0, 1, 2, 3]); // [0, 1, 2, 3, "value"]
insertValueFirst([0, 1, 2, 3]); // ["value", 0, 1, 2, 3]
```
Parameters
- index: number
  
  Index to insert item.
Returns <Item>(item: Item) => <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]
Curried function with index in context.
- - <Item>(item: Item): <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]
  - Type parameters
    - Item
    Parameters
    - item: Item
    Returns <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]
    - - <SourceItem>(source: readonly SourceItem[]): (Item | SourceItem)[]
      - Curried function with index set.
        
        example
        const insertValueLast = insertLast("value"); insertValueLast([0, 1, 2, 3]); // [0, 1, 2, 3, "value"]
        
        Type parameters
        SourceItem = Item
        Parameters
        source: readonly SourceItem[]
        Returns (Item | SourceItem)[]
        Curried function with index and item in context.

arrayInsertFirst

arrayInsertFirst<Item>(item: Item): <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]

- Defined in array/arrayInsertFirst.ts:15
Takes an item and inserts it at the beginning of given source array.
example
```
const arrayInsertValueFirst = arrayInsertFirst("value");

arrayInsertValueFirst([1, 2, 3]); // ["value", 1, 2, 3]
arrayInsertValueFirst(["foo", "bar"]); // ["value", "foo", "bar"]
```
Type parameters
- Item
Parameters
- item: Item
Returns <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]
Curried function with item and index in context.
- - <SourceItem>(source: readonly SourceItem[]): (Item | SourceItem)[]
  - Curried function with index set.
    example
    const insertValueLast = insertLast("value"); insertValueLast([0, 1, 2, 3]); // [0, 1, 2, 3, "value"]
    Type parameters
    - SourceItem = Item
    Parameters
    - source: readonly SourceItem[]
    Returns (Item | SourceItem)[]
    Curried function with index and item in context.

arrayInsertLast

arrayInsertLast<Item>(item: Item): <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]

- Defined in array/arrayInsertLast.ts:15
Takes an item and inserts it at the end of given source array.
example
```
const arrayInsertValueLast = arrayInsertLast("value");

arrayInsertValueLast([0, 1, 2, 3]); // [0, 1, 2, 3, "value"]
arrayInsertValueLast(["foo", "bar"]); // ["foo", "bar", "value"]
```
Type parameters
- Item
Parameters
- item: Item
Returns <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]
Curried function with item and index in context.
- - <SourceItem>(source: readonly SourceItem[]): (Item | SourceItem)[]
  - Curried function with index set.
    example
    const insertValueLast = insertLast("value"); insertValueLast([0, 1, 2, 3]); // [0, 1, 2, 3, "value"]
    Type parameters
    - SourceItem = Item
    Parameters
    - source: readonly SourceItem[]
    Returns (Item | SourceItem)[]
    Curried function with index and item in context.

arrayJoin

arrayJoin(separator: string): <Item>(source: readonly Item[]) => string

- Defined in array/arrayJoin.ts:12
Curried wrapper for Array.prototype.join.
example
```
const joinWithSpaces = arrayJoin(" ");
joinWithSpaces(["foo", "bar"]); // "foo bar"
```
Parameters
- separator: string
  
  Value separator.
Returns <Item>(source: readonly Item[]) => string
Curried function with separator in context.
- - <Item>(source: readonly Item[]): string
  - Type parameters
    - Item
    Parameters
    - source: readonly Item[]
    Returns string

arrayMap

arrayMap<Item, Output>(mapper: Mapper<Item, Output>): (source: readonly Item[]) => Output[]

- Defined in array/arrayMap.ts:17
Takes a mapper function and applies it to given source array.
example
```
const mapDouble = arrayMap((item: number) => item * 2);

mapDouble([0, 1, 2, 3]); // [0, 2, 4, 6]
```
Type parameters
- Item
  
  Type of the items in the source array.
- Output = Item
  
  Type of the output (same as the input by default).
Parameters
- mapper: Mapper<Item, Output>
  
  Mapper function function.
Returns (source: readonly Item[]) => Output[]
Curried function with mapper in context.
- - (source: readonly Item[]): Output[]
  - Parameters
    - source: readonly Item[]
    Returns Output[]

arrayReduce

arrayReduce<Item, Output>(reducer: Reducer<Item, Output>): (initialValue: Output) => (source: readonly Item[]) => Output

- Defined in array/arrayReduce.ts:19
Takes a reducer and an initialValue and applies it to source array.
example
```
const sum = arrayReduce<number, number>(total => item => total + item);
const sumStartingInZero = sum(0);
const sumStartingInTwo = sum(2);

sumStartingInZero([1, 2, 3]); // 6
sumStartingInTwo([1, 2, 3]); // 8
```
Type parameters
- Item
  
  Type of the items in the source array.
- Output = readonly Item[]
  
  Type of the output (an array of Input by default).
Parameters
- reducer: Reducer<Item, Output>
Returns (initialValue: Output) => (source: readonly Item[]) => Output
Curried function with reducer in context.
- - (initialValue: Output): (source: readonly Item[]) => Output
  - Parameters
    - initialValue: Output
    Returns (source: readonly Item[]) => Output
    - - (source: readonly Item[]): Output
      - Curried function with reducer set.
        
        example
        const sumStartingInZero = sum(0); sumStartingInZero([1, 2, 3]);
        
        Parameters
        source: readonly Item[]
        Returns Output
        Curried function with reducer and initialValue in context.

arrayReplace

arrayReplace(index: number): <Item>(item: Item) => <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]

- Defined in array/arrayReplace.ts:21
Takes an index and an item and replaces the source array item in that index with the taken item.
example
```
const replaceLast = arrayReplace(Infinity);
const replaceFirst = arrayReplace(0);
const replaceItemLast = replaceLast("replacement");
const replaceItemFirst = replaceFirst("replacement");

replaceItemLast([0, 1, 2, 3]); // [0, 1, 2, "replacement"]
replaceItemFirst([0, 1, 2, 3]); // ["replacement", 1, 2, 3]
```
Parameters
- index: number
  
  Index to start replace item.
Returns <Item>(item: Item) => <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]
Curried function with index in context.
- - <Item>(item: Item): <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]
  - Type parameters
    - Item
    Parameters
    - item: Item
    Returns <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]
    - - <SourceItem>(source: readonly SourceItem[]): (Item | SourceItem)[]
      - Curried function with index set.
        
        example
        const replaceItemLast = replaceLast("replacement"); replaceItemLast([0, 1, 2, 3]); // [0, 1, 2, "replacement"]
        
        Type parameters
        SourceItem = Item
        Parameters
        source: readonly SourceItem[]
        Returns (Item | SourceItem)[]
        Curried function with index and item in context.

arrayReplaceFirst

arrayReplaceFirst<Item>(item: Item): <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]

- Defined in array/arrayReplaceFirst.ts:15
Takes an item and replaces the first one with it in the given source array.
example
```
const arrayReplaceValueFirst = arrayReplaceFirst("value");

arrayReplaceValueFirst([1, 2, 3]); // ["value", 2, 3]
arrayReplaceValueFirst(["foo", "bar"]); // ["value", "bar"]
```
Type parameters
- Item
Parameters
- item: Item
Returns <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]
Curried function with item and index in context.
- - <SourceItem>(source: readonly SourceItem[]): (Item | SourceItem)[]
  - Curried function with index set.
    example
    const replaceItemLast = replaceLast("replacement"); replaceItemLast([0, 1, 2, 3]); // [0, 1, 2, "replacement"]
    Type parameters
    - SourceItem = Item
    Parameters
    - source: readonly SourceItem[]
    Returns (Item | SourceItem)[]
    Curried function with index and item in context.

arrayReplaceLast

arrayReplaceLast<Item>(item: Item): <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]

- Defined in array/arrayReplaceLast.ts:15
Takes an item and replaces the last with it in the given source array.
example
```
const arrayReplaceValueLast = arrayReplaceLast("value");

arrayReplaceValueLast([0, 1, 2, 3]); // [0, 1, 2, "value"]
arrayReplaceValueLast(["foo", "bar"]); // ["foo", "value"]
```
Type parameters
- Item
Parameters
- item: Item
Returns <SourceItem>(source: readonly SourceItem[]) => (Item | SourceItem)[]
Curried function with item and index in context.
- - <SourceItem>(source: readonly SourceItem[]): (Item | SourceItem)[]
  - Curried function with index set.
    example
    const replaceItemLast = replaceLast("replacement"); replaceItemLast([0, 1, 2, 3]); // [0, 1, 2, "replacement"]
    Type parameters
    - SourceItem = Item
    Parameters
    - source: readonly SourceItem[]
    Returns (Item | SourceItem)[]
    Curried function with index and item in context.

arrayReverse

arrayReverse<Item>(source: readonly Item[]): Item[]

- Defined in array/arrayReverse.ts:12
Takes a source array and reverse the order of its items.
example
```
arrayReverse([0, 1, 2, 3]); // [3, 2, 1, 0]
```
Type parameters
- Item
  
  Type of the items in the source array.
Parameters
- source: readonly Item[]
  
  Source array to be reversed.
Returns Item[]
Copy of source with values in reversed order.

arraySlice

arraySlice(start: number): (end: number) => <Item>(source: readonly Item[]) => Item[]

- Defined in array/arraySlice.ts:15
Takes a start and end and applies a slice to source array from given start to given end.
example
```
const sliceFrom1 = arraySlice(1);
const sliceFrom1To3 = sliceFrom1(3);

sliceFrom1To3([0, 1, 2, 3]); // [1, 2]
```
Parameters
- start: number
  
  Slice start.
Returns (end: number) => <Item>(source: readonly Item[]) => Item[]
Curried function with start in context.
- - (end: number): <Item>(source: readonly Item[]) => Item[]
  - Parameters
    - end: number
    Returns <Item>(source: readonly Item[]) => Item[]
    - - <Item>(source: readonly Item[]): Item[]
      - Curried function with start set.
        
        example
        const sliceFrom1To3 = sliceFrom1(3); sliceFrom1To3([0, 1, 2, 3]); // [1, 2]
        
        Type parameters
        Item
        Parameters
        source: readonly Item[]
        Returns Item[]
        Curried function with start in context.

arraySliceFrom

arraySliceFrom(start: number): <Item>(source: readonly Item[]) => Item[]

- Defined in array/arraySliceFrom.ts:16
Takes a start and applies a slice to source array from given start to the end of the source.
example
```
const sliceFrom1 = arraySliceFrom(1);

sliceFrom1([0, 1, 2, 3]); // [1, 2, 3]
```
Parameters
- start: number
  
  Slice start.
Returns <Item>(source: readonly Item[]) => Item[]
Curried function with start in context.
- - <Item>(source: readonly Item[]): Item[]
  - Curried function with start set.
    example
    const sliceFrom1To3 = sliceFrom1(3); sliceFrom1To3([0, 1, 2, 3]); // [1, 2]
    Type parameters
    - Item
    Parameters
    - source: readonly Item[]
    Returns Item[]
    Curried function with start in context.

arraySliceTo

arraySliceTo(end: number): <Item>(source: readonly Item[]) => Item[]

- Defined in array/arraySliceTo.ts:16
Takes an end and applies a slice to source array from the start of the source to the given end.
example
```
const sliceTo2 = arraySliceTo(2);

sliceTo2([0, 1, 2, 3]); // [0, 1, 2]
```
Parameters
- end: number
  
  Slice end.
Returns <Item>(source: readonly Item[]) => Item[]
Curried function with end in context (start set to 0).
- - <Item>(source: readonly Item[]): Item[]
  - Curried function with start set.
    example
    const sliceFrom1To3 = sliceFrom1(3); sliceFrom1To3([0, 1, 2, 3]); // [1, 2]
    Type parameters
    - Item
    Parameters
    - source: readonly Item[]
    Returns Item[]
    Curried function with start in context.

arraySome

arraySome<Item, Predicated>(predicate: Filterer<Item, Predicated>): (source: readonly Item[]) => source is readonly (Item | Predicated)[]

- Defined in array/arraySome.ts:18
Curried wrapper for Array.prototype.some.
example
```
const someNumber = arraySome(isNumber);
someNumber([0, 1, 2]); // true
someNumber([0, 1, "foo", 2]); // true
someNumber(["foo", "bar"]); // false
```
Type parameters
- Item
  
  Type of items in source array.
- Predicated
  
  Type of predicated items.
Parameters
- predicate: Filterer<Item, Predicated>
  
  Function predicate to test until some item of the type.
Returns (source: readonly Item[]) => source is readonly (Item | Predicated)[]
Curried function with predicate in context.
- - (source: readonly Item[]): source is readonly (Item | Predicated)[]
  - Parameters
    - source: readonly Item[]
    Returns source is readonly (Item | Predicated)[]

arraySort

arraySort<Item>(sorter: Sorter<Item>): (source: readonly Item[]) => Item[]

- Defined in array/arraySort.ts:18
Takes a sorter function and applies it to given source array.
example
```
const sortNumbers = arraySort(
    (next: number) => (item: number) => next - item
);

sortNumbers([3, 0, 2, 1]); // [0, 1, 2, 3]
```
Type parameters
- Item
  
  Type of the items in the source array.
Parameters
- sorter: Sorter<Item>
  
  Sorter function function.
Returns (source: readonly Item[]) => Item[]
Curried function with sorter in context.
- - (source: readonly Item[]): Item[]
  - Parameters
    - source: readonly Item[]
    Returns Item[]

decimalTupleAdd

decimalTupleAdd(addend2: DecimalTuple): (addend1: DecimalTuple) => DecimalTuple

- Defined in number/decimalTupleAdd.ts:16
Takes a addend1 and addend2 and returns the addition of those values.
example
```
const addPoint1 = decimalTupleAdd([1, -1]);

addPoint1([2, -1]); // [3, -1] -> 0.3
```
Parameters
- addend2: DecimalTuple
  
  Second addend DecimalTuple of the addition.
Returns (addend1: DecimalTuple) => DecimalTuple
Curried function with addend1 set in context.
- - (addend1: DecimalTuple): DecimalTuple
  - Parameters
    - addend1: DecimalTuple
    Returns DecimalTuple

decimalTupleDivide

decimalTupleDivide(divisor: DecimalTuple): (__namedParameters: DecimalTuple) => DecimalTuple

- Defined in number/decimalTupleDivide.ts:18
Takes a divisor and dividend and returns the division of those values.
example
```
const half = decimalTupleDivide([2, 0]);

half([5, 0]); // [25, -1] -> 2.5
```
Parameters
- divisor: DecimalTuple
  
  Divisor DecimalTuple of the division.
Returns (__namedParameters: DecimalTuple) => DecimalTuple
Curried function with divisor set in context.
- - (__namedParameters: DecimalTuple): DecimalTuple
  - Parameters
    - __namedParameters: DecimalTuple
    Returns DecimalTuple

decimalTupleMultiply

decimalTupleMultiply(multiplier: DecimalTuple): (__namedParameters: DecimalTuple) => DecimalTuple

- Defined in number/decimalTupleMultiply.ts:17
Takes a multiplier and multiplicand and returns the multiplication result of those factors.
example
```
const double = decimalTupleMultiply([2, 0]);

double([5, -1]); // [1, 0] -> 1
```
Parameters
- multiplier: DecimalTuple
  
  Multiplier DecimalTuple of the multiplication.
Returns (__namedParameters: DecimalTuple) => DecimalTuple
Curried function with multiplier set in context.
- - (__namedParameters: DecimalTuple): DecimalTuple
  - Parameters
    - __namedParameters: DecimalTuple
    Returns DecimalTuple

decimalTupleSubtract

decimalTupleSubtract(subtrahend: DecimalTuple): (minuend: DecimalTuple) => DecimalTuple

- Defined in number/decimalTupleSubtract.ts:17
Takes a subtrahend and minuend and returns the subtraction of those values.
example
```
const subtractPoint1 = decimalTupleSubtract([1, -1]);

subtractPoint1([1, 0]); // [9, -1] -> 0.9
```
Parameters
- subtrahend: DecimalTuple
  
  Subtrahend of the subtraction.
Returns (minuend: DecimalTuple) => DecimalTuple
Curried function with subtrahend set in context.
- - (minuend: DecimalTuple): DecimalTuple
  - Parameters
    - minuend: DecimalTuple
    Returns DecimalTuple

decimalTupleToNumber

decimalTupleToNumber(source: DecimalTuple): number

- Defined in number/decimalTupleToNumber.ts:14
Takes a source DecimalTuple [coefficient, exponent] and returns a number.
example
```
decimalTupleToNumber([3141592653589793, -15]); // 3.141592653589793
decimalTupleToNumber([5, 3]); // 5000
```
Parameters
- source: DecimalTuple
  
  Source DecimalTuple [coefficient, exponent].
Returns number
Number generated from the source coefficient and exponent.

equal

equal(expected: unknown): (actual: unknown) => boolean

- Defined in equal/equal.ts:24
Given and expected value and an actual value, returns true if those values are deeply equal, or false if not.
example
```
const equalTo2 = equal(2);
const equalToObject = equal({ foo: "bar" });

equalTo2(2); // true
equalTo2(5); // false
equalToObject({ foo: "bar" }); // true
equalToObject({ bar: "baz" }); // false
```
Parameters
- expected: unknown
  
  Expected value to compare.
Returns (actual: unknown) => boolean
true if equal and false if not.
- - (actual: unknown): boolean
  - Parameters
    - actual: unknown
    Returns boolean

equalArrays

equalArrays(compare: (expected: unknown) => (actual: unknown) => boolean): (expected: unknown) => (actual: unknown) => boolean

- Defined in equal/equalArrays.ts:20
Given a compare function, an expected value and an actual value, returns true if those values are equal based on the compare output, or false if not.
example
```
const compare = actual => expected => actual === expected;
const equalToArray = equalArrays(compare)(["foo", "bar"]);

equalToArray(["foo", "bar"]); // true
equalToArray(["bar", "foo"]); // false
```
Parameters
- compare: (expected: unknown) => (actual: unknown) => boolean
  
  Comparison function.
  - - (expected: unknown): (actual: unknown) => boolean
    - Parameters
      - expected: unknown
      Returns (actual: unknown) => boolean
      - (actual: unknown): boolean
        Parameters
        actual: unknown
        Returns boolean
Returns (expected: unknown) => (actual: unknown) => boolean
Curried function with compare function in context.
- - (expected: unknown): (actual: unknown) => boolean
  - Parameters
    - expected: unknown
    Returns (actual: unknown) => boolean
    - - (actual: unknown): boolean
      - Curried function with compare set.
        
        example
        const equalToArray = equalArrays(compare)(["foo", "bar"]); equalToArray(["foo", "bar"]); // true
        
        Parameters
        actual: unknown
        Returns boolean
        Curried function with compare and expected in context.

equalDates

equalDates(expected: unknown): (actual: unknown) => boolean

- Defined in equal/equalDates.ts:18
Given and expected value and an actual value, returns true if those values are dates and equal, or false if not.
example
```
const equalToDate0 = equalDates(new Date(0));

equalToDate0(new Date(0)); // true
equalToDate0(new Date(1)); // false
```
Parameters
- expected: unknown
  
  Expected value to compare.
Returns (actual: unknown) => boolean
Curried function with expected in context.
- - (actual: unknown): boolean
  - Parameters
    - actual: unknown
    Returns boolean

equalObjects

equalObjects(compare: (expected: unknown) => (actual: unknown) => boolean): (expected: unknown) => (actual: unknown) => boolean

- Defined in equal/equalObjects.ts:23
Given a compare function, an expected value and an actual value, returns true if those values are equal based on the compare output, or false if not.
example
```
const compare = actual => expected => actual === expected;
const equalToObject = equalObjects(compare)({ foo: "bar" });

equalToObject({ foo: "bar" }); // true
equalToObject({ bar: "baz" }); // false
```
Parameters
- compare: (expected: unknown) => (actual: unknown) => boolean
  
  Comparison function.
  - - (expected: unknown): (actual: unknown) => boolean
    - Parameters
      - expected: unknown
      Returns (actual: unknown) => boolean
      - (actual: unknown): boolean
        Parameters
        actual: unknown
        Returns boolean
Returns (expected: unknown) => (actual: unknown) => boolean
Curried function with compare function in context.
- - (expected: unknown): (actual: unknown) => boolean
  - Parameters
    - expected: unknown
    Returns (actual: unknown) => boolean
    - - (actual: unknown): boolean
      - Curried function with compare function set.
        
        example
        const equalToObject = equalObjects(compare)({ foo: "bar" }); equalToObject({ foo: "bar" }); // true
        
        Parameters
        actual: unknown
        Returns boolean
        Curried function with compare and expected in context.

equalRegExp

equalRegExp(expected: unknown): (actual: unknown) => boolean

- Defined in equal/equalRegExp.ts:18
Given and expected value and an actual value, returns true if those values are regular expressions and equal, or false if not.
example
```
const equalToRegExp = equalRegExp(new RegExp(/./gu));

equalToRegExp(new RegExp(/./gu)); // true
equalToRegExp(new RegExp(/foo/gu)); // false
```
Parameters
- expected: unknown
  
  Expected value to compare.
Returns (actual: unknown) => boolean
Curried function expected in context.
- - (actual: unknown): boolean
  - Parameters
    - actual: unknown
    Returns boolean

equalValues

equalValues(expected: unknown): (actual: unknown) => boolean

- Defined in equal/equalValues.ts:15
Given and expected value and an actual value, returns true if those values are equal, or false if not.
example
```
const equalTo2 = equalValues(2);

equalTo2(2); // true
equalTo2(8); // false
```
Parameters
- expected: unknown
  
  Expected value to compare.
Returns (actual: unknown) => boolean
Curried function with expected in context.
- - (actual: unknown): boolean
  - Parameters
    - actual: unknown
    Returns boolean

functionNot

functionNot<Argument>(source: (...argument: readonly Argument[]) => boolean): (...argument: readonly Argument[]) => boolean

- Defined in function/functionNot.ts:16
Takes a source function and returns a copy with negated output.
example
```
const isPositive = (value: number) => value >= 0;
const isNegative = functionNot(isPositive);

isPositive(1); // true
isNegative(1); // false
```
Type parameters
- Argument = unknown
  
  Argument type of the given function.
Parameters
- source: (...argument: readonly Argument[]) => boolean
  
  Source function which output will be negated.
  - - (...argument: readonly Argument[]): boolean
    - Parameters
      - Rest ...argument: readonly Argument[]
      Returns boolean
Returns (...argument: readonly Argument[]) => boolean
Source function with negated output.
- - (...argument: readonly Argument[]): boolean
  - Parameters
    - Rest ...argument: readonly Argument[]
    Returns boolean

instanceOf

instanceOf<Expected>(constructor: new (..._arguments: readonly never[]) => unknown): <Actual>(entity: Expected | Actual) => entity is Expected

- Defined in type/instanceOf.ts:15
Takes a constructor and checks if given entity is an instance of it.
example
```
const isInstanceOfArray = instanceOf(Array)

isInstanceOfArray([]); // true
isInstanceOfArray({}); // false
```
Type parameters
- Expected = unknown
  
  Expected type.
Parameters
- constructor: new (..._arguments: readonly never[]) => unknown
  
  Constructor used to check.
  - - new (..._arguments: readonly never[]): unknown
    - Parameters
      - Rest ..._arguments: readonly never[]
      Returns unknown
Returns <Actual>(entity: Expected | Actual) => entity is Expected
Curried function with constructor in context.
- - <Actual>(entity: Expected | Actual): entity is Expected
  - Type parameters
    - Actual = unknown
    Parameters
    - entity: Expected | Actual
    Returns entity is Expected

isArray

isArray<Actual, Item>(entity: Actual | readonly Item[]): entity is readonly Item[]

- Defined in type/isArray.ts:14
Check if given entity is an instance of Array.
example
```
isArray([]); // true
isArray(null); // false
```
Type parameters
- Actual = unknown
  
  Actual type of the given entity.
- Item = unknown
  
  Type of items in given entity.
Parameters
- entity: Actual | readonly Item[]
  
  Entity to check.
Returns entity is readonly Item[]
true if is array, false if not.

isBigInt

isBigInt<Actual>(entity: BigInt | Actual): entity is BigInt

- Defined in type/isBigInt.ts:6
Check if given entity is an instance of BigInt.

Type parameters
- Actual = unknown
Parameters
- entity: BigInt | Actual
Returns entity is BigInt

isBoolean

isBoolean<Actual>(entity: boolean | Actual): entity is boolean

- Defined in type/isBoolean.ts:6
Check if given entity is an instance of Boolean.

Type parameters
- Actual = unknown
Parameters
- entity: boolean | Actual
Returns entity is boolean

isDate

isDate<Actual>(entity: Date | Actual): entity is Date

- Defined in type/isDate.ts:6
Check if given entity is an instance of Date.

Type parameters
- Actual = unknown
Parameters
- entity: Date | Actual
Returns entity is Date

isFalsy

isFalsy<Actual>(entity: Actual | Falsy): entity is Falsy

- Defined in type/isFalsy.ts:20
Check if given entity is falsy (0, NaN, "", false, or nullish).
example
```
isFalsy(0); // true
isFalsy(NaN); // true
isFalsy(""); // true
isFalsy(false); // true
isFalsy(null); // true
isFalsy(undefined); // true
isFalsy(1); // false
```
Type parameters
- Actual = unknown
  
  Actual type of the given entity.
Parameters
- entity: Actual | Falsy
  
  Entity to check.
Returns entity is Falsy
true if is falsy, false if not.

isFunction

isFunction<Actual>(entity: Function | Actual): entity is Function

- Defined in type/isFunction.ts:7
Check if given entity is an instance of Function.

Type parameters
- Actual = unknown
Parameters
- entity: Function | Actual
Returns entity is Function

isNull

isNull<Actual>(entity: null | Actual): entity is null

- Defined in type/isNull.ts:15
Check if entity is null.
example
```
isNull(null); // true
isNull(undefined); // false
```
Type parameters
- Actual = unknown
  
  Actual type of the entity.
Parameters
- entity: null | Actual
  
  Entity to check.
Returns entity is null
true if is null, false if not.

isNullish

isNullish<Actual>(entity: Nullish | Actual): entity is Nullish

- Defined in type/isNullish.ts:18
Check if entity is undefined or null.
example
```
isNullish(undefined); // true
isNullish(null); // true
isNullish(1); // false
```
Type parameters
- Actual = unknown
  
  Actual type of the entity.
Parameters
- entity: Nullish | Actual
  
  Entity to check.
Returns entity is Nullish
true if is nullish, false if not.

isNumber

isNumber<Actual>(entity: number | Actual): entity is number

- Defined in type/isNumber.ts:6
Check if entity is an instance of Number.

Type parameters
- Actual = unknown
Parameters
- entity: number | Actual
Returns entity is number

isObject

isObject<Actual>(entity: Actual | Readonly<Record<string | number | symbol, unknown>>): entity is Readonly<Record<string | number | symbol, unknown>>

- Defined in type/isObject.ts:18
Check if entity is an instance of Object (null is omitted).
example
```
isObject({}); // true
isObject(null); // false
```
Type parameters
- Actual = unknown
  
  Actual type of the entity.
Parameters
- entity: Actual | Readonly<Record<string | number | symbol, unknown>>
  
  Entity to check.
Returns entity is Readonly<Record<string | number | symbol, unknown>>
true if is object, false if not.

isPromise

isPromise<PromiseValue, Actual>(entity: Actual | Promise<PromiseValue>): entity is Promise<PromiseValue>

- Defined in type/isPromise.ts:16
Check if entity value is an instance of Promise.
example
```
isPromise(Promise.resolve()); // true
isPromise(1); // false
```
Type parameters
- PromiseValue = unknown
  
  Value of the promise.
- Actual = unknown
  
  Actual type of the entity.
Parameters
- entity: Actual | Promise<PromiseValue>
  
  Entity to check.
Returns entity is Promise<PromiseValue>
true if is promise, false if not.

isRegExp

isRegExp<Actual>(entity: RegExp | Actual): entity is RegExp

- Defined in type/isRegExp.ts:6
Check if entity is an instance of RegExp.

Type parameters
- Actual = unknown
Parameters
- entity: RegExp | Actual
Returns entity is RegExp

isString

isString<Actual>(entity: string | Actual): entity is string

- Defined in type/isString.ts:6
Check if entity is an instance of String.

Type parameters
- Actual = unknown
Parameters
- entity: string | Actual
Returns entity is string

isSymbol

isSymbol<Actual>(entity: symbol | Actual): entity is symbol

- Defined in type/isSymbol.ts:6
Check if entity is an instance of Symbol.

Type parameters
- Actual = unknown
Parameters
- entity: symbol | Actual
Returns entity is symbol

isTruthy

isTruthy<Actual>(entity: Actual): entity is Truthy<Actual>

- Defined in type/isTruthy.ts:16
Check if given entity is truthy (so not 0, NaN, "", false, or nullish).
example
```
isTruthy(1); // true
isTruthy(0); // false
```
Type parameters
- Actual = unknown
  
  Actual type of the given entity.
Parameters
- entity: Actual
  
  Entity to check.
Returns entity is Truthy<Actual>
true if is truthy, false if not.

isType

isType<Expected>(type: TypeOf): <Actual>(entity: Expected | Actual) => entity is Expected

- Defined in type/isType.ts:18
Takes a type string and checks if given entity is of that typeof.
example
```
const isTypeString = typeOf<string>("string");

isTypeString("value"); // true
isTypeString(1); // false
```
Type parameters
- Expected = unknown
  
  Expected type.
Parameters
- type: TypeOf
  
  Type to check (from typeof).
Returns <Actual>(entity: Expected | Actual) => entity is Expected
Curried function with type in context.
- - <Actual>(entity: Expected | Actual): entity is Expected
  - Type parameters
    - Actual = unknown
    Parameters
    - entity: Expected | Actual
    Returns entity is Expected

isUndefined

isUndefined<Actual>(entity: undefined | Actual): entity is undefined

- Defined in type/isUndefined.ts:6
Check if given entity is an instance of undefined.

Type parameters
- Actual = unknown
Parameters
- entity: undefined | Actual
Returns entity is undefined

jsonParsePromise

jsonParsePromise<Output>(text: string): Promise<Output>

- Defined in json/jsonParsePromise.ts:17
Takes a JSON string and parses it safely using a Promise.
example
```
jsonParsePromise("invalid")
    .then(console.log)
    .catch(console.error); // error
jsonParsePromise("{}")
    .then(console.log)
    .catch(console.error); // log
```
Type parameters
- Output = unknown
  
  Expected type if the parse is successful.
Parameters
- text: string
  
  String value to parse.
Returns Promise<Output>
Promise which resolves to an object of type Output.

jsonStringifyPromise

jsonStringifyPromise<Source>(source: Source): Promise<string>

- Defined in json/jsonStringifyPromise.ts:17
Takes an object and stringify to JSON safely using a Promise.
example
```
jsonStringifyPromise(circular)
    .then(console.log)
    .catch(console.error); // error
jsonStringifyPromise({})
    .then(console.log)
    .catch(console.error); // log
```
Type parameters
- Source
  
  Type of source object.
Parameters
- source: Source
  
  Source object.
Returns Promise<string>
Promise which resolves to a string or rejects with errors.

numberAdd

numberAdd(addend2: number): (addend1: number) => number

- Defined in number/numberAdd.ts:18
Takes a addend1 and addend2 and returns the precise addition of those values (uses DecimalTuple internally).
example
```
const addPoint1 = numberAdd(0.1);

addPoint1(0.2); // 0.3
```
Parameters
- addend2: number
  
  Second addend of the addition.
Returns (addend1: number) => number
Curried function with addend1 set in context.
- - (addend1: number): number
  - Parameters
    - addend1: number
    Returns number

numberBetween

numberBetween(minimum: number): (maximum: number) => (source: number) => boolean

Takes a minimum and maximum and returns a boolean if source number is between them.

example

const between0 = numberBetween(0);
const between0And10 = between0(10);

between0And10(5); // 5 because is inside the range (0-10).
between0And10(-1); // 0 because it was lower than the minimum (0).
between0And10(11); // 10 because it was higher than the maximum (10).

Parameters

minimum: number

Minimum boundary.

Returns (maximum: number) => (source: number) => boolean

Curried function with minimum in context.

- (maximum: number): (source: number) => boolean
- Parameters
  - maximum: number
  Returns (source: number) => boolean
  - - (source: number): boolean
    - Curried function with minimum set.
      
      example
      const between0And10 = between0(10); between0And10(5); // 5 because is inside the range (0-10). between0And10(-1); // 0 because it was lower than the minimum (0). between0And10(11); // 10 because it was higher than the maximum (10).
      Parameters
      - source: number
      Returns boolean
      Curried function with minimum and maximum set in context.

numberBoundary

numberBoundary(minimum: number): (maximum: number) => (source: number) => number

Takes a minimum and maximum and applies them to a given source number.

example

const boundaryFrom0 = numberBoundary(0);
const boundaryFrom0To10 = boundaryFrom0(10);

boundaryFrom0To10(5); // 5 because is inside the boundary (0-10)
boundaryFrom0To10(-1); // 0 because it was lower than the minimum (0).
boundaryFrom0To10(11); // 10 because it was higher than the maximum (10).

Parameters

minimum: number

Minimum boundary.

Returns (maximum: number) => (source: number) => number

Curried function with minimum set in context.

(maximum: number): (source: number) => number

Parameters

maximum: number

Returns (source: number) => number

(source: number): number

Curried function with minimum set.

example

const boundaryFrom0To10 = boundaryFrom0(10);

boundaryFrom0To10(5); // 5 because is inside the boundary (0-10)
boundaryFrom0To10(-1); // 0 because it was lower than the minimum (0).
boundaryFrom0To10(11); // 10 because it was higher than the maximum (10).

Parameters

source: number

Returns number

Curried function with minimum and maximum set in context.

numberDivide

numberDivide(divisor: number): (dividend: number) => number

- Defined in number/numberDivide.ts:18
Takes a divisor and dividend and returns the precise division of those values (uses DecimalTuple internally).
example
```
const half = numberDivide(2);

half(5); // 2.5
```
Parameters
- divisor: number
  
  Divisor of the division.
Returns (dividend: number) => number
Curried function with divisor set in context.
- - (dividend: number): number
  - Parameters
    - dividend: number
    Returns number

numberMultiply

numberMultiply(multiplier: number): (multiplicand: number) => number

- Defined in number/numberMultiply.ts:18
Takes a multiplier and multiplicand and returns the precise multiplication of those factors (uses DecimalTuple internally).
example
```
const double = numberMultiply(2);

double(0.5); // 1
```
Parameters
- multiplier: number
  
  Multiplier of the multiplication.
Returns (multiplicand: number) => number
Curried function with multiplier set in context.
- - (multiplicand: number): number
  - Parameters
    - multiplicand: number
    Returns number

numberSubtract

numberSubtract(subtrahend: number): (minuend: number) => number

- Defined in number/numberSubtract.ts:18
Takes a subtrahend and minuend and returns the precise subtraction of those values (uses DecimalTuple internally).
example
```
const subtractPoint1 = numberSubtract(0.1);

subtractPoint1(1); // 0.9
```
Parameters
- subtrahend: number
  
  Subtrahend of the subtraction.
Returns (minuend: number) => number
Curried function with subtrahend set in context.
- - (minuend: number): number
  - Parameters
    - minuend: number
    Returns number

numberToDecimalTuple

numberToDecimalTuple(source: number): DecimalTuple

- Defined in number/numberToDecimalTuple.ts:16
Takes a source number and returns a DecimalTuple [coefficient, exponent].
example
```
numberToDecimalTuple(Math.PI); // [3141592653589793, -15]
numberToDecimalTuple(5000); // [5, 3]
```
Parameters
- source: number
  
  Source number to be parsed into a DecimalTuple.
Returns DecimalTuple
DecimalTuple [coefficient, exponent].

numberToString

numberToString(radix: Radix): (source: number) => string

- Defined in number/numberToString.ts:15
Wrapper of Number.prototype.toString with mandatory radix.
example
```
numberToString(10)(10); // "10"
numberToString(16)(16); // "10"
numberToString(2)(2); // "10"
```
Parameters
- radix: Radix
  
  A value between 2 and 36 that specifies the base of the number.
Returns (source: number) => string
Curried function with radix in context.
- - (source: number): string
  - Parameters
    - source: number
    Returns string

numberToStringDecimal

numberToStringDecimal(source: number): string

- Defined in number/numberToStringDecimal.ts:14
Parses a number to a decimal string.
example
```
numberToStringDecimal(10); // "10"
numberToStringDecimal(0x10); // "16"
```
Parameters
- source: number
  
  Source number to be stringified.
Returns string
Stringified number.

numberToStringHexadecimal

numberToStringHexadecimal(source: number): string

- Defined in number/numberToStringHexadecimal.ts:14
Parses a number to a hexadecimal string.
example
```
numberToStringHexadecimal(16); // "10"
numberToStringHexadecimal(0x10); // "10"
```
Parameters
- source: number
  
  Source number to be stringified.
Returns string
Stringified number.

objectEntries

objectEntries<Source>(source: Source): Entries<Source>

- Defined in object/objectEntries.ts:15
Takes a source object and returns an entries array.
example
```
objectEntries({ key: "value" }); // [["key", "value"]]
objectEntries({ foo: "bar", number: 1 }); // [["foo", "bar"], ["number", 1]]
```
Type parameters
- Source
  
  Source object type.
Parameters
- source: Source
  
  Source object.
Returns Entries<Source>
Array of entries of the given source object.

objectFromEntries

objectFromEntries<Expected>(source: Entries<Expected>): Expected

- Defined in object/objectFromEntries.ts:18
Takes a source entries array and returns an object.
example
```
objectFromEntries([["key", "value"]]); // { key: "value" }
objectFromEntries([
    ["foo", "bar"],
    ["number", 1]
]); // { foo: "bar", number: 1 }
```
Type parameters
- Expected
  
  Expected object type.
Parameters
- source: Entries<Expected>
  
  Source entries array.
Returns Expected
Object resulting of given entries.

objectGetProperty

objectGetProperty<Property>(property: Property): <Source>(source: Source) => Source[Property]

- Defined in object/objectGetProperty.ts:14
Get value of given property for given source object.
example
```
const getFoo = objectGet("foo");
getFoo({ foo: 1 }); // 1
getFoo({ bar: 1 }); // undefined
```
Type parameters
- Property: string | number | symbol
  
  Type of the property.
Parameters
- property: Property
  
  Name of property.
Returns <Source>(source: Source) => Source[Property]
Curried function with property in context.
- - <Source>(source: Source): Source[Property]
  - Type parameters
    - Source: Record<string | number | symbol, unknown>
    Parameters
    - source: Source
    Returns Source[Property]

objectMap

objectMap<Input, Output>(mapper: Mapper<Entry<Input>, Entry<Output>>): (source: Input) => Output

- Defined in object/objectMap.ts:22
Takes a mapper function and applies it to given source object using objectEntries and objectFromEntries.
example
```
const mapDouble = objectMap(([key, value]) => [key, value * 2]);

mapDouble({ a: 0, b: 1, c: 2, d: 3 }); // { a: 0, b: 2, c: 4, d: 6 }
```
Type parameters
- Input
  
  Type of the input object.
- Output = Input
  
  Type of the output object.
Parameters
- mapper: Mapper<Entry<Input>, Entry<Output>>
  
  Mapper function.
Returns (source: Input) => Output
Curried function with mapper in context.
- - (source: Input): Output
  - Parameters
    - source: Input
    Returns Output

objectSetProperty

objectSetProperty<Property>(property: Property): <Value>(value: Value) => <Source>(source: Source) => Omit<Source, Property> & { readonly [ P in string | number | symbol]: Value }

- Defined in object/objectSetProperty.ts:14
Set value of given property in given source object.
example
```
const setFoo = objectSet("foo")("bar");
setFoo({ foo: 1 }); // { foo: "bar" }
setFoo({ bar: 1 }); // { bar: 1, foo: "bar" }
```
Type parameters
- Property: string | number | symbol
  
  Type of the property.
Parameters
- property: Property
  
  Name of property.
Returns <Value>(value: Value) => <Source>(source: Source) => Omit<Source, Property> & { readonly [ P in string | number | symbol]: Value }
Curried function with property in context.
- - <Value>(value: Value): <Source>(source: Source) => Omit<Source, Property> & { readonly [ P in string | number | symbol]: Value }
  - Type parameters
    - Value
    Parameters
    - value: Value
    Returns <Source>(source: Source) => Omit<Source, Property> & { readonly [ P in string | number | symbol]: Value }
    - - <Source>(source: Source): Omit<Source, Property> & { readonly [ P in string | number | symbol]: Value }
      - Type parameters
        Source: Record<string | number | symbol, unknown>
        Parameters
        source: Source
        Returns Omit<Source, Property> & { readonly [ P in string | number | symbol]: Value }

stringMapReplace

stringMapReplace(replaceMap: Readonly<Record<string, string | number>>): (source: string) => string

- Defined in string/stringMapReplace.ts:24
Takes StringReplaceMap object and runs a replaceAll of given object keys with it's values in the source string.
example
```
const leet = stringMapReplace({
    a: 4,
    e: 3,
    i: 1,
    o: 0
});

leet("hello there!"); // "h3ll0 th3r3!"
```
Parameters
- replaceMap: Readonly<Record<string, string | number>>
  
  Replace map for the string.
Returns (source: string) => string
Curried function with replaceMap in context.
- - (source: string): string
  - Parameters
    - source: string
    Returns string

stringMatches

stringMatches(regularExpression: Readonly<RegExp>): (source: string) => RegExpMatchArray

- Defined in string/stringMatches.ts:13
Takes a regular expression and a string and returns a RegExpMatchArray.
example
```
const matchesNumbers = stringTest(/\d/gu);
onlyHasNumbers("1234"); // ["1", "2", "3", "4"]
onlyHasNumbers("nope"); // []
```
Parameters
- regularExpression: Readonly<RegExp>
  
  Regular expression to match with.
Returns (source: string) => RegExpMatchArray
Curried function with regularExpression in context.
- - (source: string): RegExpMatchArray
  - Parameters
    - source: string
    Returns RegExpMatchArray

stringParseDecimal

stringParseDecimal(source: string): number

- Defined in string/stringParseDecimal.ts:14
Parses a string to a decimal value.
example
```
stringParseDecimal("10"); // 10
stringParseDecimal("0x10"); // 10
```
Parameters
- source: string
  
  Source string to be parsed.
Returns number
Parsed string.

stringParseHexadecimal

stringParseHexadecimal(source: string): number

- Defined in string/stringParseHexadecimal.ts:14
Parses a string to a hexadecimal value.
example
```
stringParseHexadecimal("10"); // 16 (0x10)
stringParseHexadecimal("0x10"); // 16 (0x10)
```
Parameters
- source: string
  
  Source string to be parsed.
Returns number
Parsed string.

stringParseNumber

stringParseNumber(radix: Radix): (source: string) => number

- Defined in string/stringParseNumber.ts:15
Wrapper of parseInt with mandatory radix.
example
```
stringParseNumber(10)("10"); // 10
stringParseNumber(16)("10"); // 16 (0x10)
stringParseNumber(2)("10"); // 2
```
Parameters
- radix: Radix
  
  A value between 2 and 36 that specifies the base of the number.
Returns (source: string) => number
Curried function with radix in context.
- - (source: string): number
  - Parameters
    - source: string
    Returns number

stringReverse

stringReverse(source: string): string

- Defined in string/stringReverse.ts:12
Takes a source string and returns that string reversed.
example
```
const oof = stringReverse("foo"); // off === "oof"
const rab = stringReverse("bar"); // rab === "rab"
```
Parameters
- source: string
  
  String to be reversed.
Returns string
Reversed string.

stringTest

stringTest(regularExpression: Readonly<RegExp>): (source: string) => boolean

- Defined in string/stringTest.ts:13
Takes a regular expression and a string and returns true if it matches.
example
```
const onlyHasNumbers = stringTest(/^\d+$/gu);
onlyHasNumbers("1234"); // true
onlyHasNumbers("nope"); // false
```
Parameters
- regularExpression: Readonly<RegExp>
  
  Regular expression to test with.
Returns (source: string) => boolean
Curried function with regularExpression in context.
- - (source: string): boolean
  - Parameters
    - source: string
    Returns boolean

Index

Type aliases

Functions

Type aliases

ArrayOrIterable

Type parameters

Item

DecimalTuple

Entries

Type parameters

Source

Entry

Type parameters

Source

Falsy

FilterTuple

Type parameters

Item

Filtered: Item = Item

Filterer

Type parameters

Item

Filtered: Item

Grouped

Type parameters

Item

Grouper

Type parameters

Item

Type declaration

Parameters

item: Item

Returns number | string

GuardedFilterer

Type parameters

Item

Filtered: Item

Type declaration

Parameters

item: Item

Returns item is Filtered

ImmutableRecord

Type parameters

Value = unknown

Key: number | string | symbol = number | string | symbol

Mapper

Type parameters

Item

Output

Type declaration

Parameters

item: Item

Returns Output

Nullish

OptionalExclude

Type parameters

Type

Exclusion

Radix

Reducer

Type parameters

Item

Output = ReadonlyArray<Item>

Type declaration

Parameters

accumulator: Output

Returns Mapper<Item, Output>

Sorter

Type parameters

Item

Type declaration

Parameters

next: Item

Returns Mapper<Item, number>

StringReplaceMap

Truthy

Type parameters

Actual = unknown

TypeOf

UnguardedFilterer