Endomorphism(deprecated)- FunctionN
- LazyArg
Predicate(deprecated)Refinement(deprecated)- SK
- absurd
- apply
- constFalse
- constNull
- constTrue
- constUndefined
- constVoid
- constant
- decrement
- flip
- flow
getEndomorphismMonoid(deprecated)- hole
- identity
- increment
not(deprecated)- pipe
- tuple
- tupled
- unsafeCoerce
- untupled
export declare const getBooleanAlgebra: <B>(B: BooleanAlgebra<B>) => <A = never>() => BooleanAlgebra<(a: A) => B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Unary functions form a monoid as long as you can provide a monoid for the codomain.
export declare const getMonoid: <M>(M: Monoid<M>) => <A = never>() => Monoid<(a: A) => M>
- Added in 0.1.0
import { Predicate } from '@fp-tx/core/Predicate'
import { getMonoid } from '@fp-tx/core/function'
import * as B from '@fp-tx/core/boolean'
const f: Predicate<number> = n => n <= 2
const g: Predicate<number> = n => n >= 0
const M1 = getMonoid(B.MonoidAll)<number>()
assert.deepStrictEqual(M1.concat(f, g)(1), true)
assert.deepStrictEqual(M1.concat(f, g)(3), false)
const M2 = getMonoid(B.MonoidAny)<number>()
assert.deepStrictEqual(M2.concat(f, g)(1), true)
assert.deepStrictEqual(M2.concat(f, g)(3), true)
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const getRing: <A, B>(R: Ring<B>) => Ring<(a: A) => B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Unary functions form a semigroup as long as you can provide a semigroup for the codomain.
export declare const getSemigroup: <S>(S: Semigroup<S>) => <A = never>() => Semigroup<(a: A) => S>
- Added in 0.1.0
import { Predicate, getSemigroup } from '@fp-tx/core/function'
import * as B from '@fp-tx/core/boolean'
const f: Predicate<number> = n => n <= 2
const g: Predicate<number> = n => n >= 0
const S1 = getSemigroup(B.SemigroupAll)<number>()
assert.deepStrictEqual(S1.concat(f, g)(1), true)
assert.deepStrictEqual(S1.concat(f, g)(3), false)
const S2 = getSemigroup(B.SemigroupAny)<number>()
assert.deepStrictEqual(S2.concat(f, g)(1), true)
assert.deepStrictEqual(S2.concat(f, g)(3), true)
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const getSemiring: <A, B>(S: Semiring<B>) => Semiring<(a: A) => B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Use LazyArg
instead.
export interface Lazy<A> {
(): A
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Use Endomorphism
module instead.
export interface Endomorphism<A> {
(a: A): A
}
- Added in 0.1.0
- Deprecated
- MIT – Copyright (c) 2017-present Giulio Canti
export interface FunctionN<A extends ReadonlyArray<unknown>, B> {
(...args: A): B
}
- Added in 0.1.0
import { FunctionN } from '@fp-tx/core/function'
export const sum: FunctionN<[number, number], number> = (a, b) => a + b
- MIT – Copyright (c) 2017-present Giulio Canti
A lazy argument.
export interface LazyArg<A> {
(): A
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Use Predicate
module instead.
export interface Predicate<A> {
(a: A): boolean
}
- Added in 0.1.0
- Deprecated
- MIT – Copyright (c) 2017-present Giulio Canti
Use Refinement
module instead.
export interface Refinement<A, B extends A> {
(a: A): a is B
}
- Added in 0.1.0
- Deprecated
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const SK: <A, B>(_: A, b: B) => B
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function absurd<A>(_: never): A
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const apply: <A>(a: A) => <B>(f: (a: A) => B) => B
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
A thunk that returns always false
.
export declare const constFalse: LazyArg<boolean>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
A thunk that returns always null
.
export declare const constNull: LazyArg<null>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
A thunk that returns always true
.
export declare const constTrue: LazyArg<boolean>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
A thunk that returns always undefined
.
export declare const constUndefined: LazyArg<undefined>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
A thunk that returns always void
.
export declare const constVoid: LazyArg<void>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function constant<A>(a: A): LazyArg<A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function decrement(n: number): number
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Flips the arguments of a curried function.
export declare function flip<A, B, C>(f: (a: A) => (b: B) => C): (b: B) => (a: A) => C
export declare function flip<A, B, C>(f: (a: A, b: B) => C): (b: B, a: A) => C
- Added in 0.1.0
import { flip } from '@fp-tx/core/function'
const f = (a: number) => (b: string) => a - b.length
assert.strictEqual(flip(f)('aaa')(2), -1)
- MIT – Copyright (c) 2017-present Giulio Canti
Performs left-to-right function composition. The first argument may have any arity, the remaining arguments must be unary.
See also pipe
.
export declare function flow<A extends ReadonlyArray<unknown>, B>(ab: (...a: A) => B): (...a: A) => B
export declare function flow<A extends ReadonlyArray<unknown>, B, C>(
ab: (...a: A) => B,
bc: (b: B) => C,
): (...a: A) => C
export declare function flow<A extends ReadonlyArray<unknown>, B, C, D>(
ab: (...a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
): (...a: A) => D
export declare function flow<A extends ReadonlyArray<unknown>, B, C, D, E>(
ab: (...a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
): (...a: A) => E
export declare function flow<A extends ReadonlyArray<unknown>, B, C, D, E, F>(
ab: (...a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
): (...a: A) => F
export declare function flow<A extends ReadonlyArray<unknown>, B, C, D, E, F, G>(
ab: (...a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
): (...a: A) => G
export declare function flow<A extends ReadonlyArray<unknown>, B, C, D, E, F, G, H>(
ab: (...a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
): (...a: A) => H
export declare function flow<A extends ReadonlyArray<unknown>, B, C, D, E, F, G, H, I>(
ab: (...a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
): (...a: A) => I
export declare function flow<A extends ReadonlyArray<unknown>, B, C, D, E, F, G, H, I, J>(
ab: (...a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
ij: (i: I) => J,
): (...a: A) => J
- Added in 0.1.0
import { flow } from '@fp-tx/core/function'
const len = (s: string): number => s.length
const double = (n: number): number => n * 2
const f = flow(len, double)
assert.strictEqual(f('aaa'), 6)
- MIT – Copyright (c) 2017-present Giulio Canti
Use Endomorphism
module instead.
export declare const getEndomorphismMonoid: <A = never>() => Monoid<Endomorphism<A>>
- Added in 0.1.0
- Deprecated
- MIT – Copyright (c) 2017-present Giulio Canti
Type hole simulation
export declare const hole: <T>() => T
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function identity<A>(a: A): A
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function increment(n: number): number
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Use Predicate
module instead.
export declare function not<A>(predicate: Predicate<A>): Predicate<A>
- Added in 0.1.0
- Deprecated
- MIT – Copyright (c) 2017-present Giulio Canti
Pipes the value of an expression into a pipeline of functions.
See also flow
.
export declare function pipe<A>(a: A): A
export declare function pipe<A, B, C, D, E, F, G, H, I, J>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
ij: (i: I) => J,
): J
export declare function pipe<A, B, C, D, E, F, G, H, I, J, K>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
ij: (i: I) => J,
jk: (j: J) => K,
): K
export declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
ij: (i: I) => J,
jk: (j: J) => K,
kl: (k: K) => L,
): L
export declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
ij: (i: I) => J,
jk: (j: J) => K,
kl: (k: K) => L,
lm: (l: L) => M,
): M
export declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
ij: (i: I) => J,
jk: (j: J) => K,
kl: (k: K) => L,
lm: (l: L) => M,
mn: (m: M) => N,
): N
export declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
ij: (i: I) => J,
jk: (j: J) => K,
kl: (k: K) => L,
lm: (l: L) => M,
mn: (m: M) => N,
no: (n: N) => O,
): O
export declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
ij: (i: I) => J,
jk: (j: J) => K,
kl: (k: K) => L,
lm: (l: L) => M,
mn: (m: M) => N,
no: (n: N) => O,
op: (o: O) => P,
): P
export declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
ij: (i: I) => J,
jk: (j: J) => K,
kl: (k: K) => L,
lm: (l: L) => M,
mn: (m: M) => N,
no: (n: N) => O,
op: (o: O) => P,
pq: (p: P) => Q,
): Q
export declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
ij: (i: I) => J,
jk: (j: J) => K,
kl: (k: K) => L,
lm: (l: L) => M,
mn: (m: M) => N,
no: (n: N) => O,
op: (o: O) => P,
pq: (p: P) => Q,
qr: (q: Q) => R,
): R
export declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
ij: (i: I) => J,
jk: (j: J) => K,
kl: (k: K) => L,
lm: (l: L) => M,
mn: (m: M) => N,
no: (n: N) => O,
op: (o: O) => P,
pq: (p: P) => Q,
qr: (q: Q) => R,
rs: (r: R) => S,
): S
export declare function pipe<A, B>(a: A, ab: (a: A) => B): B
export declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
ij: (i: I) => J,
jk: (j: J) => K,
kl: (k: K) => L,
lm: (l: L) => M,
mn: (m: M) => N,
no: (n: N) => O,
op: (o: O) => P,
pq: (p: P) => Q,
qr: (q: Q) => R,
rs: (r: R) => S,
st: (s: S) => T,
): T
export declare function pipe<A, B, C>(a: A, ab: (a: A) => B, bc: (b: B) => C): C
export declare function pipe<A, B, C, D>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D): D
export declare function pipe<A, B, C, D, E>(a: A, ab: (a: A) => B, bc: (b: B) => C, cd: (c: C) => D, de: (d: D) => E): E
export declare function pipe<A, B, C, D, E, F>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
): F
export declare function pipe<A, B, C, D, E, F, G>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
): G
export declare function pipe<A, B, C, D, E, F, G, H>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
): H
export declare function pipe<A, B, C, D, E, F, G, H, I>(
a: A,
ab: (a: A) => B,
bc: (b: B) => C,
cd: (c: C) => D,
de: (d: D) => E,
ef: (e: E) => F,
fg: (f: F) => G,
gh: (g: G) => H,
hi: (h: H) => I,
): I
- Added in 0.1.0
import { pipe } from '@fp-tx/core/function'
const len = (s: string): number => s.length
const double = (n: number): number => n * 2
// without pipe
assert.strictEqual(double(len('aaa')), 6)
// with pipe
assert.strictEqual(pipe('aaa', len, double), 6)
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function tuple<T extends ReadonlyArray<any>>(...t: T): T
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Creates a tupled version of this function: instead of n
arguments, it accepts a single tuple argument.
export declare function tupled<A extends ReadonlyArray<unknown>, B>(f: (...a: A) => B): (a: A) => B
- Added in 0.1.0
import { tupled } from '@fp-tx/core/function'
const add = tupled((x: number, y: number): number => x + y)
assert.strictEqual(add([1, 2]), 3)
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const unsafeCoerce: <A, B>(a: A) => B
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Inverse function of tupled
export declare function untupled<A extends ReadonlyArray<unknown>, B>(f: (a: A) => B): (...a: A) => B
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti