SortedMap
Constructors
Signature
declare function empty<K, V = never>(ord: Order<K>): SortedMap<K, V>fromIterable
Added in v2.0.0
Source
Creates a new SortedMap from an iterable collection of key/value pairs.
Signature
declare const fromIterable: { <B>(ord: Order<B>): <K, V>(iterable: Iterable<readonly [K, V]>) => SortedMap<K, V>; <K, V, B>(iterable: Iterable<readonly [K, V]>, ord: Order<B>): SortedMap<K, V>;}Signature
declare function make<K>(ord: Order<K>): <Entries extends readonly Array<readonly [K, any]>>(...entries: Entries) => SortedMap<K, Entries[number] extends readonly [any, V] ? V : never>Elements
Signature
declare const get: { <K>(key: K): <V>(self: SortedMap<K, V>) => Option<V>; <K, V>(self: SortedMap<K, V>, key: K): Option<V>;}Signature
declare const has: { <K>(key: K): <V>(self: SortedMap<K, V>) => boolean; <K, V>(self: SortedMap<K, V>, key: K): boolean;}headOption
Added in v2.0.0
Source
Signature
declare function headOption<K, V>(self: SortedMap<K, V>): Option<[K, V]>lastOption
Added in v3.1.0
Source
Signature
declare function lastOption<K, V>(self: SortedMap<K, V>): Option<[K, V]>Signature
declare const remove: { <K>(key: K): <V>(self: SortedMap<K, V>) => SortedMap<K, V>; <K, V>(self: SortedMap<K, V>, key: K): SortedMap<K, V>;}Signature
declare const set: { <K, V>(key: K, value: V): (self: SortedMap<K, V>) => SortedMap<K, V>; <K, V>(self: SortedMap<K, V>, key: K, value: V): SortedMap<K, V>;}Filtering
Signature
declare const partition: { <K, V>(predicate: (a: NoInfer<K>) => boolean): (self: SortedMap<K, V>) => [excluded: SortedMap<K, V>, satisfying: SortedMap<K, V>]; <K, V>(self: SortedMap<K, V>, predicate: (a: K) => boolean): [excluded: SortedMap<K, V>, satisfying: SortedMap<K, V>];}Folding
Getters
Signature
declare function entries<K, V>(self: SortedMap<K, V>): IterableIterator<[K, V]>Gets the Order<K> that the SortedMap<K, V> is using.
Signature
declare function getOrder<K, V>(self: SortedMap<K, V>): Order<K>Signature
declare function keys<K, V>(self: SortedMap<K, V>): IterableIterator<K>Signature
declare function size<K, V>(self: SortedMap<K, V>): numberSignature
declare function values<K, V>(self: SortedMap<K, V>): IterableIterator<V>Mapping
Models
Predicates
Signature
declare function isEmpty<K, V>(self: SortedMap<K, V>): booleanisNonEmpty
Added in v2.0.0
Source
Signature
declare function isNonEmpty<K, V>(self: SortedMap<K, V>): booleanRefinements
isSortedMap
Added in v2.0.0
Source
Signature
declare const isSortedMap: { <K, V>(u: Iterable<readonly [K, V]>): u is SortedMap<K, V>; (u: unknown): u is SortedMap<unknown, unknown>;}