- Compactable
- Filterable
- Functor
- getDifferenceMagma
- getEq
- getFunctorWithIndex
- getIntersectionSemigroup
- getMonoid
- getShow
- getUnionMonoid
- getUnionSemigroup
- foldMap
- foldMapWithIndex
- getFoldable
- getFoldableWithIndex
- reduce
- reduceRight
- reduceRightWithIndex
- reduceWithIndex
- collect
- deleteAt
- difference
- elem
- empty
- filterMapWithIndex
- filterWithIndex
insertAt(deprecated)- intersection
- isEmpty
- isSubmap
- keys
- lookup
- lookupWithKey
- member
- modifyAt
- partitionMapWithIndex
- partitionWithIndex
- pop
readonlyMap(deprecated)- size
- union
- updateAt
- upsertAt
- values
export declare const Compactable: Compactable2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Filterable: Filterable2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Functor: Functor2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const getDifferenceMagma: <K>(E: Eq<K>) => <A>() => Magma<ReadonlyMap<K, A>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function getEq<K, A>(SK: Eq<K>, SA: Eq<A>): Eq<ReadonlyMap<K, A>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const getFunctorWithIndex: <K = never>() => FunctorWithIndex2C<'ReadonlyMap', K, K>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const getIntersectionSemigroup: <K, A>(E: Eq<K>, S: Semigroup<A>) => Semigroup<ReadonlyMap<K, A>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Gets Monoid
instance for Maps given Semigroup
instance for their values
export declare function getMonoid<K, A>(SK: Eq<K>, SA: Semigroup<A>): Monoid<ReadonlyMap<K, A>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function getShow<K, A>(SK: Show<K>, SA: Show<A>): Show<ReadonlyMap<K, A>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const getUnionMonoid: <K, A>(E: Eq<K>, S: Semigroup<A>) => Monoid<ReadonlyMap<K, A>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const getUnionSemigroup: <K, A>(E: Eq<K>, S: Semigroup<A>) => Semigroup<ReadonlyMap<K, A>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Create a map from a foldable collection of key/value pairs, using the specified Magma
to combine values for duplicate keys.
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, readonly [K, A]>) => ReadonlyMap<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, readonly [K, A]>) => ReadonlyMap<K, A>
export declare function fromFoldable<F extends URIS, K, A>(
E: Eq<K>,
M: Magma<A>,
F: Foldable1<F>,
): (fka: Kind<F, readonly [K, A]>) => ReadonlyMap<K, A>
export declare function fromFoldable<F, K, A>(
E: Eq<K>,
M: Magma<A>,
F: Foldable<F>,
): (fka: HKT<F, readonly [K, A]>) => ReadonlyMap<K, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Create a map with one key/value pair
export declare const singleton: <K, A>(k: K, a: A) => ReadonlyMap<K, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromMap: <K, A>(m: Map<K, A>) => ReadonlyMap<K, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function toMap<K, A>(m: ReadonlyMap<K, A>): Map<K, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Get a sorted ReadonlyArray
of the key/value pairs contained in a ReadonlyMap
.
export declare const toReadonlyArray: <K>(O: Ord<K>) => <A>(m: ReadonlyMap<K, A>) => readonly (readonly [K, A])[]
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Unfolds a map into a list of key/value pairs
export declare function toUnfoldable<K, F extends URIS>(
ord: Ord<K>,
U: Unfoldable1<F>,
): <A>(d: ReadonlyMap<K, A>) => Kind<F, readonly [K, A]>
export declare function toUnfoldable<K, F>(
ord: Ord<K>,
U: Unfoldable<F>,
): <A>(d: ReadonlyMap<K, A>) => HKT<F, readonly [K, A]>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const compact: <K, A>(fa: ReadonlyMap<K, O.Option<A>>) => ReadonlyMap<K, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const filter: {
<A, B extends A>(refinement: Refinement<A, B>): <K>(fa: ReadonlyMap<K, A>) => ReadonlyMap<K, B>
<A>(predicate: Predicate<A>): <K, B extends A>(fb: ReadonlyMap<K, B>) => ReadonlyMap<K, B>
<A>(predicate: Predicate<A>): <K>(fa: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const filterMap: <A, B>(f: (a: A) => Option<B>) => <K>(fa: ReadonlyMap<K, A>) => ReadonlyMap<K, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function getFilterableWithIndex<K = never>(): FilterableWithIndex2C<URI, K, K>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function getWitherable<K>(O: Ord<K>): Witherable2C<URI, K> & TraversableWithIndex2C<URI, K, K>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const partition: {
<A, B extends A>(
refinement: Refinement<A, B>,
): <K>(fa: ReadonlyMap<K, A>) => Separated<ReadonlyMap<K, A>, ReadonlyMap<K, B>>
<A>(
predicate: Predicate<A>,
): <K, B extends A>(fb: ReadonlyMap<K, B>) => Separated<ReadonlyMap<K, B>, ReadonlyMap<K, B>>
<A>(predicate: Predicate<A>): <K>(fa: ReadonlyMap<K, A>) => Separated<ReadonlyMap<K, A>, ReadonlyMap<K, A>>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const partitionMap: <A, B, C>(
f: (a: A) => Either<B, C>,
) => <K>(fa: ReadonlyMap<K, A>) => Separated<ReadonlyMap<K, B>, ReadonlyMap<K, C>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const separate: <K, A, B>(
fa: ReadonlyMap<K, Either<A, B>>,
) => Separated<ReadonlyMap<K, A>, ReadonlyMap<K, B>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const foldMap: <K>(O: Ord<K>) => <M>(M: Monoid<M>) => <A>(f: (a: A) => M) => (m: ReadonlyMap<K, A>) => M
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const foldMapWithIndex: <K>(
O: Ord<K>,
) => <M>(M: Monoid<M>) => <A>(f: (k: K, a: A) => M) => (m: ReadonlyMap<K, A>) => M
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const getFoldable: <K>(O: Ord<K>) => Foldable2C<'ReadonlyMap', K>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const getFoldableWithIndex: <K>(O: Ord<K>) => FoldableWithIndex2C<'ReadonlyMap', K, K>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const reduce: <K>(O: Ord<K>) => <B, A>(b: B, f: (b: B, a: A) => B) => (m: ReadonlyMap<K, A>) => B
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const reduceRight: <K>(O: Ord<K>) => <B, A>(b: B, f: (a: A, b: B) => B) => (m: ReadonlyMap<K, A>) => B
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const reduceRightWithIndex: <K>(
O: Ord<K>,
) => <B, A>(b: B, f: (k: K, a: A, b: B) => B) => (m: ReadonlyMap<K, A>) => B
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const reduceWithIndex: <K>(
O: Ord<K>,
) => <B, A>(b: B, f: (k: K, b: B, a: A) => B) => (m: ReadonlyMap<K, A>) => B
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flap: <A>(a: A) => <E, B>(fab: ReadonlyMap<E, (a: A) => B>) => ReadonlyMap<E, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
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.
export declare const map: <A, B>(f: (a: A) => B) => <K>(fa: ReadonlyMap<K, A>) => ReadonlyMap<K, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const mapWithIndex: <K, A, B>(f: (k: K, a: A) => B) => (fa: ReadonlyMap<K, A>) => ReadonlyMap<K, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const getTraversable: <K>(O: Ord<K>) => Traversable2C<'ReadonlyMap', K>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const getTraversableWithIndex: <K>(O: Ord<K>) => TraversableWithIndex2C<'ReadonlyMap', K, K>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export type URI = typeof URI
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const URI = 'ReadonlyMap'
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function collect<K>(
O: Ord<K>,
): <A, B>(f: (k: K, a: A) => B) => (m: ReadonlyMap<K, A>) => ReadonlyArray<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Delete a key and value from a map
export declare const deleteAt: <K>(E: Eq<K>) => (k: K) => <A>(m: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const difference: <K>(
E: Eq<K>,
) => <A>(_second: ReadonlyMap<K, A>) => (first: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Test whether or not a value is a member of a map
export declare function elem<A>(E: Eq<A>): {
(a: A): <K>(m: ReadonlyMap<K, A>) => boolean
<K>(a: A, m: ReadonlyMap<K, A>): boolean
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const empty: ReadonlyMap<never, never>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const filterMapWithIndex: <K, A, B>(
f: (k: K, a: A) => O.Option<B>,
) => (fa: ReadonlyMap<K, A>) => ReadonlyMap<K, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function filterWithIndex<K, A, B extends A>(
predicateWithIndex: (k: K, a: A) => a is B,
): (m: ReadonlyMap<K, A>) => ReadonlyMap<K, B>
export declare function filterWithIndex<K, A>(
predicateWithIndex: (k: K, a: A) => boolean,
): <B extends A>(m: ReadonlyMap<K, B>) => ReadonlyMap<K, B>
export declare function filterWithIndex<K, A>(
predicateWithIndex: (k: K, a: A) => boolean,
): (m: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Use upsertAt
instead.
export declare const insertAt: <K>(E: Eq<K>) => <A>(k: K, a: A) => (m: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
- Added in 0.1.0
- Deprecated
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const intersection: <K, A>(
E: Eq<K>,
M: Magma<A>,
) => (second: ReadonlyMap<K, A>) => (first: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Test whether or not a map is empty
export declare const isEmpty: <K, A>(m: ReadonlyMap<K, A>) => boolean
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Test whether or not one Map
contains all of the keys and values contained in another Map
export declare function isSubmap<K, A>(
SK: Eq<K>,
SA: Eq<A>,
): {
(that: ReadonlyMap<K, A>): (me: ReadonlyMap<K, A>) => boolean
(me: ReadonlyMap<K, A>, that: ReadonlyMap<K, A>): boolean
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Get a sorted ReadonlyArray
of the keys contained in a ReadonlyMap
.
export declare const keys: <K>(O: Ord<K>) => <A>(m: ReadonlyMap<K, A>) => readonly K[]
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Lookup the value for a key in a Map
.
export declare function lookup<K>(E: Eq<K>): {
(k: K): <A>(m: ReadonlyMap<K, A>) => Option<A>
<A>(k: K, m: ReadonlyMap<K, A>): Option<A>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Lookup the value for a key in a Map
. If the result is a Some
, the existing key is also returned.
export declare function lookupWithKey<K>(E: Eq<K>): {
(k: K): <A>(m: ReadonlyMap<K, A>) => Option<readonly [K, A]>
<A>(k: K, m: ReadonlyMap<K, A>): Option<readonly [K, A]>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Test whether or not a key exists in a map
export declare function member<K>(E: Eq<K>): {
(k: K): <A>(m: ReadonlyMap<K, A>) => boolean
<A>(k: K, m: ReadonlyMap<K, A>): boolean
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const modifyAt: <K>(
E: Eq<K>,
) => <A>(k: K, f: (a: A) => A) => (m: ReadonlyMap<K, A>) => O.Option<ReadonlyMap<K, A>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const partitionMapWithIndex: <K, A, B, C>(
f: (k: K, a: A) => Either<B, C>,
) => (fa: ReadonlyMap<K, A>) => Separated<ReadonlyMap<K, B>, ReadonlyMap<K, C>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare function partitionWithIndex<K, A, B extends A>(
predicateWithIndex: (k: K, a: A) => a is B,
): (m: ReadonlyMap<K, A>) => Separated<ReadonlyMap<K, A>, ReadonlyMap<K, B>>
export declare function partitionWithIndex<K, A>(
predicateWithIndex: (k: K, a: A) => boolean,
): <B extends A>(m: ReadonlyMap<K, B>) => Separated<ReadonlyMap<K, B>, ReadonlyMap<K, B>>
export declare function partitionWithIndex<K, A>(
predicateWithIndex: (k: K, a: A) => boolean,
): (m: ReadonlyMap<K, A>) => Separated<ReadonlyMap<K, A>, ReadonlyMap<K, A>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Delete a key and value from a map, returning the value as well as the subsequent map
export declare function pop<K>(E: Eq<K>): (k: K) => <A>(m: ReadonlyMap<K, A>) => Option<readonly [A, ReadonlyMap<K, A>]>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
This instance is deprecated, use small, specific instances instead. For example if a function needs a Functor
instance, pass RM.Functor
instead of RM.readonlyMap
(where RM
is from import RM from 'fp-ts/ReadonlyMap'
)
export declare const readonlyMap: Filterable2<URI>
- Added in 0.1.0
- Deprecated
- MIT – Copyright (c) 2017-present Giulio Canti
Calculate the number of key/value pairs in a map
export declare const size: <K, A>(m: ReadonlyMap<K, A>) => number
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const union: <K, A>(
E: Eq<K>,
M: Magma<A>,
) => (second: ReadonlyMap<K, A>) => (first: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const updateAt: <K>(E: Eq<K>) => <A>(k: K, a: A) => (m: ReadonlyMap<K, A>) => O.Option<ReadonlyMap<K, A>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Insert or replace a key/value pair in a ReadonlyMap
.
export declare const upsertAt: <K>(E: Eq<K>) => <A>(k: K, a: A) => (m: ReadonlyMap<K, A>) => ReadonlyMap<K, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Get a sorted ReadonlyArray
of the values contained in a ReadonlyMap
.
export declare const values: <A>(O: Ord<A>) => <K>(m: ReadonlyMap<K, A>) => readonly A[]
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti