tiny-fp

Table of contents

Functions

• append
• curry
• debounce
• divide
• groupBy
• head
• includes
• isArray
• isEmpty
• isEqual
• isFloat
• isInteger
• isNotEmpty
• isObject
• isRecord
• isString
• last
• maybe
• modulo
• multiply
• noop
• not
• or
• pick
• pipe
• prepend
• prop
• random
• reorderArray
• skip
• sleep
• sum
• trace
• unique
• updateArray

Functions

append

▸ Constappend(...props: any): any

Parameters:

Name	Type
...props	any

Returns: any

Defined in: append.ts:4

---

curry

▸ curry(fn: any): function

Parameters:

Name	Type
fn	any

Returns: (...props: any) => any

Defined in: curry.ts:1

---

debounce

▸ Constdebounce<T>(fn: T, ms: number, immediate: boolean): function

Type parameters:

Name	Type
T	WrapperFn

Parameters:

Name	Type
fn	T
ms	number
immediate	boolean

Returns: (...args: Parameters<T>) => void

Defined in: debounce.ts:3

---

divide

▸ Constdivide(...props: any): any

Parameters:

Name	Type
...props	any

Returns: any

Defined in: divide.ts:3

---

groupBy

▸ ConstgroupBy<T>(list: T[], key: keyof T): Record<string, T[]>

Type parameters:

Name
T

Parameters:

Name	Type
list	T[]
key	keyof T

Returns: Record<string, T[]>

Defined in: groupBy.ts:1

---

head

▸ Consthead<T>(x: T[]): T

Type parameters:

Name
T

Parameters:

Name	Type
x	T[]

Returns: T

Defined in: head.ts:8

▸ Consthead(x: String): String

Parameters:

Name	Type
x	String

Returns: String

Defined in: head.ts:8

---

includes

▸ Constincludes(...props: any): any

Parameters:

Name	Type
...props	any

Returns: any

Defined in: includes.ts:3

---

isArray

▸ ConstisArray(item: any): boolean

Parameters:

Name	Type
item	any

Returns: boolean

Defined in: isArray.ts:1

---

isEmpty

▸ ConstisEmpty(target: any): boolean

Parameters:

Name	Type
target	any

Returns: boolean

Defined in: isEmpty.ts:5

---

isEqual

▸ ConstisEqual(...props: any): any

Parameters:

Name	Type
...props	any

Returns: any

Defined in: isEqual.ts:4

---

isFloat

▸ ConstisFloat(n: any): boolean

Parameters:

Name	Type
n	any

Returns: boolean

Defined in: isFloat.ts:1

---

isInteger

▸ ConstisInteger(n: any): boolean

Parameters:

Name	Type
n	any

Returns: boolean

Defined in: isInteger.ts:1

---

isNotEmpty

▸ ConstisNotEmpty(value: any): boolean

Parameters:

Name	Type
value	any

Returns: boolean

Defined in: isNotEmpty.ts:3

---

isObject

▸ ConstisObject<Candidate>(value: Candidate): boolean

Type parameters:

Name
Candidate

Parameters:

Name	Type
value	Candidate

Returns: boolean

Defined in: isObject.ts:1

---

isRecord

▸ ConstisRecord(value: any): boolean

Parameters:

Name	Type
value	any

Returns: boolean

Defined in: isRecord.ts:1

---

isString

▸ ConstisString(someElement: any): boolean

Parameters:

Name	Type
someElement	any

Returns: boolean

Defined in: isString.ts:1

---

last

▸ Constlast<T>(x: T[]): T

Type parameters:

Name
T

Parameters:

Name	Type
x	T[]

Returns: T

Defined in: last.ts:8

▸ Constlast(x: String): String

Parameters:

Name	Type
x	String

Returns: String

Defined in: last.ts:8

---

maybe

▸ Constmaybe<F>(someValue: F): Maybe<F>

Type parameters:

Name
F

Parameters:

Name	Type
someValue	F

Returns: Maybe<F>

Defined in: maybe.ts:43

---

modulo

▸ Constmodulo(...props: any): any

Parameters:

Name	Type
...props	any

Returns: any

Defined in: modulo.ts:3

---

multiply

▸ Constmultiply(...props: any): any

Parameters:

Name	Type
...props	any

Returns: any

Defined in: multiply.ts:3

---

noop

▸ Constnoop(): undefined

Returns: undefined

Defined in: noop.ts:1

---

not

▸ Constnot<T>(entity: T): boolean

Type parameters:

Name
T

Parameters:

Name	Type
entity	T

Returns: boolean

Defined in: not.ts:1

---

or

▸ Constor(...props: any): any

Parameters:

Name	Type
...props	any

Returns: any

Defined in: or.ts:3

---

pick

▸ Constpick<T, K>(targetObj: T, requiredFieldsArr: K[]): Pick<T, K>

Type parameters:

Name	Type
T	-
K	string | number | symbol

Parameters:

Name	Type
targetObj	T
requiredFieldsArr	K[]

Returns: Pick<T, K>

Defined in: pick.ts:1

---

pipe

▸ Constpipe<T, R>(fn1: (...args: T) => R, ...fns: (a: R) => R[]): function

Type parameters:

Name	Type
T	any[]
R	-

Parameters:

Name	Type
fn1	(...args: T) => R
...fns	(a: R) => R[]

Returns: (...args: T) => R

Defined in: pipe.ts:1

---

prepend

▸ Constprepend(...props: any): any

Parameters:

Name	Type
...props	any

Returns: any

Defined in: prepend.ts:4

---

prop

▸ Constprop(...props: any): any

Parameters:

Name	Type
...props	any

Returns: any

Defined in: prop.ts:3

---

random

▸ Constrandom<T>(a: T[]): T

Type parameters:

Name
T

Parameters:

Name	Type
a	T[]

Returns: T

Defined in: random.ts:13

▸ Constrandom(a: number, b: number): number

Parameters:

Name	Type
a	number
b	number

Returns: number

Defined in: random.ts:13

---

reorderArray

▸ ConstreorderArray<T>(__namedParameters: { items: T[] ; newIndex: number ; oldIndex: number }): (undefined | T)[]

Type parameters:

Name
T

Parameters:

Name	Type
__namedParameters	object
__namedParameters.items	T[]
__namedParameters.newIndex	number
__namedParameters.oldIndex	number

Returns: (undefined | T)[]

Defined in: reorderArray.ts:1

---

skip

▸ Constskip<P>(times?: number, targetFn: Function): function

Type parameters:

Name
P

Parameters:

Name	Type	Default value
times	number	1
targetFn	Function	-

Returns: (...props: P[]) => void

Defined in: skip.ts:1

---

sleep

▸ Constsleep(ms: number): Promise<unknown>

Parameters:

Name	Type
ms	number

Returns: Promise<unknown>

Defined in: sleep.ts:1

---

sum

▸ Constsum(...props: any): any

Parameters:

Name	Type
...props	any

Returns: any

Defined in: sum.ts:3

---

trace

▸ Consttrace<P>(property: P): P

Type parameters:

Name
P

Parameters:

Name	Type
property	P

Returns: P

Defined in: trace.ts:1

---

unique

▸ Constunique(items: any[], cb?: Function): any[]

Parameters:

Name	Type
items	any[]
cb	Function

Returns: any[]

Defined in: unique.ts:1

---

updateArray

▸ ConstupdateArray<T>(targetArr: T[], index: number, newValue: T): T[]

Type parameters:

Name
T

Parameters:

Name	Type
targetArr	T[]
index	number
newValue	T

Returns: T[]

Defined in: updateArray.ts:1