422 lines
12 KiB
TypeScript
422 lines
12 KiB
TypeScript
|
import { Compactable2 } from './Compactable'
|
||
|
|
import { Either } from './Either'
|
||
|
|
import { Eq } from './Eq'
|
||
|
|
import { Filterable2 } from './Filterable'
|
||
|
|
import { FilterableWithIndex2C } from './FilterableWithIndex'
|
||
|
|
import { Foldable, Foldable1, Foldable2, Foldable2C, Foldable3 } from './Foldable'
|
||
|
|
import { FoldableWithIndex2C } from './FoldableWithIndex'
|
||
|
|
import { Functor2 } from './Functor'
|
||
|
|
import { HKT, Kind, Kind2, Kind3, URIS, URIS2, URIS3 } from './HKT'
|
||
|
|
import { Magma } from './Magma'
|
||
|
|
import { Monoid } from './Monoid'
|
||
|
|
import * as O from './Option'
|
||
|
|
import { Ord } from './Ord'
|
||
|
|
import { Predicate } from './Predicate'
|
||
|
|
import { Refinement } from './Refinement'
|
||
|
|
import { Semigroup } from './Semigroup'
|
||
|
|
import { Separated } from './Separated'
|
||
|
|
import { Show } from './Show'
|
||
|
|
import { TraversableWithIndex2C } from './TraversableWithIndex'
|
||
|
|
import { Unfoldable, Unfoldable1 } from './Unfoldable'
|
||
|
|
import { Witherable2C } from './Witherable'
|
||
|
|
import Option = O.Option
|
||
|
|
/**
|
||
|
|
* @category instances
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const getShow: <K, A>(SK: Show<K>, SA: Show<A>) => Show<Map<K, A>>
|
||
|
|
/**
|
||
|
|
* Calculate the number of key/value pairs in a map
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const size: <K, A>(m: Map<K, A>) => number
|
||
|
|
/**
|
||
|
|
* Test whether or not a map is empty
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const isEmpty: <K, A>(m: Map<K, A>) => boolean
|
||
|
|
/**
|
||
|
|
* Test whether or not a key exists in a map
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const member: <K>(E: Eq<K>) => {
|
||
|
|
(k: K): <A>(m: Map<K, A>) => boolean
|
||
|
|
<A>(k: K, m: Map<K, A>): boolean
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Test whether or not a value is a member of a map
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const elem: <A>(E: Eq<A>) => {
|
||
|
|
(a: A): <K>(m: Map<K, A>) => boolean
|
||
|
|
<K>(a: A, m: Map<K, A>): boolean
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Get a sorted `Array` of the keys contained in a `Map`.
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const keys: <K>(O: Ord<K>) => <A>(m: Map<K, A>) => K[]
|
||
|
|
/**
|
||
|
|
* Get a sorted `Array` of the values contained in a `Map`.
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const values: <A>(O: Ord<A>) => <K>(m: Map<K, A>) => A[]
|
||
|
|
/**
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare function collect<K>(O: Ord<K>): <A, B>(f: (k: K, a: A) => B) => (m: Map<K, A>) => Array<B>
|
||
|
|
/**
|
||
|
|
* Get a sorted `Array` of the key/value pairs contained in a `Map`.
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare function toArray<K>(O: Ord<K>): <A>(m: Map<K, A>) => Array<[K, A]>
|
||
|
|
/**
|
||
|
|
* Unfolds a map into a list of key/value pairs
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare function toUnfoldable<K, F extends URIS>(
|
||
|
|
ord: Ord<K>,
|
||
|
|
U: Unfoldable1<F>
|
||
|
|
): <A>(d: Map<K, A>) => Kind<F, [K, A]>
|
||
|
|
export declare function toUnfoldable<K, F>(ord: Ord<K>, U: Unfoldable<F>): <A>(d: Map<K, A>) => HKT<F, [K, A]>
|
||
|
|
/**
|
||
|
|
* Insert or replace a key/value pair in a `Map`.
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const upsertAt: <K>(E: Eq<K>) => <A>(k: K, a: A) => (m: Map<K, A>) => Map<K, A>
|
||
|
|
/**
|
||
|
|
* Delete a key and value from a map
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const deleteAt: <K>(E: Eq<K>) => (k: K) => <A>(m: Map<K, A>) => Map<K, A>
|
||
|
|
/**
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const updateAt: <K>(E: Eq<K>) => <A>(k: K, a: A) => (m: Map<K, A>) => O.Option<Map<K, A>>
|
||
|
|
/**
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const modifyAt: <K>(E: Eq<K>) => <A>(k: K, f: (a: A) => A) => (m: Map<K, A>) => O.Option<Map<K, A>>
|
||
|
|
/**
|
||
|
|
* Delete a key and value from a map, returning the value as well as the subsequent map
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare function pop<K>(E: Eq<K>): (k: K) => <A>(m: Map<K, A>) => Option<[A, Map<K, A>]>
|
||
|
|
/**
|
||
|
|
* Lookup the value for a key in a `Map`.
|
||
|
|
* If the result is a `Some`, the existing key is also returned.
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare function lookupWithKey<K>(E: Eq<K>): {
|
||
|
|
(k: K): <A>(m: Map<K, A>) => Option<[K, A]>
|
||
|
|
<A>(k: K, m: Map<K, A>): Option<[K, A]>
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Lookup the value for a key in a `Map`.
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const lookup: <K>(E: Eq<K>) => {
|
||
|
|
(k: K): <A>(m: Map<K, A>) => Option<A>
|
||
|
|
<A>(k: K, m: Map<K, A>): Option<A>
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Test whether or not one `Map` contains all of the keys and values contained in another `Map`
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const isSubmap: <K, A>(
|
||
|
|
SK: Eq<K>,
|
||
|
|
SA: Eq<A>
|
||
|
|
) => {
|
||
|
|
(that: Map<K, A>): (me: Map<K, A>) => boolean
|
||
|
|
(me: Map<K, A>, that: Map<K, A>): boolean
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* @category instances
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const getEq: <K, A>(SK: Eq<K>, SA: Eq<A>) => Eq<Map<K, A>>
|
||
|
|
/**
|
||
|
|
* Gets `Monoid` instance for Maps given `Semigroup` instance for their values
|
||
|
|
*
|
||
|
|
* @category instances
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare function getMonoid<K, A>(SK: Eq<K>, SA: Semigroup<A>): Monoid<Map<K, A>>
|
||
|
|
/**
|
||
|
|
* Create a map with one key/value pair
|
||
|
|
*
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const singleton: <K, A>(k: K, a: A) => Map<K, A>
|
||
|
|
/**
|
||
|
|
* Create a map from a foldable collection of key/value pairs, using the
|
||
|
|
* specified `Magma` to combine values for duplicate keys.
|
||
|
|
*
|
||
|
|
* @category constructors
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare function fromFoldable<F extends URIS3, K, A>(
|
||
|
|
E: Eq<K>,
|
||
|
|
M: Magma<A>,
|
||
|
|
F: Foldable3<F>
|
||
|
|
): <R, E>(fka: Kind3<F, R, E, [K, A]>) => Map<K, A>
|
||
|
|
export declare function fromFoldable<F extends URIS2, K, A>(
|
||
|
|
E: Eq<K>,
|
||
|
|
M: Magma<A>,
|
||
|
|
F: Foldable2<F>
|
||
|
|
): <E>(fka: Kind2<F, E, [K, A]>) => Map<K, A>
|
||
|
|
export declare function fromFoldable<F extends URIS, K, A>(
|
||
|
|
E: Eq<K>,
|
||
|
|
M: Magma<A>,
|
||
|
|
F: Foldable1<F>
|
||
|
|
): (fka: Kind<F, [K, A]>) => Map<K, A>
|
||
|
|
export declare function fromFoldable<F, K, A>(E: Eq<K>, M: Magma<A>, F: Foldable<F>): (fka: HKT<F, [K, A]>) => Map<K, A>
|
||
|
|
/**
|
||
|
|
* @since 2.10.0
|
||
|
|
*/
|
||
|
|
export declare const partitionMapWithIndex: <K, A, B, C>(
|
||
|
|
f: (k: K, a: A) => Either<B, C>
|
||
|
|
) => (fa: Map<K, A>) => Separated<Map<K, B>, Map<K, C>>
|
||
|
|
/**
|
||
|
|
* @since 2.10.0
|
||
|
|
*/
|
||
|
|
export declare function partitionWithIndex<K, A, B extends A>(
|
||
|
|
predicateWithIndex: (k: K, a: A) => a is B
|
||
|
|
): (fa: Map<K, A>) => Separated<Map<K, A>, Map<K, B>>
|
||
|
|
export declare function partitionWithIndex<K, A>(
|
||
|
|
predicateWithIndex: (k: K, a: A) => boolean
|
||
|
|
): <B extends A>(fb: Map<K, B>) => Separated<Map<K, B>, Map<K, B>>
|
||
|
|
export declare function partitionWithIndex<K, A>(
|
||
|
|
predicateWithIndex: (k: K, a: A) => boolean
|
||
|
|
): (fa: Map<K, A>) => Separated<Map<K, A>, Map<K, A>>
|
||
|
|
/**
|
||
|
|
* @since 2.10.0
|
||
|
|
*/
|
||
|
|
export declare const filterMapWithIndex: <K, A, B>(f: (k: K, a: A) => O.Option<B>) => (fa: Map<K, A>) => Map<K, B>
|
||
|
|
/**
|
||
|
|
* @since 2.10.0
|
||
|
|
*/
|
||
|
|
export declare function filterWithIndex<K, A, B extends A>(p: (k: K, a: A) => a is B): (m: Map<K, A>) => Map<K, B>
|
||
|
|
export declare function filterWithIndex<K, A>(p: (k: K, a: A) => boolean): <B extends A>(m: Map<K, B>) => Map<K, B>
|
||
|
|
export declare function filterWithIndex<K, A>(p: (k: K, a: A) => boolean): (m: Map<K, A>) => Map<K, A>
|
||
|
|
/**
|
||
|
|
* @category filtering
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const compact: <K, A>(fa: Map<K, O.Option<A>>) => Map<K, A>
|
||
|
|
/**
|
||
|
|
* @category filtering
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const filter: {
|
||
|
|
<A, B extends A>(refinement: Refinement<A, B>): <K>(fa: Map<K, A>) => Map<K, B>
|
||
|
|
<A>(predicate: Predicate<A>): <K, B extends A>(fb: Map<K, B>) => Map<K, B>
|
||
|
|
<A>(predicate: Predicate<A>): <K>(fa: Map<K, A>) => Map<K, A>
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* @category filtering
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const filterMap: <A, B>(f: (a: A) => Option<B>) => <K>(fa: Map<K, A>) => Map<K, B>
|
||
|
|
/**
|
||
|
|
* `map` can be used to turn functions `(a: A) => B` into functions `(fa: F<A>) => F<B>` whose argument and return types
|
||
|
|
* use the type constructor `F` to represent some computational context.
|
||
|
|
*
|
||
|
|
* @category mapping
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const map: <A, B>(f: (a: A) => B) => <K>(fa: Map<K, A>) => Map<K, B>
|
||
|
|
/**
|
||
|
|
* @category mapping
|
||
|
|
* @since 2.7.1
|
||
|
|
*/
|
||
|
|
export declare const mapWithIndex: <K, A, B>(f: (k: K, a: A) => B) => (fa: Map<K, A>) => Map<K, B>
|
||
|
|
/**
|
||
|
|
* @category filtering
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const partition: {
|
||
|
|
<A, B extends A>(refinement: Refinement<A, B>): <K>(fa: Map<K, A>) => Separated<Map<K, A>, Map<K, B>>
|
||
|
|
<A>(predicate: Predicate<A>): <K, B extends A>(fb: Map<K, B>) => Separated<Map<K, B>, Map<K, B>>
|
||
|
|
<A>(predicate: Predicate<A>): <K>(fa: Map<K, A>) => Separated<Map<K, A>, Map<K, A>>
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* @category filtering
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const partitionMap: <A, B, C>(
|
||
|
|
f: (a: A) => Either<B, C>
|
||
|
|
) => <K>(fa: Map<K, A>) => Separated<Map<K, B>, Map<K, C>>
|
||
|
|
/**
|
||
|
|
* @category filtering
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const separate: <K, A, B>(fa: Map<K, Either<A, B>>) => Separated<Map<K, A>, Map<K, B>>
|
||
|
|
/**
|
||
|
|
* @category type lambdas
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare const URI = 'Map'
|
||
|
|
/**
|
||
|
|
* @category type lambdas
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare type URI = typeof URI
|
||
|
|
declare module './HKT' {
|
||
|
|
interface URItoKind2<E, A> {
|
||
|
|
readonly [URI]: Map<E, A>
|
||
|
|
}
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* @category instances
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const getUnionSemigroup: <K, A>(E: Eq<K>, S: Semigroup<A>) => Semigroup<Map<K, A>>
|
||
|
|
/**
|
||
|
|
* @category instances
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const getUnionMonoid: <K, A>(E: Eq<K>, S: Semigroup<A>) => Monoid<Map<K, A>>
|
||
|
|
/**
|
||
|
|
* @category instances
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const getIntersectionSemigroup: <K, A>(E: Eq<K>, S: Semigroup<A>) => Semigroup<Map<K, A>>
|
||
|
|
/**
|
||
|
|
* @category instances
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const getDifferenceMagma: <K>(E: Eq<K>) => <A>() => Magma<Map<K, A>>
|
||
|
|
/**
|
||
|
|
* @category filtering
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare function getFilterableWithIndex<K = never>(): FilterableWithIndex2C<URI, K, K>
|
||
|
|
/**
|
||
|
|
* @category filtering
|
||
|
|
* @since 2.0.0
|
||
|
|
*/
|
||
|
|
export declare function getWitherable<K>(O: Ord<K>): Witherable2C<URI, K> & TraversableWithIndex2C<URI, K, K>
|
||
|
|
/**
|
||
|
|
* @category folding
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const reduce: <K>(O: Ord<K>) => <B, A>(b: B, f: (b: B, a: A) => B) => (m: Map<K, A>) => B
|
||
|
|
/**
|
||
|
|
* @category folding
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const foldMap: <K>(O: Ord<K>) => <M>(M: Monoid<M>) => <A>(f: (a: A) => M) => (m: Map<K, A>) => M
|
||
|
|
/**
|
||
|
|
* @category folding
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const reduceRight: <K>(O: Ord<K>) => <B, A>(b: B, f: (a: A, b: B) => B) => (m: Map<K, A>) => B
|
||
|
|
/**
|
||
|
|
* @category folding
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const getFoldable: <K>(O: Ord<K>) => Foldable2C<'Map', K>
|
||
|
|
/**
|
||
|
|
* @category folding
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const reduceWithIndex: <K>(O: Ord<K>) => <B, A>(b: B, f: (k: K, b: B, a: A) => B) => (m: Map<K, A>) => B
|
||
|
|
/**
|
||
|
|
* @category folding
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const foldMapWithIndex: <K>(
|
||
|
|
O: Ord<K>
|
||
|
|
) => <M>(M: Monoid<M>) => <A>(f: (k: K, a: A) => M) => (m: Map<K, A>) => M
|
||
|
|
/**
|
||
|
|
* @category folding
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const reduceRightWithIndex: <K>(
|
||
|
|
O: Ord<K>
|
||
|
|
) => <B, A>(b: B, f: (k: K, a: A, b: B) => B) => (m: Map<K, A>) => B
|
||
|
|
/**
|
||
|
|
* @category folding
|
||
|
|
* @since 2.10.0
|
||
|
|
*/
|
||
|
|
export declare const getFoldableWithIndex: <K>(O: Ord<K>) => FoldableWithIndex2C<'Map', K, K>
|
||
|
|
/**
|
||
|
|
* @category traversing
|
||
|
|
* @since 2.10.0
|
||
|
|
*/
|
||
|
|
export declare const getTraversableWithIndex: <K>(O: Ord<K>) => TraversableWithIndex2C<'Map', K, K>
|
||
|
|
/**
|
||
|
|
* @category instances
|
||
|
|
* @since 2.7.0
|
||
|
|
*/
|
||
|
|
export declare const Functor: Functor2<URI>
|
||
|
|
/**
|
||
|
|
* @category mapping
|
||
|
|
* @since 2.10.0
|
||
|
|
*/
|
||
|
|
export declare const flap: <A>(a: A) => <E, B>(fab: Map<E, (a: A) => B>) => Map<E, B>
|
||
|
|
/**
|
||
|
|
* @category instances
|
||
|
|
* @since 2.7.0
|
||
|
|
*/
|
||
|
|
export declare const Compactable: Compactable2<URI>
|
||
|
|
/**
|
||
|
|
* @category instances
|
||
|
|
* @since 2.7.0
|
||
|
|
*/
|
||
|
|
export declare const Filterable: Filterable2<URI>
|
||
|
|
/**
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const union: <K, A>(E: Eq<K>, M: Magma<A>) => (second: Map<K, A>) => (first: Map<K, A>) => Map<K, A>
|
||
|
|
/**
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const intersection: <K, A>(
|
||
|
|
E: Eq<K>,
|
||
|
|
M: Magma<A>
|
||
|
|
) => (second: Map<K, A>) => (first: Map<K, A>) => Map<K, A>
|
||
|
|
/**
|
||
|
|
* @since 2.11.0
|
||
|
|
*/
|
||
|
|
export declare const difference: <K>(E: Eq<K>) => <A>(_second: Map<K, A>) => (first: Map<K, A>) => Map<K, A>
|
||
|
|
/**
|
||
|
|
* Use a `new Map()` instead.
|
||
|
|
*
|
||
|
|
* @category zone of death
|
||
|
|
* @since 2.0.0
|
||
|
|
* @deprecated
|
||
|
|
*/
|
||
|
|
export declare const empty: Map<never, never>
|
||
|
|
/**
|
||
|
|
* Use [`upsertAt`](#upsertat) instead.
|
||
|
|
*
|
||
|
|
* @category zone of death
|
||
|
|
* @since 2.0.0
|
||
|
|
* @deprecated
|
||
|
|
*/
|
||
|
|
export declare const insertAt: <K>(E: Eq<K>) => <A>(k: K, a: A) => (m: Map<K, A>) => Map<K, A>
|
||
|
|
/**
|
||
|
|
* Use [`Filterable`](#filterable) instead.
|
||
|
|
*
|
||
|
|
* @category zone of death
|
||
|
|
* @since 2.0.0
|
||
|
|
* @deprecated
|
||
|
|
*/
|
||
|
|
export declare const map_: Filterable2<URI>
|