// Type definitions for ramda 0.26 // Project: https://ramdajs.com // Definitions by: Scott O'Malley // Erwin Poeze // Matt DeKrey // Matt Dziuban // Stephen King // Alejandro Fernandez Haro // Vítor Castro // Jordan Quagliatini // Simon Højberg // Samson Keung // Angelo Ocana // Rayner Pupo // Nikita Moshensky // Ethan Resnick // Tomas Szabo // Maciek Blim // Marcin Biernat // Rayhaneh Banyassady // Ryan McCuaig // Drew Wyatt // John Ottenlips // Nitesh Phadatare // Krantisinh Deshmukh // Pierre-Antoine Mills // Brekk Bockrath // Aram Kharazyan // Jituan Lin // Philippe Mills // Saul Mirone // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 3.5 import * as _ from "ts-toolbelt"; import { Arity0Fn, Arity1Fn, Arity2Fn, AssocPartialOne, ComposeWithFns, Dictionary, Evolvable, Evolve, Evolver, Filter, Functor, KeyValuePair, Lens, Merge, MergeAll, ObjPred, Ord, Path, Placeholder, Pred, PipeWithFns, Reduced, SafePred, ValueOfRecord, } from "./tools"; export * from './tools'; /** * Placeholder. When used with functions like curry, or op, the second argument is applied to the second * position, and it returns a function waiting for its first argument. */ export const __: Placeholder; /* This is used in examples throughout the docs, but I it only seems to be directly explained here: https://ramdajs.com/0.9/docs/#op */ /** * Adds two numbers (or strings). Equivalent to a + b but curried. */ export function add(a: number, b: number): number; export function add(a: string, b: string): string; export function add(a: number): (b: number) => number; export function add(a: string): (b: string) => string; /** * Creates a new list iteration function from an existing one by adding two new parameters to its callback * function: the current index, and the entire list. */ export function addIndex(fn: (f: (item: T) => U, list: readonly T[]) => U[]): _.F.Curry<(a: (item: T, idx: number, list?: T[]) => U, b: readonly T[]) => U[]>; /* Special case for forEach */ export function addIndex(fn: (f: (item: T) => void, list: readonly T[]) => T[]): _.F.Curry<(a: (item: T, idx: number, list?: T[]) => void, b: readonly T[]) => T[]>; /* Special case for reduce */ export function addIndex(fn: (f: (acc: U, item: T) => U, aci: U, list: readonly T[]) => U): _.F.Curry<(a: (acc: U, item: T, idx: number, list?: T[]) => U, b: U, c: readonly T[]) => U>; /** * Applies a function to the value at the given index of an array, returning a new copy of the array with the * element at the given index replaced with the result of the function application. */ export function adjust(index: number, fn: (a: T) => T, list: readonly T[]): T[]; export function adjust(index: number, fn: (a: T) => T): (list: readonly T[]) => T[]; /** * Returns true if all elements of the list match the predicate, false if there are any that don't. */ export function all(fn: (a: T) => boolean, list: readonly T[]): boolean; export function all(fn: (a: T) => boolean): (list: readonly T[]) => boolean; /** * Given a list of predicates, returns a new predicate that will be true exactly when all of them are. */ export function allPass(preds: readonly Pred[]): Pred; /** * Returns a function that always returns the given value. */ export function always(val: T): () => T; /** * A function that returns the first argument if it's falsy otherwise the second argument. Note that this is * NOT short-circuited, meaning that if expressions are passed they are both evaluated. */ export function and any); } | number | boolean | string | null>(fn1: T, val2: any): boolean; export function and any); } | number | boolean | string | null>(fn1: T): (val2: any) => boolean; /** * Returns true if at least one of elements of the list match the predicate, false otherwise. */ export function any(fn: (a: T) => boolean, list: readonly T[]): boolean; export function any(fn: (a: T) => boolean): (list: readonly T[]) => boolean; /** * Given a list of predicates returns a new predicate that will be true exactly when any one of them is. */ export function anyPass(preds: Array>): SafePred; /** * ap applies a list of functions to a list of values. */ export function ap(fns: Array<((a: T) => U)>, vs: readonly T[]): U[]; export function ap(fns: Array<((a: T) => U)>): (vs: readonly T[]) => U[]; export function ap( fn: (x1: X1, x0: X0) => R, fn1: (x1: X1) => X0 ): (x1: X1) => R; /** * Returns a new list, composed of n-tuples of consecutive elements If n is greater than the length of the list, * an empty list is returned. */ export function aperture(n: 1, list: readonly T[]): Array<[T]>; export function aperture(n: 2, list: readonly T[]): Array<[T, T]>; export function aperture(n: 3, list: readonly T[]): Array<[T, T, T]>; export function aperture(n: 4, list: readonly T[]): Array<[T, T, T, T]>; export function aperture(n: 5, list: readonly T[]): Array<[T, T, T, T, T]>; export function aperture(n: 6, list: readonly T[]): Array<[T, T, T, T, T, T]>; export function aperture(n: 7, list: readonly T[]): Array<[T, T, T, T, T, T, T]>; export function aperture(n: 8, list: readonly T[]): Array<[T, T, T, T, T, T, T, T]>; export function aperture(n: 9, list: readonly T[]): Array<[T, T, T, T, T, T, T, T, T]>; export function aperture(n: 10, list: readonly T[]): Array<[T, T, T, T, T, T, T, T, T, T]>; export function aperture(n: number, list: readonly T[]): T[][]; export function aperture(n: number): (list: readonly T[]) => T[][]; /** * Returns a new list containing the contents of the given list, followed by the given element. */ export function append(el: T, list: readonly T[]): T[]; export function append(el: T): (list: readonly T[]) => T[]; /** * Applies function fn to the argument list args. This is useful for creating a fixed-arity function from * a variadic function. fn should be a bound function if context is significant. */ export function apply(fn: (arg0: T, ...args: readonly T[]) => TResult, args: readonly U[]): TResult; export function apply(fn: (arg0: T, ...args: readonly T[]) => TResult): (args: readonly U[]) => TResult; /** * Given a spec object recursively mapping properties to functions, creates a function producing an object * of the same structure, by mapping each property to the result of calling its associated function with * the supplied arguments. */ export function applySpec any>>( obj: Obj ): ( ...args: Parameters> ) => { [Key in keyof Obj]: ReturnType }; export function applySpec(obj: any): (...args: readonly any[]) => T; /** * Takes a value and applies a function to it. * This function is also known as the thrush combinator. */ export function applyTo(el: T, fn: (t: T) => U): U; export function applyTo(el: T): (fn: (t: T) => U) => U; /** * Makes an ascending comparator function out of a function that returns a value that can be compared with < and >. */ export function ascend(fn: (obj: T) => any, a: T, b: T): number; export function ascend(fn: (obj: T) => any): (a: T, b: T) => number; /** * Makes a shallow clone of an object, setting or overriding the specified property with the given value. */ export function assoc(__: Placeholder, val: T, obj: U): (prop: K) => Record & U; export function assoc(prop: K, __: Placeholder, obj: U): (val: T) => Record & U; export function assoc(prop: K, val: T, obj: U): Record & U; export function assoc(prop: K, val: T): (obj: U) => Record & U; export function assoc(prop: K): AssocPartialOne; /** * Makes a shallow clone of an object, setting or overriding the nodes required to create the given path, and * placing the specific value at the tail end of that path. */ export function assocPath(__: Placeholder, val: T, obj: U): (path: Path) => U; export function assocPath(path: Path, __: Placeholder, obj: U): (val: T) => U; export function assocPath(path: Path, val: T, obj: U): U; export function assocPath(path: Path, val: T): (obj: U) => U; export function assocPath(path: Path): _.F.Curry<(a: T, b: U) => U>; /** * Wraps a function of any arity (including nullary) in a function that accepts exactly 2 * parameters. Any extraneous parameters will not be passed to the supplied function. */ export function binary(fn: (...args: readonly any[]) => any): (...a: readonly any[]) => any; /** * Creates a function that is bound to a context. Note: R.bind does not provide the additional argument-binding * capabilities of Function.prototype.bind. */ export function bind(fn: (...args: readonly any[]) => any, thisObj: T): (...args: readonly any[]) => any; /** * A function wrapping calls to the two functions in an && operation, returning the result of the first function * if it is false-y and the result of the second function otherwise. Note that this is short-circuited, meaning * that the second function will not be invoked if the first returns a false-y value. */ export function both(pred1: Pred, pred2: Pred): Pred; export function both(pred1: Pred): (pred2: Pred) => Pred; /** * Returns the result of calling its first argument with the remaining arguments. This is occasionally useful * as a converging function for R.converge: the left branch can produce a function while the right branch * produces a value to be passed to that function as an argument. */ export function call(fn: (...args: readonly any[]) => (...args: readonly any[]) => any, ...args: readonly any[]): any; /** * `chain` maps a function over a list and concatenates the results. * This implementation is compatible with the Fantasy-land Chain spec */ export function chain(fn: (n: T) => readonly U[], list: readonly T[]): U[]; export function chain(fn: (n: T) => readonly U[]): (list: readonly T[]) => U[]; export function chain(fn: (x0: X0, x1: X1) => R, fn1: (x1: X1) => X0): (x1: X1) => R; /** * Restricts a number to be within a range. * Also works for other ordered types such as Strings and Date */ export function clamp(min: T, max: T, value: T): T; export function clamp(min: T, max: T): (value: T) => T; export function clamp(min: T): (max: T, value: T) => T; export function clamp(min: T): (max: T) => (value: T) => T; /** * Creates a deep copy of the value which may contain (nested) Arrays and Objects, Numbers, Strings, Booleans and Dates. */ export function clone(value: T): T; export function clone(value: readonly T[]): T[]; /** * Makes a comparator function out of a function that reports whether the first element is less than the second. */ // comparator(pred: (a: any, b: any) => boolean): (x: number, y: number) => number; export function comparator(pred: (a: T, b: T) => boolean): (x: T, y: T) => number; /** * Takes a function f and returns a function g such that: * - applying g to zero or more arguments will give true if applying the same arguments to f gives * a logical false value; and * - applying g to zero or more arguments will give false if applying the same arguments to f gives * a logical true value. */ export function complement(pred: (...args: readonly any[]) => boolean): (...args: readonly any[]) => boolean; /** * Performs right-to-left function composition. The rightmost function may have any arity; the remaining * functions must be unary. */ // generic rest parameters in TS 3.0 allows writing a single variant for any number of Vx // compose(fn0: (...args: V) => T1): (...args: V) => T1; // compose(fn1: (x: T1) => T2, fn0: (...args: V) => T1): (...args: V) => T2; // but requiring TS>=3.0 sounds like a breaking change, so just leaving a comment for the future // tslint:disable:max-line-length export function compose(fn0: () => T1): () => T1; export function compose(fn0: (x0: V0) => T1): (x0: V0) => T1; export function compose(fn0: (x0: V0, x1: V1) => T1): (x0: V0, x1: V1) => T1; export function compose(fn0: (x0: V0, x1: V1, x2: V2) => T1): (x0: V0, x1: V1, x2: V2) => T1; export function compose(fn1: (x: T1) => T2, fn0: () => T1): () => T2; export function compose(fn1: (x: T1) => T2, fn0: (x0: V0) => T1): (x0: V0) => T2; export function compose(fn1: (x: T1) => T2, fn0: (x0: V0, x1: V1) => T1): (x0: V0, x1: V1) => T2; export function compose(fn1: (x: T1) => T2, fn0: (x0: V0, x1: V1, x2: V2) => T1): (x0: V0, x1: V1, x2: V2) => T2; export function compose(fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: () => T1): () => T3; export function compose(fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: (x: V0) => T1): (x: V0) => T3; export function compose(fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: (x0: V0, x1: V1) => T1): (x0: V0, x1: V1) => T3; export function compose(fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: (x0: V0, x1: V1, x2: V2) => T1): (x0: V0, x1: V1, x2: V2) => T3; export function compose(fn3: (x: T3) => T4, fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: () => T1): () => T4; export function compose(fn3: (x: T3) => T4, fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: (x: V0) => T1): (x: V0) => T4; export function compose(fn3: (x: T3) => T4, fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: (x0: V0, x1: V1) => T1): (x0: V0, x1: V1) => T4; export function compose(fn3: (x: T3) => T4, fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: (x0: V0, x1: V1, x2: V2) => T1): (x0: V0, x1: V1, x2: V2) => T4; export function compose(fn4: (x: T4) => T5, fn3: (x: T3) => T4, fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: () => T1): () => T5; export function compose(fn4: (x: T4) => T5, fn3: (x: T3) => T4, fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: (x: V0) => T1): (x: V0) => T5; export function compose(fn4: (x: T4) => T5, fn3: (x: T3) => T4, fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: (x0: V0, x1: V1) => T1): (x0: V0, x1: V1) => T5; export function compose(fn4: (x: T4) => T5, fn3: (x: T3) => T4, fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: (x0: V0, x1: V1, x2: V2) => T1): (x0: V0, x1: V1, x2: V2) => T5; export function compose(fn5: (x: T5) => T6, fn4: (x: T4) => T5, fn3: (x: T3) => T4, fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: () => T1): () => T6; export function compose(fn5: (x: T5) => T6, fn4: (x: T4) => T5, fn3: (x: T3) => T4, fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: (x: V0) => T1): (x: V0) => T6; export function compose(fn5: (x: T5) => T6, fn4: (x: T4) => T5, fn3: (x: T3) => T4, fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: (x0: V0, x1: V1) => T1): (x0: V0, x1: V1) => T6; export function compose(fn5: (x: T5) => T6, fn4: (x: T4) => T5, fn3: (x: T3) => T4, fn2: (x: T2) => T3, fn1: (x: T1) => T2, fn0: (x0: V0, x1: V1, x2: V2) => T1): (x0: V0, x1: V1, x2: V2) => T6; // tslint:enable:max-line-length /** * Returns the right-to-left Kleisli composition of the provided functions, each of which must return a value of a type supported by chain. * The typings only support arrays for now. * All functions must be unary. * R.composeK(h, g, f) is equivalent to R.compose(R.chain(h), R.chain(g), f). * * @deprecated since 0.26 in favor of composeWith(chain) */ // tslint:disable:max-line-length export function composeK(fn0: (x0: V0) => T1[]): (x0: V0) => T1[]; export function composeK(fn1: (x: T1) => T2[], fn0: (x0: V0) => T1[]): (x0: V0) => T2[]; export function composeK(fn2: (x: T2) => T3[], fn1: (x: T1) => T2[], fn0: (x: V0) => T1[]): (x: V0) => T3[]; export function composeK(fn3: (x: T3) => T4[], fn2: (x: T2) => T3[], fn1: (x: T1) => T2[], fn0: (x: V0) => T1[]): (x: V0) => T4[]; export function composeK(fn4: (x: T4) => T5[], fn3: (x: T3) => T4[], fn2: (x: T2) => T3[], fn1: (x: T1) => T2[], fn0: (x: V0) => T1[]): (x: V0) => T5[]; export function composeK(fn5: (x: T5) => T6[], fn4: (x: T4) => T5[], fn3: (x: T3) => T4[], fn2: (x: T2) => T3[], fn1: (x: T1) => T2[], fn0: (x: V0) => T1[]): (x: V0) => T6[]; // tslint:enable:max-line-length /** * Performs right-to-left composition of one or more Promise-returning functions. * All functions must be unary. * * @deprecated since 0.26 in favor of composeWith(then) */ // tslint:disable:max-line-length export function composeP(fn0: (x0: V0) => Promise): (x0: V0) => Promise; export function composeP(fn1: (x: T1) => Promise, fn0: (x0: V0) => Promise): (x0: V0) => Promise; export function composeP(fn2: (x: T2) => Promise, fn1: (x: T1) => Promise, fn0: (x: V0) => Promise): (x: V0) => Promise; export function composeP(fn3: (x: T3) => Promise, fn2: (x: T2) => Promise, fn1: (x: T1) => Promise, fn0: (x: V0) => Promise): (x: V0) => Promise; export function composeP(fn4: (x: T4) => Promise, fn3: (x: T3) => Promise, fn2: (x: T2) => Promise, fn1: (x: T1) => Promise, fn0: (x: V0) => Promise): (x: V0) => Promise; export function composeP(fn5: (x: T5) => Promise, fn4: (x: T4) => Promise, fn3: (x: T3) => Promise, fn2: (x: T2) => Promise, fn1: (x: T1) => Promise, fn0: (x: V0) => Promise): (x: V0) => Promise; // tslint:enable:max-line-length /** * Performs right-to-left function composition using transforming function. * With the current typings, all functions must be unary. */ export function composeWith(composer: (a: any) => any, fns: ComposeWithFns): (x0: V0) => T; export function composeWith(composer: (a: any) => any): (fns: ComposeWithFns) => (x: V0) => T; /** * Returns a new list consisting of the elements of the first list followed by the elements * of the second. */ export function concat(placeholder: Placeholder): (list2: readonly T[], list1: readonly T[]) => T[]; export function concat(placeholder: Placeholder, list2: readonly T[]): (list1: readonly T[]) => T[]; export function concat(list1: readonly T[], list2: readonly T[]): T[]; export function concat(list1: readonly T[]): (list2: readonly T[]) => T[]; export function concat(list1: string, list2: string): string; export function concat(list1: string): (list2: string) => string; /** * Returns a function, fn, which encapsulates if/else-if/else logic. R.cond takes a list of [predicate, transform] pairs. * All of the arguments to fn are applied to each of the predicates in turn until one returns a "truthy" value, at which * point fn returns the result of applying its arguments to the corresponding transformer. If none of the predicates * matches, fn returns undefined. */ export function cond(fns: Array<[Pred, (...a: readonly any[]) => any]>): (...a: readonly any[]) => any; export function cond(fns: Array<[SafePred, (...a: readonly A[]) => B]>): (...a: readonly A[]) => B; /** * Wraps a constructor function inside a curried function that can be called with the same arguments and returns the same type. */ export function construct(constructor: { new(...a: A): T } | ((...a: A) => T)): (...a: A) => T; /** * Wraps a constructor function inside a curried function that can be called with the same arguments and returns the same type. * The arity of the function returned is specified to allow using variadic constructor functions. */ export function constructN(n: number, constructor: { new(...a: A): T } | ((...a: A) => T)): (...a: Partial) => T; /** * Returns `true` if the specified item is somewhere in the list, `false` otherwise. * Equivalent to `indexOf(a)(list) > -1`. Uses strict (`===`) equality checking. * * @deprecated since 0.26 in favor of includes */ export function contains(__: Placeholder, list: string): (a: string) => boolean; export function contains(__: Placeholder, list: readonly T[]): (a: T) => boolean; export function contains(__: Placeholder): (list: string, a: string) => boolean; export function contains(__: Placeholder): (list: readonly T[], a: T) => boolean; export function contains(a: string, list: string): boolean; export function contains(a: T, list: readonly T[]): boolean; export function contains(a: string): (list: string) => boolean; export function contains(a: T): (list: readonly T[]) => boolean; /** * Accepts a converging function and a list of branching functions and returns a new * function. When invoked, this new function is applied to some arguments, each branching * function is applied to those same arguments. The results of each branching function * are passed as arguments to the converging function to produce the return value. */ export function converge(after: ((...a: readonly any[]) => any), fns: Array<((...a: readonly any[]) => any)>): (...a: readonly any[]) => any; /** * Counts the elements of a list according to how many match each value * of a key generated by the supplied function. Returns an object * mapping the keys produced by `fn` to the number of occurrences in * the list. Note that all keys are coerced to strings because of how * JavaScript objects work. */ export function countBy(fn: (a: T) => string | number, list: readonly T[]): { [index: string]: number }; export function countBy(fn: (a: T) => string | number): (list: readonly T[]) => { [index: string]: number }; /** * Returns a curried equivalent of the provided function. The curried function has two unusual capabilities. * First, its arguments needn't be provided one at a time. */ export function curry any>(f: F): _.F.Curry; /** * Returns a curried equivalent of the provided function, with the specified arity. The curried function has * two unusual capabilities. First, its arguments needn't be provided one at a time. */ export function curryN(length: number, fn: (...args: readonly any[]) => any): (...a: readonly any[]) => any; /** * Decrements its argument. */ export function dec(n: number): number; /** * Returns the second argument if it is not null or undefined. If it is null or undefined, the * first (default) argument is returned. */ export function defaultTo(a: T, b: U | null | undefined): T | U; export function defaultTo(a: T): (b: U | null | undefined) => T | U; /** * Makes a descending comparator function out of a function that returns a value that can be compared with < and >. */ export function descend(fn: (obj: T) => any, a: T, b: T): number; export function descend(fn: (obj: T) => any): (a: T, b: T) => number; /** * Finds the set (i.e. no duplicates) of all elements in the first list not contained in the second list. */ export function difference(list1: readonly T[], list2: readonly T[]): T[]; export function difference(list1: readonly T[]): (list2: readonly T[]) => T[]; /** * Finds the set (i.e. no duplicates) of all elements in the first list not contained in the second list. * Duplication is determined according to the value returned by applying the supplied predicate to two list * elements. */ export function differenceWith(pred: (a: T1, b: T2) => boolean, list1: readonly T1[], list2: readonly T2[]): T1[]; export function differenceWith(pred: (a: T1, b: T2) => boolean): (list1: readonly T1[], list2: readonly T2[]) => T1[]; export function differenceWith(pred: (a: T1, b: T2) => boolean, list1: readonly T1[]): (list2: readonly T2[]) => T1[]; /* * Returns a new object that does not contain a prop property. */ // It seems impossible to infer the return type, so this may to be specified explicitely export function dissoc(prop: string, obj: any): T; export function dissoc(prop: string): (obj: any) => U; /** * Makes a shallow clone of an object, omitting the property at the given path. */ export function dissocPath(path: Path, obj: any): T; export function dissocPath(path: Path): (obj: any) => T; /** * Divides two numbers. Equivalent to a / b. */ export function divide(__: Placeholder, b: number): (a: number) => number; export function divide(__: Placeholder): (b: number, a: number) => number; export function divide(a: number, b: number): number; export function divide(a: number): (b: number) => number; /** * Returns a new list containing all but the first n elements of the given list. */ export function drop(n: number, xs: readonly T[]): T[]; export function drop(n: number, xs: string): string; export function drop(n: number): { (xs: string): string; (xs: readonly T[]): T[]; }; /** * Returns a list containing all but the last n elements of the given list. */ export function dropLast(n: number, xs: readonly T[]): T[]; export function dropLast(n: number, xs: string): string; export function dropLast(n: number): { (xs: readonly T[]): T[]; (xs: string): string; }; /** * Returns a new list containing all but last then elements of a given list, passing each value from the * right to the supplied predicate function, skipping elements while the predicate function returns true. */ export function dropLastWhile(fn: (a: T) => boolean, list: readonly T[]): T[]; export function dropLastWhile(fn: (a: T) => boolean): (list: readonly T[]) => T[]; /** * Returns a new list without any consecutively repeating elements. R.equals is used to determine equality. */ export function dropRepeats(list: readonly T[]): T[]; /** * Returns a new list without any consecutively repeating elements. * Equality is determined by applying the supplied predicate to each pair of consecutive elements. * The first element in a series of equal elements will be preserved. */ export function dropRepeatsWith(predicate: (left: T, right: T) => boolean, list: readonly T[]): T[]; export function dropRepeatsWith(predicate: (left: T, right: T) => boolean): (list: readonly T[]) => T[]; /** * Returns a new list containing the last n elements of a given list, passing each value to the supplied * predicate function, skipping elements while the predicate function returns true. */ export function dropWhile(fn: (a: T) => boolean, list: readonly T[]): T[]; export function dropWhile(fn: (a: T) => boolean): (list: readonly T[]) => T[]; /** * A function wrapping calls to the two functions in an || operation, returning the result of the first * function if it is truth-y and the result of the second function otherwise. Note that this is * short-circuited, meaning that the second function will not be invoked if the first returns a truth-y value. */ export function either(pred1: Pred, pred2: Pred): Pred; export function either(pred1: Pred): (pred2: Pred) => Pred; /** * Returns the empty value of its argument's type. Ramda defines the empty value of Array ([]), Object ({}), * String (''), and Arguments. Other types are supported if they define .empty and/or .prototype.empty. * Dispatches to the empty method of the first argument, if present. */ export function empty(x: T): T; /** * Checks if a list ends with the provided values */ export function endsWith(a: string, list: string): boolean; export function endsWith(a: string): (list: string) => boolean; export function endsWith(a: T | readonly T[], list: readonly T[]): boolean; export function endsWith(a: T | readonly T[]): (list: readonly T[]) => boolean; /** * Takes a function and two values in its domain and returns true if the values map to the same value in the * codomain; false otherwise. */ export function eqBy(fn: (a: T) => U, a: T, b: T): boolean; export function eqBy(fn: (a: T) => U, a: T): (b: T) => boolean; export function eqBy(fn: (a: T) => U): _.F.Curry<(a: T, b: T) => boolean>; /** * Reports whether two functions have the same value for the specified property. */ export function eqProps(prop: string, obj1: T, obj2: U): boolean; export function eqProps

(p: P): (list: Array>) => T[]; export function pluck(p: number): (list: Array<{ [k: number]: T }>) => T[]; /** * Returns a new list with the given element at the front, followed by the contents of the * list. */ export function prepend(el: T, list: readonly T[]): T[]; export function prepend(el: T): (list: readonly T[]) => T[]; /** * Multiplies together all the elements of a list. */ export function product(list: readonly number[]): number; /** * Reasonable analog to SQL `select` statement. */ export function project(props: readonly string[], objs: readonly T[]): U[]; export function project(props: readonly string[]): (objs: readonly T[]) => U[]; /** * Returns a function that when supplied an object returns the indicated property of that object, if it exists. */ export function prop(__: Placeholder, obj: T):

(p: P) => T[P]; export function prop

(p: P, obj: T): T[P]; export function prop

(p: P): (obj: Record) => T; export function prop

(p: P): (obj: Record) => T; /** * Determines whether the given property of an object has a specific * value according to strict equality (`===`). Most likely used to * filter a list. */ export function propEq(name: string | number, val: T, obj: any): boolean; export function propEq(name: string | number, val: T): (obj: any) => boolean; export function propEq(name: string | number): { (val: T, obj: any): boolean; (val: T): (obj: any) => boolean; }; /** * Returns true if the specified object property is of the given type; false otherwise. */ export function propIs(type: any, name: string, obj: any): boolean; export function propIs(type: any, name: string): (obj: any) => boolean; export function propIs(type: any): { (name: string, obj: any): boolean; (name: string): (obj: any) => boolean; }; /** * If the given, non-null object has an own property with the specified name, returns the value of that property. * Otherwise returns the provided default value. */ export function propOr(val: T, __: Placeholder, obj: U): (p: string) => V; export function propOr(__: Placeholder, p: string, obj: U): (val: T) => V; export function propOr(val: T, p: string, obj: U): V; export function propOr(val: T, p: string): (obj: U) => V; export function propOr(val: T): (p: string, obj: U) => V; /** * Returns the value at the specified property. * The only difference from `prop` is the parameter order. * Note: TS1.9 # replace any by dictionary */ export function props

(ps: readonly P[], obj: Record): T[]; export function props

(ps: readonly P[]): (obj: Record) => T[]; export function props

(ps: readonly P[]): (obj: Record) => T[]; /** * Returns true if the specified object property satisfies the given predicate; false otherwise. */ export function propSatisfies(pred: (val: T) => boolean, name: string, obj: U): boolean; export function propSatisfies(pred: (val: T) => boolean, name: string): (obj: U) => boolean; export function propSatisfies(pred: (val: T) => boolean): _.F.Curry<(a: string, b: U) => boolean>; /** * Returns a list of numbers from `from` (inclusive) to `to` * (exclusive). In mathematical terms, `range(a, b)` is equivalent to * the half-open interval `[a, b)`. */ export function range(from: number, to: number): number[]; export function range(from: number): (to: number) => number[]; /** * Returns a single item by iterating through the list, successively calling the iterator * function and passing it an accumulator value and the current value from the array, and * then passing the result to the next call. */ export function reduce(fn: (acc: TResult, elem: T) => TResult | Reduced, acc: TResult, list: readonly T[]): TResult; export function reduce(fn: (acc: TResult, elem: T) => TResult | Reduced): (acc: TResult, list: readonly T[]) => TResult; export function reduce(fn: (acc: TResult, elem: T) => TResult | Reduced, acc: TResult): (list: readonly T[]) => TResult; /** * Groups the elements of the list according to the result of calling the String-returning function keyFn on each * element and reduces the elements of each group to a single value via the reducer function valueFn. */ export function reduceBy(valueFn: (acc: TResult, elem: T) => TResult, acc: TResult, keyFn: (elem: T) => string, list: readonly T[]): { [index: string]: TResult }; export function reduceBy(valueFn: (acc: TResult, elem: T) => TResult, acc: TResult, keyFn: (elem: T) => string): (list: readonly T[]) => { [index: string]: TResult }; export function reduceBy(valueFn: (acc: TResult, elem: T) => TResult, acc: TResult): _.F.Curry<(a: (elem: T) => string, b: readonly T[]) => { [index: string]: TResult }>; export function reduceBy(valueFn: (acc: TResult, elem: T) => TResult): _.F.Curry<(a: TResult, b: (elem: T) => string, c: readonly T[]) => { [index: string]: TResult }>; /** * Returns a value wrapped to indicate that it is the final value of the reduce and * transduce functions. The returned value should be considered a black box: the internal * structure is not guaranteed to be stable. */ export function reduced(elem: T): Reduced; /** * Returns a single item by iterating through the list, successively calling the iterator * function and passing it an accumulator value and the current value from the array, and * then passing the result to the next call. */ export function reduceRight(fn: (elem: T, acc: TResult) => TResult, acc: TResult, list: readonly T[]): TResult; export function reduceRight(fn: (elem: T, acc: TResult) => TResult): (acc: TResult, list: readonly T[]) => TResult; export function reduceRight(fn: (elem: T, acc: TResult) => TResult, acc: TResult): (list: readonly T[]) => TResult; /** * Like reduce, reduceWhile returns a single item by iterating through the list, successively * calling the iterator function. reduceWhile also takes a predicate that is evaluated before * each step. If the predicate returns false, it "short-circuits" the iteration and returns * the current value of the accumulator. */ export function reduceWhile(predicate: (acc: TResult, elem: T) => boolean, fn: (acc: TResult, elem: T) => TResult, acc: TResult, list: readonly T[]): TResult; export function reduceWhile(predicate: (acc: TResult, elem: T) => boolean, fn: (acc: TResult, elem: T) => TResult, acc: TResult): (list: readonly T[]) => TResult; export function reduceWhile(predicate: (acc: TResult, elem: T) => boolean, fn: (acc: TResult, elem: T) => TResult): _.F.Curry<(a: TResult, b: readonly T[]) => TResult>; export function reduceWhile(predicate: (acc: TResult, elem: T) => boolean): _.F.Curry<(a: (acc: TResult, elem: T) => TResult, b: TResult, c: readonly T[]) => TResult>; /** * Similar to `filter`, except that it keeps only values for which the given predicate * function returns falsy. */ export const reject: Filter; /** * Removes the sub-list of `list` starting at index `start` and containing `count` elements. */ export function remove(start: number, count: number, list: readonly T[]): T[]; export function remove(start: number): (count: number, list: readonly T[]) => T[]; export function remove(start: number, count: number): (list: readonly T[]) => T[]; /** * Returns a fixed list of size n containing a specified identical value. */ export function repeat(a: T, n: number): T[]; export function repeat(a: T): (n: number) => T[]; /** * Replace a substring or regex match in a string with a replacement. */ export function replace(pattern: RegExp | string, replacement: string | ((match: string, ...args: readonly any[]) => string), str: string): string; export function replace(pattern: RegExp | string, replacement: string | ((match: string, ...args: readonly any[]) => string)): (str: string) => string; export function replace(pattern: RegExp | string): (replacement: string | ((match: string, ...args: readonly any[]) => string)) => (str: string) => string; /** * Returns a new list with the same elements as the original list, just in the reverse order. */ export function reverse(list: readonly T[]): T[]; /** * Returns a new string with the characters in reverse order. */ export function reverse(str: string): string; /** * Scan is similar to reduce, but returns a list of successively reduced values from the left. */ export function scan(fn: (acc: TResult, elem: T) => any, acc: TResult, list: readonly T[]): TResult[]; export function scan(fn: (acc: TResult, elem: T) => any, acc: TResult): (list: readonly T[]) => TResult[]; export function scan(fn: (acc: TResult, elem: T) => any): (acc: TResult, list: readonly T[]) => TResult[]; /** * Returns the result of "setting" the portion of the given data structure focused by the given lens to the * given value. */ export function set(lens: Lens, a: U, obj: T): T; export function set(lens: Lens, a: U): (obj: T) => T; export function set(lens: Lens): (a: U, obj: T) => T; /** * Returns the elements from `xs` starting at `a` and ending at `b - 1`. */ export function slice(a: number, b: number, list: string): string; export function slice(a: number, b: number, list: readonly T[]): T[]; export function slice(a: number, b: number): { (list: string): string; (list: readonly T[]): T[]; }; export function slice(a: number): { (b: number, list: string): string; (b: number, list: readonly T[]): T[]; }; /** * Returns a copy of the list, sorted according to the comparator function, which should accept two values at a * time and return a negative number if the first value is smaller, a positive number if it's larger, and zero * if they are equal. */ export function sort(fn: (a: T, b: T) => number, list: readonly T[]): T[]; export function sort(fn: (a: T, b: T) => number): (list: readonly T[]) => T[]; /** * Sorts the list according to a key generated by the supplied function. */ export function sortBy(fn: (a: T) => Ord, list: readonly T[]): T[]; export function sortBy(fn: (a: any) => Ord): (list: readonly T[]) => T[]; /** * Sorts a list according to a list of comparators. */ export function sortWith(fns: Array<((a: T, b: T) => number)>, list: readonly T[]): T[]; export function sortWith(fns: Array<((a: T, b: T) => number)>): (list: readonly T[]) => T[]; /** * Splits a string into an array of strings based on the given * separator. */ export function split(sep: string | RegExp): (str: string) => string[]; export function split(sep: string | RegExp, str: string): string[]; /** * Splits a given list or string at a given index. */ export function splitAt(index: number, list: readonly T[]): [T[], T[]]; export function splitAt(index: number, list: string): [string, string]; export function splitAt(index: number): { (list: readonly T[]): [T[], T[]]; (list: string): [string, string]; }; /** * Splits a collection into slices of the specified length. */ export function splitEvery(a: number, list: readonly T[]): T[][]; export function splitEvery(a: number, list: string): string[]; export function splitEvery(a: number): { (list: string): string[]; (list: readonly T[]): T[][]; }; /** * Takes a list and a predicate and returns a pair of lists with the following properties: * - the result of concatenating the two output lists is equivalent to the input list; * - none of the elements of the first output list satisfies the predicate; and * - if the second output list is non-empty, its first element satisfies the predicate. */ export function splitWhen(pred: (val: T) => boolean, list: readonly U[]): U[][]; export function splitWhen(pred: (val: T) => boolean): (list: readonly U[]) => U[][]; /** * Checks if a list starts with the provided values */ export function startsWith(a: string, list: string): boolean; export function startsWith(a: string): (list: string) => boolean; export function startsWith(a: T | readonly T[], list: readonly T[]): boolean; export function startsWith(a: T | readonly T[]): (list: readonly T[]) => boolean; /** * Subtracts two numbers. Equivalent to `a - b` but curried. */ export function subtract(__: Placeholder, b: number): (a: number) => number; export function subtract(__: Placeholder): (b: number, a: number) => number; export function subtract(a: number, b: number): number; export function subtract(a: number): (b: number) => number; /** * Adds together all the elements of a list. */ export function sum(list: readonly number[]): number; /** * Finds the set (i.e. no duplicates) of all elements contained in the first or second list, but not both. */ export function symmetricDifference(list1: readonly T[], list2: readonly T[]): T[]; export function symmetricDifference(list: readonly T[]): (list: readonly T[]) => T[]; /** * Finds the set (i.e. no duplicates) of all elements contained in the first or second list, but not both. * Duplication is determined according to the value returned by applying the supplied predicate to two list elements. */ export function symmetricDifferenceWith(pred: (a: T, b: T) => boolean, list1: readonly T[], list2: readonly T[]): T[]; export function symmetricDifferenceWith(pred: (a: T, b: T) => boolean): _.F.Curry<(a: readonly T[], b: readonly T[]) => T[]>; /** * A function that always returns true. Any passed in parameters are ignored. */ export function T(): boolean; /** * Returns all but the first element of a list or string. */ export function tail(list: string): string; export function tail(list: readonly T[]): T[]; /** * Returns a new list containing the first `n` elements of the given list. If * `n > * list.length`, returns a list of `list.length` elements. */ export function take(n: number, xs: readonly T[]): T[]; export function take(n: number, xs: string): string; export function take(n: number): { (xs: string): string; (xs: readonly T[]): T[]; }; /** * Returns a new list containing the last n elements of the given list. If n > list.length, * returns a list of list.length elements. */ export function takeLast(n: number, xs: readonly T[]): T[]; export function takeLast(n: number, xs: string): string; export function takeLast(n: number): { (xs: readonly T[]): T[]; (xs: string): string; }; /** * Returns a new list containing the last n elements of a given list, passing each value * to the supplied predicate function, and terminating when the predicate function returns * false. Excludes the element that caused the predicate function to fail. The predicate * function is passed one argument: (value). */ export function takeLastWhile(pred: (a: T) => boolean, list: readonly T[]): T[]; export function takeLastWhile(pred: (a: T) => boolean): (list: readonly T[]) => T[]; /** * Returns a new list containing the first `n` elements of a given list, passing each value * to the supplied predicate function, and terminating when the predicate function returns * `false`. */ export function takeWhile(fn: (x: T) => boolean, list: readonly T[]): T[]; export function takeWhile(fn: (x: T) => boolean): (list: readonly T[]) => T[]; /** * The function to call with x. The return value of fn will be thrown away. */ export function tap(fn: (a: T) => any, value: T): T; export function tap(fn: (a: T) => any): (value: T) => T; /** * Determines whether a given string matches a given regular expression. */ export function test(regexp: RegExp, str: string): boolean; export function test(regexp: RegExp): (str: string) => boolean; /** * Returns the result of applying the onSuccess function to the value inside a successfully resolved promise. This is useful for working with promises inside function compositions. */ export function then(onSuccess: (a: A) => B | Promise, promise: Promise): Promise; export function then(onSuccess: (a: A) => B | Promise): (promise: Promise) => Promise; /** * Creates a thunk out of a function. * A thunk delays a calculation until its result is needed, providing lazy evaluation of arguments. */ export function thunkify any>(fn: F): _.F.Curry<(...args: Parameters) => (() => ReturnType)>; /** * Calls an input function `n` times, returning an array containing the results of those * function calls. */ export function times(fn: (i: number) => T, n: number): T[]; export function times(fn: (i: number) => T): (n: number) => T[]; /** * The lower case version of a string. */ export function toLower(str: string): string; /** * Converts an object into an array of key, value arrays. * Only the object's own properties are used. * Note that the order of the output array is not guaranteed to be * consistent across different JS platforms. */ export function toPairs(obj: { [k: string]: S } | { [k: number]: S }): Array<[string, S]>; /** * Converts an object into an array of key, value arrays. * The object's own properties and prototype properties are used. * Note that the order of the output array is not guaranteed to be * consistent across different JS platforms. */ export function toPairsIn(obj: { [k: string]: S } | { [k: number]: S }): Array<[string, S]>; /** * Returns the string representation of the given value. eval'ing the output should * result in a value equivalent to the input value. Many of the built-in toString * methods do not satisfy this requirement. * * If the given value is an [object Object] with a toString method other than * Object.prototype.toString, this method is invoked with no arguments to produce the * return value. This means user-defined constructor functions can provide a suitable * toString method. */ export function toString(val: T): string; /** * The upper case version of a string. */ export function toUpper(str: string): string; /** * Initializes a transducer using supplied iterator function. Returns a single item by iterating through the * list, successively calling the transformed iterator function and passing it an accumulator value and the * current value from the array, and then passing the result to the next call. */ export function transduce(xf: (arg: readonly T[]) => T[], fn: (acc: readonly U[], val: U) => U[], acc: readonly T[], list: readonly T[]): U; export function transduce(xf: (arg: readonly T[]) => T[]): (fn: (acc: readonly U[], val: U) => U[], acc: readonly T[], list: readonly T[]) => U; export function transduce(xf: (arg: readonly T[]) => T[], fn: (acc: readonly U[], val: U) => U[]): (acc: readonly T[], list: readonly T[]) => U; export function transduce(xf: (arg: readonly T[]) => T[], fn: (acc: readonly U[], val: U) => U[], acc: readonly T[]): (list: readonly T[]) => U; /** * Transposes the rows and columns of a 2D list. When passed a list of n lists of length x, returns a list of x lists of length n. */ export function transpose(list: readonly T[][]): T[][]; /** * Maps an Applicative-returning function over a Traversable, then uses * sequence to transform the resulting Traversable of Applicative into * an Applicative of Traversable. */ export function traverse(of: (a: B) => B[], fn: (t: A) => B[], list: readonly A[]): B[][]; export function traverse(of: (a: B) => B[], fn: (t: A) => B[]): (list: readonly A[]) => B[][]; export function traverse(of: (a: B) => B[]): (fn: (t: A) => B[], list: readonly A[]) => B[][]; /** * Removes (strips) whitespace from both ends of the string. */ export function trim(str: string): string; /** * tryCatch takes two functions, a tryer and a catcher. The returned function evaluates the tryer; if it does * not throw, it simply returns the result. If the tryer does throw, the returned function evaluates the catcher * function and returns its result. Note that for effective composition with this function, both the tryer and * catcher functions must return the same type of results. */ export function tryCatch(tryer: (...args: readonly any[]) => T, catcher: (...args: readonly any[]) => T): (...args: readonly any[]) => T; /** * Gives a single-word string description of the (native) type of a value, returning such answers as 'Object', * 'Number', 'Array', or 'Null'. Does not attempt to distinguish user Object types any further, reporting them * all as 'Object'. */ export function type(val: any): 'Object' | 'Number' | 'Boolean' | 'String' | 'Null' | 'Array' | 'RegExp' | 'Function' | 'Undefined'; /** * Takes a function fn, which takes a single array argument, and returns a function which: * - takes any number of positional arguments; * - passes these arguments to fn as an array; and * - returns the result. * In other words, R.unapply derives a variadic function from a function which takes an array. * R.unapply is the inverse of R.apply. */ export function unapply(fn: (args: readonly any[]) => T): (...args: readonly any[]) => T; /** * Wraps a function of any arity (including nullary) in a function that accepts exactly 1 parameter. * Any extraneous parameters will not be passed to the supplied function. */ export function unary(fn: (a: T, ...args: readonly any[]) => any): (a: T) => any; /** * Returns a function of arity n from a (manually) curried function. */ export function uncurryN(len: number, fn: (a: any) => any): (...a: readonly any[]) => T; /** * Builds a list from a seed value. Accepts an iterator function, which returns either false * to stop iteration or an array of length 2 containing the value to add to the resulting * list and the seed to be used in the next call to the iterator function. */ export function unfold(fn: (seed: T) => [TResult, T] | false, seed: T): TResult[]; export function unfold(fn: (seed: T) => [TResult, T] | false): (seed: T) => TResult[]; /** * Combines two lists into a set (i.e. no duplicates) composed of the * elements of each list. */ export function union(as: readonly T[], bs: readonly T[]): T[]; export function union(as: readonly T[]): (bs: readonly T[]) => T[]; /** * Combines two lists into a set (i.e. no duplicates) composed of the elements of each list. Duplication is * determined according to the value returned by applying the supplied predicate to two list elements. */ export function unionWith(pred: (a: T, b: T) => boolean, list1: readonly T[], list2: readonly T[]): T[]; export function unionWith(pred: (a: T, b: T) => boolean): _.F.Curry<(a: readonly T[], b: readonly T[]) => T[]>; /** * Returns a new list containing only one copy of each element in the original list. */ export function uniq(list: readonly T[]): T[]; /** * Returns a new list containing only one copy of each element in the original list, * based upon the value returned by applying the supplied function to each list element. * Prefers the first item if the supplied function produces the same value on two items. * R.equals is used for comparison. */ export function uniqBy(fn: (a: T) => U, list: readonly T[]): T[]; export function uniqBy(fn: (a: T) => U): (list: readonly T[]) => T[]; /** * Returns a new list containing only one copy of each element in the original list, based upon the value * returned by applying the supplied predicate to two list elements. */ export function uniqWith(pred: (x: T, y: T) => boolean, list: readonly T[]): T[]; export function uniqWith(pred: (x: T, y: T) => boolean): (list: readonly T[]) => T[]; /** * Tests the final argument by passing it to the given predicate function. If the predicate is not satisfied, * the function will return the result of calling the whenFalseFn function with the same argument. If the * predicate is satisfied, the argument is returned as is. */ export function unless(pred: (a: T) => boolean, whenFalseFn: (a: T) => U, obj: T): U; export function unless(pred: (a: T) => boolean, whenFalseFn: (a: T) => U): (obj: T) => U; /** * Returns a new list by pulling every item at the first level of nesting out, and putting * them in a new array. */ export function unnest(list: T): _.T.UnNest; /** * Takes a predicate, a transformation function, and an initial value, and returns a value of the same type as * the initial value. It does so by applying the transformation until the predicate is satisfied, at which point * it returns the satisfactory value. */ export function until(pred: (val: T) => boolean, fn: (val: T) => U, init: U): U; export function until(pred: (val: T) => boolean, fn: (val: T) => U): (init: U) => U; /** * Returns a new copy of the array with the element at the provided index replaced with the given value. */ export function update(index: number, value: T, list: readonly T[]): T[]; export function update(index: number, value: T): (list: readonly T[]) => T[]; /** * Accepts a function fn and a list of transformer functions and returns a new curried function. * When the new function is invoked, it calls the function fn with parameters consisting of the * result of calling each supplied handler on successive arguments to the new function. * * If more arguments are passed to the returned function than transformer functions, those arguments * are passed directly to fn as additional parameters. If you expect additional arguments that don't * need to be transformed, although you can ignore them, it's best to pass an identity function so * that the new function reports the correct arity. */ export function useWith(fn: ((...a: readonly any[]) => any), transformers: Array<((...a: readonly any[]) => any)>): (...a: readonly any[]) => any; /** * Returns a list of all the enumerable own properties of the supplied object. * Note that the order of the output array is not guaranteed across * different JS platforms. */ export function values(obj: T): Array; /** * Returns a list of all the properties, including prototype properties, of the supplied * object. Note that the order of the output array is not guaranteed to be consistent across different JS platforms. */ export function valuesIn(obj: any): T[]; /** * Returns a "view" of the given data structure, determined by the given lens. The lens's focus determines which * portion of the data structure is visible. */ export function view(lens: Lens): (obj: T) => U; export function view(lens: Lens, obj: T): U; /** * Tests the final argument by passing it to the given predicate function. If the predicate is satisfied, the function * will return the result of calling the whenTrueFn function with the same argument. If the predicate is not satisfied, * the argument is returned as is. */ export function when(pred: (a: T) => boolean, whenTrueFn: (a: T) => U, obj: T): U; export function when(pred: (a: T) => boolean, whenTrueFn: (a: T) => U): (obj: T) => U; /** * Takes a spec object and a test object and returns true if the test satisfies the spec. * Any property on the spec that is not a function is interpreted as an equality * relation. * * If the spec has a property mapped to a function, then `where` evaluates the function, passing in * the test object's value for the property in question, as well as the whole test object. * * `where` is well suited to declaratively expressing constraints for other functions, e.g., * `filter`, `find`, `pickWith`, etc. */ export function where(spec: T, testObj: U): boolean; export function where(spec: T): (testObj: U) => boolean; export function where(spec: ObjFunc2, testObj: U): boolean; export function where(spec: ObjFunc2): (testObj: U) => boolean; /** * Takes a spec object and a test object; returns true if the test satisfies the spec, * false otherwise. An object satisfies the spec if, for each of the spec's own properties, * accessing that property of the object gives the same value (in R.eq terms) as accessing * that property of the spec. */ export function whereEq(spec: T, obj: U): boolean; export function whereEq(spec: T): (obj: U) => boolean; /** * Returns a new list without values in the first argument. R.equals is used to determine equality. * Acts as a transducer if a transformer is given in list position. */ export function without(list1: readonly T[], list2: readonly T[]): T[]; export function without(list1: readonly T[]): (list2: readonly T[]) => T[]; /** * Creates a new list out of the two supplied by creating each possible pair from the lists. */ export function xprod(as: readonly K[], bs: readonly V[]): Array>; export function xprod(as: readonly K[]): (bs: readonly V[]) => Array>; /** * Creates a new list out of the two supplied by pairing up equally-positioned items from * both lists. Note: `zip` is equivalent to `zipWith(function(a, b) { return [a, b] })`. */ export function zip(list1: readonly K[], list2: readonly V[]): Array>; export function zip(list1: readonly K[]): (list2: readonly V[]) => Array>; /** * Creates a new object out of a list of keys and a list of values. */ // TODO: Dictionary as a return value is to specific, any seems to loose export function zipObj(keys: readonly string[], values: readonly T[]): { [index: string]: T }; export function zipObj(keys: readonly string[]): (values: readonly T[]) => { [index: string]: T }; export function zipObj(keys: readonly number[], values: readonly T[]): { [index: number]: T }; export function zipObj(keys: readonly number[]): (values: readonly T[]) => { [index: number]: T }; /** * Creates a new list out of the two supplied by applying the function to each * equally-positioned pair in the lists. */ export function zipWith(fn: (x: T, y: U) => TResult, list1: readonly T[], list2: readonly U[]): TResult[]; export function zipWith(fn: (x: T, y: U) => TResult, list1: readonly T[]): (list2: readonly U[]) => TResult[]; export function zipWith(fn: (x: T, y: U) => TResult): (list1: readonly T[], list2: readonly U[]) => TResult[]; export as namespace R

(prop: P): (obj1: Record, obj2: Record) => boolean; export function eqProps(prop: string, obj1: T): (obj2: U) => boolean; /** * Returns true if its arguments are equivalent, false otherwise. Dispatches to an equals method if present. * Handles cyclical data structures. */ export function equals(a: T, b: T): boolean; export function equals(a: T): (b: T) => boolean; /** * Creates a new object by evolving a shallow copy of object, according to the transformation functions. */ export function evolve>(transformations: E, obj: V): Evolve; export function evolve(transformations: E): >(obj: V) => Evolve; /* * A function that always returns false. Any passed in parameters are ignored. */ export function F(): boolean; /** * Returns a new list containing only those items that match a given predicate function. The predicate function is passed one argument: (value). */ export const filter: Filter; /** * Returns the first element of the list which matches the predicate, or `undefined` if no * element matches. */ export function find(fn: (a: T) => boolean, list: readonly T[]): T | undefined; export function find(fn: (a: T) => boolean): (list: readonly T[]) => T | undefined; /** * Returns the index of the first element of the list which matches the predicate, or `-1` * if no element matches. */ export function findIndex(fn: (a: T) => boolean, list: readonly T[]): number; export function findIndex(fn: (a: T) => boolean): (list: readonly T[]) => number; /** * Returns the last element of the list which matches the predicate, or `undefined` if no * element matches. */ export function findLast(fn: (a: T) => boolean, list: readonly T[]): T | undefined; export function findLast(fn: (a: T) => boolean): (list: readonly T[]) => T | undefined; /** * Returns the index of the last element of the list which matches the predicate, or * `-1` if no element matches. */ export function findLastIndex(fn: (a: T) => boolean, list: readonly T[]): number; export function findLastIndex(fn: (a: T) => boolean): (list: readonly T[]) => number; /** * Returns a new list by pulling every item out of it (and all its sub-arrays) and putting * them in a new array, depth-first. */ export function flatten(list: T): _.T.Flatten; /** * Returns a new function much like the supplied one, except that the first two arguments' * order is reversed. */ export function flip(fn: (arg0: T, arg1: U) => TResult): (arg1: U, arg0?: T) => TResult; export function flip any, P extends _.F.Parameters>(fn: F): _.F.Curry<(...args: _.T.Merge<[P[1], P[0]], P>) => _.F.Return>; /** * Iterate over an input list, calling a provided function fn for each element in the list. */ export function forEach(fn: (x: T) => void, list: readonly T[]): T[]; export function forEach(fn: (x: T) => void): (list: readonly T[]) => T[]; export function forEach(fn: (x: T) => void, list: readonly T[]): T[]; export function forEach(fn: (x: T) => void): (list: readonly T[]) => T[]; /** * Iterate over an input object, calling a provided function fn for each key and value in the object. */ export function forEachObjIndexed(fn: (value: T[keyof T], key: keyof T, obj: T) => void, obj: T): T; export function forEachObjIndexed(fn: (value: T[keyof T], key: keyof T, obj: T) => void): (obj: T) => T; /** * Creates a new object out of a list key-value pairs. */ export function fromPairs(pairs: Array>): { [index: string]: V }; export function fromPairs(pairs: Array>): { [index: number]: V }; /** * Splits a list into sublists stored in an object, based on the result of * calling a String-returning function * on each element, and grouping the results according to values returned. */ export function groupBy(fn: (a: T) => string, list: readonly T[]): { [index: string]: T[] }; export function groupBy(fn: (a: T) => string): (list: readonly T[]) => { [index: string]: T[] }; /** * Takes a list and returns a list of lists where each sublist's elements are all "equal" according to the provided equality function */ export function groupWith(fn: (x: T, y: T) => boolean): (list: readonly T[]) => T[][]; export function groupWith(fn: (x: T, y: T) => boolean, list: readonly T[]): T[][]; export function groupWith(fn: (x: T, y: T) => boolean, list: string): string[]; /** * Returns true if the first parameter is greater than the second. */ export function gt(__: Placeholder, b: number): (a: number) => boolean; export function gt(__: Placeholder): (b: number, a: number) => boolean; export function gt(a: number, b: number): boolean; export function gt(a: number): (b: number) => boolean; /** * Returns true if the first parameter is greater than or equal to the second. */ export function gte(__: Placeholder, b: number): (a: number) => boolean; export function gte(__: Placeholder): (b: number, a: number) => boolean; export function gte(a: number, b: number): boolean; export function gte(a: number): (b: number) => boolean; /** * Returns whether or not an object has an own property with the specified name. */ export function has(__: Placeholder, obj: T): (s: string) => boolean; export function has(__: Placeholder): (obj: T, s: string) => boolean; export function has(s: string, obj: T): boolean; export function has(s: string): (obj: T) => boolean; /** * Returns whether or not an object or its prototype chain has a property with the specified name */ export function hasIn(s: string, obj: T): boolean; export function hasIn(s: string): (obj: T) => boolean; /** * Returns whether or not a path exists in an object. Only the object's own properties are checked. */ export function hasPath(list: readonly string[], obj: T): boolean; export function hasPath(list: readonly string[]): (obj: T) => boolean; /** * Returns the first element in a list. * In some libraries this function is named `first`. */ export function head(str: string): string; export function head(list: readonly []): undefined; export function head(list: readonly T[]): T | undefined; /** * Returns true if its arguments are identical, false otherwise. Values are identical if they reference the * same memory. NaN is identical to NaN; 0 and -0 are not identical. */ export function identical(a: T, b: T): boolean; export function identical(a: T): (b: T) => boolean; /** * A function that does nothing but return the parameter supplied to it. Good as a default * or placeholder function. */ export function identity(a: T): T; /** * Creates a function that will process either the onTrue or the onFalse function depending upon the result * of the condition predicate. */ export function ifElse(fn: Pred, onTrue: Arity1Fn, onFalse: Arity1Fn): Arity1Fn; export function ifElse(fn: Pred, onTrue: Arity2Fn, onFalse: Arity2Fn): Arity2Fn; /** * Increments its argument. */ export function inc(n: number): number; /** * Given a target, this function checks a list for the target and returns a boolean. * Given a string, this function checks for the string in another string or list and returns * a boolean. */ export function includes(s: string, list: readonly string[] | string): boolean; export function includes(s: string): (list: readonly string[] | string) => boolean; export function includes(target: T, list: readonly T[]): boolean; export function includes(target: T): (list: readonly T[]) => boolean; /** * Given a function that generates a key, turns a list of objects into an object indexing the objects * by the given key. */ export function indexBy(fn: (a: T) => string, list: readonly T[]): { [key: string]: T }; export function indexBy(fn: (a: T) => string): (list: readonly T[]) => { [key: string]: T }; /** * Returns the position of the first occurrence of an item in an array * (by strict equality), * or -1 if the item is not included in the array. */ export function indexOf(target: T, list: readonly T[]): number; export function indexOf(target: T): (list: readonly T[]) => number; /** * Returns all but the last element of a list or string. */ export function init(list: readonly T[]): T[]; export function init(list: string): string; /** * Takes a predicate `pred`, a list `xs`, and a list `ys`, and returns a list * `xs'` comprising each of the elements of `xs` which is equal to one or more * elements of `ys` according to `pred`. * * `pred` must be a binary function expecting an element from each list. * * `xs`, `ys`, and `xs'` are treated as sets, semantically, so ordering should * not be significant, but since `xs'` is ordered the implementation guarantees * that its values are in the same order as they appear in `xs`. Duplicates are * not removed, so `xs'` may contain duplicates if `xs` contains duplicates. */ export function innerJoin(pred: (a: T1, b: T2) => boolean, list1: readonly T1[], list2: readonly T2[]): T1[]; export function innerJoin(pred: (a: T1, b: T2) => boolean): (list1: readonly T1[], list2: readonly T2[]) => T1[]; export function innerJoin(pred: (a: T1, b: T2) => boolean, list1: readonly T1[]): (list2: readonly T2[]) => T1[]; /** * Inserts the supplied element into the list, at index index. Note that * this is not destructive: it returns a copy of the list with the changes. */ export function insert(index: number, elt: T, list: readonly T[]): T[]; export function insert(index: number, elt: T): (list: readonly T[]) => T[]; export function insert(index: number): (elt: T, list: readonly T[]) => T[]; /** * Inserts the sub-list into the list, at index `index`. _Note that this * is not destructive_: it returns a copy of the list with the changes. */ export function insertAll(index: number, elts: readonly T[], list: readonly T[]): T[]; export function insertAll(index: number, elts: readonly T[]): (list: readonly T[]) => T[]; export function insertAll(index: number): (elts: readonly T[], list: readonly T[]) => T[]; /** * Combines two lists into a set (i.e. no duplicates) composed of those elements common to both lists. */ export function intersection(list1: readonly T[], list2: readonly T[]): T[]; export function intersection(list1: readonly T[]): (list2: readonly T[]) => T[]; /** * Combines two lists into a set (i.e. no duplicates) composed of those * elements common to both lists. Duplication is determined according * to the value returned by applying the supplied predicate to two list * elements. */ export function intersectionWith(pred: (a: T, b: T) => boolean, list1: readonly T[], list2: readonly T[]): T[]; /** * Creates a new list with the separator interposed between elements. */ export function intersperse(separator: T, list: readonly T[]): T[]; export function intersperse(separator: T): (list: readonly T[]) => T[]; /** * Transforms the items of the list with the transducer and appends the transformed items to the accumulator * using an appropriate iterator function based on the accumulator type. */ export function into(acc: any, xf: (...a: readonly any[]) => any, list: readonly T[]): T[]; export function into(acc: any, xf: (...a: readonly any[]) => any): (list: readonly T[]) => T[]; export function into(acc: any): (xf: (...a: readonly any[]) => any, list: readonly T[]) => T[]; /** * Same as R.invertObj, however this accounts for objects with duplicate values by putting the values into an array. */ export function invert(obj: T): { [index: string]: string[] }; /** * Returns a new object with the keys of the given object as values, and the values of the given object as keys. */ export function invertObj(obj: { [index: string]: string } | { [index: number]: string }): { [index: string]: string }; /** * Turns a named method with a specified arity into a function that can be called directly * supplied with arguments and a target object. * * The returned function is curried and accepts `arity + 1` parameters where the final * parameter is the target object. */ export function invoker(arity: number, method: string): (...a: readonly any[]) => any; /** * See if an object (`val`) is an instance of the supplied constructor. * This function will check up the inheritance chain, if any. */ export function is(ctor: any, val: any): boolean; export function is(ctor: any): (val: any) => boolean; /** * Reports whether the list has zero elements. */ export function isEmpty(value: any): boolean; /** * Checks if the input value is null or undefined. */ export function isNil(value: any): value is null | undefined; /** * Returns a string made by inserting the `separator` between each * element and concatenating all the elements into a single string. */ export function join(x: string, xs: readonly any[]): string; export function join(x: string): (xs: readonly any[]) => string; /** * Applies a list of functions to a list of values. */ export function juxt(fns: [(...a: A) => R1, (...a: A) => R2]): (...a: A) => [R1, R2]; export function juxt(fns: [(...a: A) => R1, (...a: A) => R2, (...a: A) => R3]): (...a: A) => [R1, R2, R3]; export function juxt(fns: [(...a: A) => R1, (...a: A) => R2, (...a: A) => R3, (...a: A) => R4]): (...a: A) => [R1, R2, R3, R4]; export function juxt(fns: [(...a: A) => R1, (...a: A) => R2, (...a: A) => R3, (...a: A) => R4, (...a: A) => R5]): (...a: A) => [R1, R2, R3, R4, R5]; export function juxt(fns: Array<(...args: A) => U>): (...args: A) => U[]; /** * Returns a list containing the names of all the enumerable own * properties of the supplied object. */ export function keys(x: T): Array; export function keys(x: T): string[]; /** * Returns a list containing the names of all the * properties of the supplied object, including prototype properties. */ export function keysIn(obj: T): string[]; /** * Returns the last element from a list. */ export function last(str: string): string; export function last(list: readonly []): undefined; export function last(list: readonly T[]): T | undefined; /** * Returns the position of the last occurrence of an item (by strict equality) in * an array, or -1 if the item is not included in the array. */ export function lastIndexOf(target: T, list: readonly T[]): number; /** * Returns the number of elements in the array by returning list.length. */ export function length(list: readonly T[]): number; /** * Returns a lens for the given getter and setter functions. The getter * "gets" the value of the focus; the setter "sets" the value of the focus. * The setter should not mutate the data structure. */ export function lens(getter: (s: T) => U, setter: (a: U, s: T) => V): Lens; /** * Creates a lens that will focus on index n of the source array. */ export function lensIndex(n: number): Lens; /** * Returns a lens whose focus is the specified path. * See also view, set, over. */ export function lensPath(path: Path): Lens; /** * lensProp creates a lens that will focus on property k of the source object. */ export function lensProp(str: string): { (obj: T): U; set(val: T, obj: U): V; /*map(fn: (...a: readonly any[]) => any, obj: T): T*/ }; /** * "lifts" a function of arity > 1 so that it may "map over" a list, Function or other object that satisfies * the FantasyLand Apply spec. */ export function lift(fn: ((...a: readonly any[]) => any), ...args: readonly any[]): any; /** * "lifts" a function to be the specified arity, so that it may "map over" that many lists, Functions or other * objects that satisfy the FantasyLand Apply spec. */ export function liftN(n: number, fn: ((...a: readonly any[]) => any), ...args: readonly any[]): any; /** * Returns true if the first parameter is less than the second. */ export function lt(__: Placeholder, b: number): (a: number) => boolean; export function lt(__: Placeholder): (b: number, a: number) => boolean; export function lt(a: number, b: number): boolean; export function lt(a: number): (b: number) => boolean; /** * Returns true if the first parameter is less than or equal to the second. */ export function lte(__: Placeholder, b: number): (a: number) => boolean; export function lte(__: Placeholder): (b: number, a: number) => boolean; export function lte(a: number, b: number): boolean; export function lte(a: number): (b: number) => boolean; /** * Returns a new list, constructed by applying the supplied function to every element of the supplied list. */ export function map(fn: (x: T) => U, list: readonly T[]): U[]; export function map(fn: (x: T) => U): (list: readonly T[]) => U[]; export function map(fn: (x: T[keyof T & keyof U]) => U[keyof T & keyof U], list: T): U; export function map(fn: (x: T[keyof T & keyof U]) => U[keyof T & keyof U]): (list: T) => U; export function map(fn: (x: T) => U, obj: Functor): Functor; // used in functors export function map(fn: (x: T) => U): (obj: Functor) => Functor; // used in functors /** * The mapAccum function behaves like a combination of map and reduce. */ export function mapAccum(fn: (acc: U, value: T) => [U, TResult], acc: U, list: readonly T[]): [U, TResult[]]; export function mapAccum(fn: (acc: U, value: T) => [U, TResult]): (acc: U, list: readonly T[]) => [U, TResult[]]; export function mapAccum(fn: (acc: U, value: T) => [U, TResult], acc: U): (list: readonly T[]) => [U, TResult[]]; /** * The mapAccumRight function behaves like a combination of map and reduce. */ export function mapAccumRight(fn: (acc: U, value: T) => [U, TResult], acc: U, list: readonly T[]): [U, TResult[]]; export function mapAccumRight(fn: (acc: U, value: T) => [U, TResult]): (acc: U, list: readonly T[]) => [U, TResult[]]; export function mapAccumRight(fn: (acc: U, value: T) => [U, TResult], acc: U): (list: readonly T[]) => [U, TResult[]]; /** * Like mapObj, but but passes additional arguments to the predicate function. */ export function mapObjIndexed( fn: (value: T, key: TKey, obj?: Record) => TResult, obj: Record ): Record; export function mapObjIndexed( fn: (value: T, key: TKey, obj?: Record) => TResult ): (obj: Record) => Record; export function mapObjIndexed( fn: (value: T, key: string, obj?: { [key: string]: T }) => TResult, obj: { [key: string]: T } ): { [key: string]: TResult }; export function mapObjIndexed(fn: (value: T, key: string, obj?: any) => TResult, obj: any): { [index: string]: TResult }; export function mapObjIndexed(fn: (value: T, key: string, obj?: any) => TResult): (obj: any) => { [index: string]: TResult }; /** * Tests a regular expression agains a String */ export function match(regexp: RegExp, str: string): string[]; export function match(regexp: RegExp): (str: string) => string[]; /** * mathMod behaves like the modulo operator should mathematically, unlike the `%` * operator (and by extension, R.modulo). So while "-17 % 5" is -2, * mathMod(-17, 5) is 3. mathMod requires Integer arguments, and returns NaN * when the modulus is zero or negative. */ export function mathMod(__: Placeholder, b: number): (a: number) => number; export function mathMod(__: Placeholder): (b: number, a: number) => number; export function mathMod(a: number, b: number): number; export function mathMod(a: number): (b: number) => number; /** * Returns the larger of its two arguments. */ export function max(a: T, b: T): T; export function max(a: T): (b: T) => T; /** * Takes a function and two values, and returns whichever value produces * the larger result when passed to the provided function. */ export function maxBy(keyFn: (a: T) => Ord, a: T, b: T): T; export function maxBy(keyFn: (a: T) => Ord, a: T): (b: T) => T; export function maxBy(keyFn: (a: T) => Ord): _.F.Curry<(a: T, b: T) => T>; /** * Returns the mean of the given list of numbers. */ export function mean(list: readonly number[]): number; /** * Returns the median of the given list of numbers. */ export function median(list: readonly number[]): number; /** * Creates a new function that, when invoked, caches the result of calling fn for a given argument set and returns the result. * Subsequent calls to the memoized fn with the same argument set will not result in an additional call to fn; instead, the cached result for that set of arguments will be returned. */ export function memoizeWith any>(keyFn: (...v: Parameters) => string, fn: T): T; /** * Create a new object with the own properties of a * merged with the own properties of object b. * This function will *not* mutate passed-in objects. * * @deprecated since 0.26 in favor of mergeRight */ export function merge(__: Placeholder, b: O2): (a: O1) => Merge; export function merge(__: Placeholder): (b: O2, a: O1) => Merge; export function merge(a: O1, b: O2): Merge; export function merge(a: O1): (b: O2) => Merge; /** * Merges a list of objects together into one object. */ export function mergeAll(list: Os): MergeAll; /** * Creates a new object with the own properties of the first object merged with the own properties of the second object. * If a key exists in both objects: * and both values are objects, the two values will be recursively merged * otherwise the value from the first object will be used. */ export function mergeDeepLeft(o1: O1, o2: O2): Merge; export function mergeDeepLeft(o1: O1): (o2: O2) => Merge; /** * Creates a new object with the own properties of the first object merged with the own properties of the second object. * If a key exists in both objects: * and both values are objects, the two values will be recursively merged * otherwise the value from the second object will be used. */ export function mergeDeepRight(o1: O1, o2: O2): Merge; export function mergeDeepRight(a: O1): (o2: O2) => Merge; /** * Creates a new object with the own properties of the two provided objects. If a key exists in both objects: * and both associated values are also objects then the values will be recursively merged. * otherwise the provided function is applied to associated values using the resulting value as the new value * associated with the key. If a key only exists in one object, the value will be associated with the key of the resulting object. */ export function mergeDeepWith(fn: (x: any, z: any) => any, a: T1, b: T2): any; export function mergeDeepWith(fn: (x: any, z: any) => any, a: T1): (b: T2) => any; export function mergeDeepWith(fn: (x: any, z: any) => any): (a: T1, b: T2) => any; /** * Creates a new object with the own properties of the two provided objects. If a key exists in both objects: * and both associated values are also objects then the values will be recursively merged. * otherwise the provided function is applied to the key and associated values using the resulting value as * the new value associated with the key. If a key only exists in one object, the value will be associated with * the key of the resulting object. */ export function mergeDeepWithKey(fn: (k: string, x: any, z: any) => any, a: T1, b: T2): any; export function mergeDeepWithKey(fn: (k: string, x: any, z: any) => any, a: T1): (b: T2) => any; export function mergeDeepWithKey(fn: (k: string, x: any, z: any) => any): (a: T1, b: T2) => any; /** * Create a new object with the own properties of the first object merged with the own properties of the second object. * If a key exists in both objects, the value from the first object will be used. */ export function mergeLeft(a: O1, b: O2): Merge; export function mergeLeft(a: O1): (b: O2) => Merge; /** * Create a new object with the own properties of the first object merged with the own properties of the second object. * If a key exists in both objects, the value from the second object will be used. */ export function mergeRight(a: O1, b: O2): Merge; export function mergeRight(a: O1): (b: O2) => Merge; /** * Creates a new object with the own properties of the two provided objects. If a key exists in both objects, * the provided function is applied to the values associated with the key in each object, with the result being used as * the value associated with the key in the returned object. The key will be excluded from the returned object if the * resulting value is undefined. */ export function mergeWith(fn: (x: any, z: any) => any, a: U, b: V): any; export function mergeWith(fn: (x: any, z: any) => any, a: U): (b: V) => any; export function mergeWith(fn: (x: any, z: any) => any): (a: U, b: V) => any; /** * Creates a new object with the own properties of the two provided objects. If a key exists in both objects, * the provided function is applied to the key and the values associated with the key in each object, with the * result being used as the value associated with the key in the returned object. The key will be excluded from * the returned object if the resulting value is undefined. */ export function mergeWithKey(fn: (str: string, x: any, z: any) => any, a: U, b: V): any; export function mergeWithKey(fn: (str: string, x: any, z: any) => any, a: U): (b: V) => any; export function mergeWithKey(fn: (str: string, x: any, z: any) => any): (a: U, b: V) => any; /** * Returns the smaller of its two arguments. */ export function min(a: T, b: T): T; export function min(a: T): (b: T) => T; /** * Takes a function and two values, and returns whichever value produces * the smaller result when passed to the provided function. */ export function minBy(keyFn: (a: T) => Ord, a: T, b: T): T; export function minBy(keyFn: (a: T) => Ord, a: T): (b: T) => T; export function minBy(keyFn: (a: T) => Ord): _.F.Curry<(a: T, b: T) => T>; /** * Divides the second parameter by the first and returns the remainder. * The flipped version (`moduloBy`) may be more useful curried. * Note that this functions preserves the JavaScript-style behavior for * modulo. For mathematical modulo see `mathMod` */ export function modulo(__: Placeholder, b: number): (a: number) => number; export function modulo(__: Placeholder): (b: number, a: number) => number; export function modulo(a: number, b: number): number; export function modulo(a: number): (b: number) => number; /** * Multiplies two numbers. Equivalent to a * b but curried. */ export function multiply(a: number, b: number): number; export function multiply(a: number): (b: number) => number; /** * Moves an item, at index `from`, to index `to`, in a `list` of elements. * A new list will be created containing the new elements order. */ export function move(from: number, to: number, list: readonly T[]): T[]; export function move(from: number, to: number): (list: readonly T[]) => T[]; export function move(from: number): { (to: number, list: readonly T[]): T[]; (to: number): (list: readonly T[]) => T[]; }; /** * Wraps a function of any arity (including nullary) in a function that accepts exactly n parameters. * Any extraneous parameters will not be passed to the supplied function. */ export function nAry(n: number, fn: (...arg: readonly any[]) => any): (...a: readonly any[]) => any; export function nAry(n: number): (fn: (...arg: readonly any[]) => any) => (...a: readonly any[]) => any; /** * Negates its argument. */ export function negate(n: number): number; /** * Returns true if no elements of the list match the predicate, false otherwise. */ export function none(fn: (a: T) => boolean, list: readonly T[]): boolean; export function none(fn: (a: T) => boolean): (list: readonly T[]) => boolean; /** * A function wrapping a call to the given function in a `!` operation. It will return `true` when the * underlying function would return a false-y value, and `false` when it would return a truth-y one. */ export function not(value: any): boolean; /** * Returns the nth element in a list. */ export function nth(n: number, list: readonly T[]): T | undefined; export function nth(n: number): (list: readonly T[]) => T | undefined; /** * Returns a function which returns its nth argument. */ export function nthArg(n: number): (...a: readonly any[]) => any; /** * o is a curried composition function that returns a unary function. Like compose, o performs right-to-left function composition. * Unlike compose, the rightmost function passed to o will be invoked with only one argument. * Also, unlike compose, o is limited to accepting only 2 unary functions. * The name o was chosen because of its similarity to the mathematical composition operator ∘. */ export function o(f: (x: T2) => R, g: (x: T1) => T2, v: T1): R; export function o(f: (x: T2) => R, g: (x: T1) => T2): (v: T1) => R; export function o( f: (x: T2) => R, ): { (g: (x: T1) => T2, v: T1): R; (g: (x: T1) => T2): (v: T1) => R; }; /** * Creates an object containing a single key:value pair. */ export function objOf(key: K, value: T): Record; export function objOf(key: K): (value: T) => Record; /** * Returns a singleton array containing the value provided. */ export function of(x: T): T[]; /** * Returns a partial copy of an object omitting the keys specified. */ export function omit(names: readonly K[], obj: T): Omit; export function omit(names: readonly K[]): (obj: T) => Omit; /** * Accepts a function fn and returns a function that guards invocation of fn such that fn can only ever be * called once, no matter how many times the returned function is invoked. The first value calculated is * returned in subsequent invocations. */ export function once(fn: (...a: readonly any[]) => any): (...a: readonly any[]) => any; export function once(fn: (...a: readonly any[]) => T): (...a: readonly any[]) => T; /** * A function that returns the first truthy of two arguments otherwise the last argument. Note that this is * NOT short-circuited, meaning that if expressions are passed they are both evaluated. * Dispatches to the or method of the first argument if applicable. */ export function or(a: T, b: U): T | U; export function or(a: T): (b: U) => T | U; export function or any); }, U>(fn1: T, val2: U): T | U; export function or any); }>(fn1: T): (val2: U) => T | U; /** * Returns the result of applying the onFailure function to the value inside a failed promise. * This is useful for handling rejected promises inside function compositions. */ export function otherwise(onError: (error: any) => B | Promise, promise: Promise): Promise; export function otherwise(onError: (error: any) => B | Promise): (promise: Promise) => Promise; /** * Returns the result of "setting" the portion of the given data structure * focused by the given lens to the given value. */ export function over(lens: Lens, fn: Arity1Fn, value: T): T; export function over(lens: Lens, fn: Arity1Fn, value: readonly T[]): T[]; export function over(lens: Lens, fn: Arity1Fn): (value: T) => T; export function over(lens: Lens, fn: Arity1Fn): (value: readonly T[]) => T[]; export function over(lens: Lens): (fn: Arity1Fn, value: T) => T; export function over(lens: Lens): (fn: Arity1Fn, value: readonly T[]) => T[]; /** * Takes two arguments, fst and snd, and returns [fst, snd]. */ export function pair(fst: F, snd: S): [F, S]; /** * Takes a function `f` and a list of arguments, and returns a function `g`. * When applied, `g` returns the result of applying `f` to the arguments * provided initially followed by the arguments provided to `g`. */ export function partial(fn: (x0: V0, x1: V1) => T, args: [V0]): (x1: V1) => T; export function partial(fn: (x0: V0, x1: V1, x2: V2) => T, args: [V0, V1]): (x2: V2) => T; export function partial(fn: (x0: V0, x1: V1, x2: V2) => T, args: [V0]): (x1: V1, x2: V2) => T; export function partial(fn: (x0: V0, x1: V1, x2: V2, x3: V3) => T, args: [V0, V1, V2]): (x2: V3) => T; export function partial(fn: (x0: V0, x1: V1, x2: V2, x3: V3) => T, args: [V0, V1]): (x2: V2, x3: V3) => T; export function partial(fn: (x0: V0, x1: V1, x2: V2, x3: V3) => T, args: [V0]): (x1: V1, x2: V2, x3: V3) => T; export function partial(fn: (...a: readonly any[]) => T, args: readonly any[]): (...a: readonly any[]) => T; /** * Takes a function `f` and a list of arguments, and returns a function `g`. * When applied, `g` returns the result of applying `f` to the arguments * provided to `g` followed by the arguments provided initially. */ export function partialRight(fn: (x0: V0, x1: V1) => T, args: [V1]): (x1: V0) => T; export function partialRight(fn: (x0: V0, x1: V1, x2: V2) => T, args: [V1, V2]): (x2: V0) => T; export function partialRight(fn: (x0: V0, x1: V1, x2: V2) => T, args: [V2]): (x1: V0, x2: V1) => T; export function partialRight(fn: (x0: V0, x1: V1, x2: V2, x3: V3) => T, args: [V1, V2, V3]): (x0: V0) => T; export function partialRight(fn: (x0: V0, x1: V1, x2: V2, x3: V3) => T, args: [V2, V3]): (x0: V0, x1: V1) => T; export function partialRight(fn: (x0: V0, x1: V1, x2: V2, x3: V3) => T, args: [V3]): (x0: V0, x1: V1, x2: V2) => T; export function partialRight(fn: (...a: readonly any[]) => T, args: readonly any[]): (...a: readonly any[]) => T; /** * Takes a predicate and a list and returns the pair of lists of elements * which do and do not satisfy the predicate, respectively. */ export function partition(fn: (a: string) => boolean, list: readonly string[]): [string[], string[]]; export function partition(fn: (a: T) => boolean, list: readonly T[]): [T[], T[]]; export function partition(fn: (a: T) => boolean): (list: readonly T[]) => [T[], T[]]; export function partition(fn: (a: string) => boolean): (list: readonly string[]) => [string[], string[]]; /** * Retrieve the value at a given path. */ export function path(path: Path, obj: any): T | undefined; export function path(path: Path): (obj: any) => T | undefined; /** * Determines whether a nested path on an object has a specific value, * in `R.equals` terms. Most likely used to filter a list. */ export function pathEq(path: Path, val: any, obj: any): boolean; export function pathEq(path: Path, val: any): (obj: any) => boolean; export function pathEq(path: Path): _.F.Curry<(a: any, b: any) => boolean>; /** * If the given, non-null object has a value at the given path, returns the value at that path. * Otherwise returns the provided default value. */ export function pathOr(defaultValue: T, path: Path, obj: any): T; export function pathOr(defaultValue: T, path: Path): (obj: any) => T; export function pathOr(defaultValue: T): _.F.Curry<(a: Path, b: any) => T>; /** * Returns true if the specified object property at given path satisfies the given predicate; false otherwise. */ export function pathSatisfies(pred: (val: T) => boolean, path: Path, obj: U): boolean; export function pathSatisfies(pred: (val: T) => boolean, path: Path): (obj: U) => boolean; export function pathSatisfies(pred: (val: T) => boolean): _.F.Curry<(a: Path, b: U) => boolean>; /** * Returns a partial copy of an object containing only the keys specified. If the key does not exist, the * property is ignored. */ export function pick(names: readonly K[], obj: T): Pick>>; export function pick(names: readonly K[]): (obj: T) => Pick>>; /** * Similar to `pick` except that this one includes a `key: undefined` pair for properties that don't exist. */ export function pickAll(names: readonly string[], obj: T): U; export function pickAll(names: readonly string[]): (obj: T) => U; /** * Returns a partial copy of an object containing only the keys that satisfy the supplied predicate. */ export function pickBy(pred: ObjPred, obj: T): U; export function pickBy(pred: ObjPred): (obj: T) => U; /** * Creates a new function that runs each of the functions supplied as parameters in turn, * passing the return value of each function invocation to the next function invocation, * beginning with whatever arguments were passed to the initial invocation. */ // tslint:disable:max-line-length export function pipe(fn0: () => T1): () => T1; export function pipe(fn0: (x0: V0) => T1): (x0: V0) => T1; export function pipe(fn0: (x0: V0, x1: V1) => T1): (x0: V0, x1: V1) => T1; export function pipe(fn0: (x0: V0, x1: V1, x2: V2) => T1): (x0: V0, x1: V1, x2: V2) => T1; export function pipe(fn0: () => T1, fn1: (x: T1) => T2): () => T2; export function pipe(fn0: (x0: V0) => T1, fn1: (x: T1) => T2): (x0: V0) => T2; export function pipe(fn0: (x0: V0, x1: V1) => T1, fn1: (x: T1) => T2): (x0: V0, x1: V1) => T2; export function pipe(fn0: (x0: V0, x1: V1, x2: V2) => T1, fn1: (x: T1) => T2): (x0: V0, x1: V1, x2: V2) => T2; export function pipe(fn0: () => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3): () => T3; export function pipe(fn0: (x: V0) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3): (x: V0) => T3; export function pipe(fn0: (x0: V0, x1: V1) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3): (x0: V0, x1: V1) => T3; export function pipe(fn0: (x0: V0, x1: V1, x2: V2) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3): (x0: V0, x1: V1, x2: V2) => T3; export function pipe(fn0: () => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4): () => T4; export function pipe(fn0: (x: V0) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4): (x: V0) => T4; export function pipe(fn0: (x0: V0, x1: V1) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4): (x0: V0, x1: V1) => T4; export function pipe(fn0: (x0: V0, x1: V1, x2: V2) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4): (x0: V0, x1: V1, x2: V2) => T4; export function pipe(fn0: () => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5): () => T5; export function pipe(fn0: (x: V0) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5): (x: V0) => T5; export function pipe(fn0: (x0: V0, x1: V1) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5): (x0: V0, x1: V1) => T5; export function pipe(fn0: (x0: V0, x1: V1, x2: V2) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5): (x0: V0, x1: V1, x2: V2) => T5; export function pipe(fn0: () => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6): () => T6; export function pipe(fn0: (x: V0) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6): (x: V0) => T6; export function pipe(fn0: (x0: V0, x1: V1) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6): (x0: V0, x1: V1) => T6; export function pipe(fn0: (x0: V0, x1: V1, x2: V2) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6): (x0: V0, x1: V1, x2: V2) => T6; export function pipe(fn0: () => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn: (x: T6) => T7): () => T7; export function pipe(fn0: (x: V0) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn: (x: T6) => T7): (x: V0) => T7; export function pipe(fn0: (x0: V0, x1: V1) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7): (x0: V0, x1: V1) => T7; export function pipe(fn0: (x0: V0, x1: V1, x2: V2) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7): (x0: V0, x1: V1, x2: V2) => T7; export function pipe(fn0: () => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7, fn: (x: T7) => T8): () => T8; export function pipe(fn0: (x: V0) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7, fn: (x: T7) => T8): (x: V0) => T8; export function pipe(fn0: (x0: V0, x1: V1) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7, fn7: (x: T7) => T8): (x0: V0, x1: V1) => T8; export function pipe(fn0: (x0: V0, x1: V1, x2: V2) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7, fn7: (x: T7) => T8): (x0: V0, x1: V1, x2: V2) => T8; export function pipe(fn0: () => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7, fn7: (x: T7) => T8, fn8: (x: T8) => T9): () => T9; export function pipe(fn0: (x0: V0) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7, fn7: (x: T7) => T8, fn8: (x: T8) => T9): (x0: V0) => T9; export function pipe(fn0: (x0: V0, x1: V1) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7, fn7: (x: T7) => T8, fn8: (x: T8) => T9): (x0: V0, x1: V1) => T9; export function pipe(fn0: (x0: V0, x1: V1, x2: V2) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7, fn7: (x: T7) => T8, fn8: (x: T8) => T9): (x0: V0, x1: V1, x2: V2) => T9; export function pipe(fn0: () => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7, fn7: (x: T7) => T8, fn8: (x: T8) => T9, fn9: (x: T9) => T10): () => T10; export function pipe(fn0: (x0: V0) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7, fn7: (x: T7) => T8, fn8: (x: T8) => T9, fn9: (x: T9) => T10): (x0: V0) => T10; export function pipe(fn0: (x0: V0, x1: V1) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7, fn7: (x: T7) => T8, fn8: (x: T8) => T9, fn9: (x: T9) => T10): (x0: V0, x1: V1) => T10; export function pipe(fn0: (x0: V0, x1: V1, x2: V2) => T1, fn1: (x: T1) => T2, fn2: (x: T2) => T3, fn3: (x: T3) => T4, fn4: (x: T4) => T5, fn5: (x: T5) => T6, fn6: (x: T6) => T7, fn7: (x: T7) => T8, fn8: (x: T8) => T9, fn9: (x: T9) => T10): (x0: V0, x1: V1, x2: V2) => T10; // tslint:enable:max-line-length /** * Returns the left-to-right Kleisli composition of the provided functions, each of which must return a value of a type supported by chain. * The typings currently support arrays only as return values. * All functions need to be unary. * R.pipeK(f, g, h) is equivalent to R.pipe(f, R.chain(g), R.chain(h)). * * @deprecated since 0.26 in favor of pipeWith(chain) */ // tslint:disable:max-line-length export function pipeK(fn0: (x0: V0) => T1[]): (x0: V0) => T1[]; export function pipeK(fn0: (x0: V0) => T1[], fn1: (x: T1) => T2[]): (x0: V0) => T2[]; export function pipeK(fn0: (x: V0) => T1[], fn1: (x: T1) => T2[], fn2: (x: T2) => T3[]): (x: V0) => T3[]; export function pipeK(fn0: (x: V0) => T1[], fn1: (x: T1) => T2[], fn2: (x: T2) => T3[], fn3: (x: T3) => T4[]): (x: V0) => T4[]; export function pipeK(fn0: (x: V0) => T1[], fn1: (x: T1) => T2[], fn2: (x: T2) => T3[], fn3: (x: T3) => T4[], fn4: (x: T4) => T5[]): (x: V0) => T5[]; export function pipeK(fn0: (x: V0) => T1[], fn1: (x: T1) => T2[], fn2: (x: T2) => T3[], fn3: (x: T3) => T4[], fn4: (x: T4) => T5[], fn5: (x: T5) => T6[]): (x: V0) => T6[]; export function pipeK(fn0: (x: V0) => T1[], fn1: (x: T1) => T2[], fn2: (x: T2) => T3[], fn3: (x: T3) => T4[], fn4: (x: T4) => T5[], fn5: (x: T5) => T6[], fn: (x: T6) => T7[]): (x: V0) => T7[]; export function pipeK(fn0: (x: V0) => T1[], fn1: (x: T1) => T2[], fn2: (x: T2) => T3[], fn3: (x: T3) => T4[], fn4: (x: T4) => T5[], fn5: (x: T5) => T6[], fn6: (x: T6) => T7[], fn: (x: T7) => T8[]): (x: V0) => T8[]; export function pipeK(fn0: (x0: V0) => T1[], fn1: (x: T1) => T2[], fn2: (x: T2) => T3[], fn3: (x: T3) => T4[], fn4: (x: T4) => T5[], fn5: (x: T5) => T6[], fn6: (x: T6) => T7[], fn7: (x: T7) => T8[], fn8: (x: T8) => T9[]): (x0: V0) => T9[]; export function pipeK(fn0: (x0: V0) => T1[], fn1: (x: T1) => T2[], fn2: (x: T2) => T3[], fn3: (x: T3) => T4[], fn4: (x: T4) => T5[], fn5: (x: T5) => T6[], fn6: (x: T6) => T7[], fn7: (x: T7) => T8[], fn8: (x: T8) => T9[], fn9: (x: T9) => T10[]): (x0: V0) => T10[]; // tslint:enable:max-line-length /** * Performs left-to-right composition of one or more Promise-returning functions. * All functions need to be unary. * * @deprecated since 0.26 in favor of pipeWith(then) */ // tslint:disable:max-line-length export function pipeP(fn0: (x0: V0) => Promise): (x0: V0) => Promise; export function pipeP(fn0: (x0: V0) => Promise, fn1: (x: T1) => Promise): (x0: V0) => Promise; export function pipeP(fn0: (x: V0) => Promise, fn1: (x: T1) => Promise, fn2: (x: T2) => Promise): (x: V0) => Promise; export function pipeP(fn0: (x: V0) => Promise, fn1: (x: T1) => Promise, fn2: (x: T2) => Promise, fn3: (x: T3) => Promise): (x: V0) => Promise; export function pipeP(fn0: (x: V0) => Promise, fn1: (x: T1) => Promise, fn2: (x: T2) => Promise, fn3: (x: T3) => Promise, fn4: (x: T4) => Promise): (x: V0) => Promise; export function pipeP(fn0: (x: V0) => Promise, fn1: (x: T1) => Promise, fn2: (x: T2) => Promise, fn3: (x: T3) => Promise, fn4: (x: T4) => Promise, fn5: (x: T5) => Promise): (x: V0) => Promise; export function pipeP(fn0: (x: V0) => Promise, fn1: (x: T1) => Promise, fn2: (x: T2) => Promise, fn3: (x: T3) => Promise, fn4: (x: T4) => Promise, fn5: (x: T5) => Promise, fn: (x: T6) => Promise): (x: V0) => Promise; export function pipeP(fn0: (x: V0) => Promise, fn1: (x: T1) => Promise, fn2: (x: T2) => Promise, fn3: (x: T3) => Promise, fn4: (x: T4) => Promise, fn5: (x: T5) => Promise, fn6: (x: T6) => Promise, fn: (x: T7) => Promise): (x: V0) => Promise; export function pipeP(fn0: (x0: V0) => Promise, fn1: (x: T1) => Promise, fn2: (x: T2) => Promise, fn3: (x: T3) => Promise, fn4: (x: T4) => Promise, fn5: (x: T5) => Promise, fn6: (x: T6) => Promise, fn7: (x: T7) => Promise, fn8: (x: T8) => Promise): (x0: V0) => Promise; export function pipeP(fn0: (x0: V0) => Promise, fn1: (x: T1) => Promise, fn2: (x: T2) => Promise, fn3: (x: T3) => Promise, fn4: (x: T4) => Promise, fn5: (x: T5) => Promise, fn6: (x: T6) => Promise, fn7: (x: T7) => Promise, fn8: (x: T8) => Promise, fn9: (x: T9) => Promise): (x0: V0) => Promise; // tslint:enable:max-line-length /* * Performs left-to-right function composition using transforming function. * With the current typings, all functions must be unary. */ export function pipeWith(composer: (a: any) => any, fns: PipeWithFns): (x0: V0) => T; export function pipeWith(composer: (a: any) => any): (fns: PipeWithFns) => (x0: V0) => T; /** * Returns a new list by plucking the same named property off all objects in the list supplied. */ export function pluck(p: K, list: readonly T[]): Array; export function pluck(p: number, list: Array<{ [k: number]: T }>): T[]; export function pluck