Skip to content

SortedSet

24 exports Added in v2.0.0 Source

Constructors

empty

Added in v2.0.0 Source

Signature

declare function empty<A>(O: Order<A>): SortedSet<A>;

fromIterable

Added in v2.0.0 Source

Creates a new SortedSet from an iterable collection of values.

Signature

declare const fromIterable: {
  <B>(ord: Order<B>): <A>(iterable: Iterable<A>) => SortedSet<A>;
  <A, B>(iterable: Iterable<A>, ord: Order<B>): SortedSet<A>;
};

make

Added in v2.0.0 Source

Signature

declare function make<K>(ord: Order<K>): <Entries extends readonly Array<K>>(...entries: Entries) => SortedSet<Entries[number]>

Elements

add

Added in v2.0.0 Source

Signature

declare const add: {
  <A>(value: A): (self: SortedSet<A>) => SortedSet<A>;
  <A>(self: SortedSet<A>, value: A): SortedSet<A>;
};

every

Added in v2.0.0 Source

Check if a predicate holds true for every SortedSet element.

Signature

declare const every: {
  <A>(predicate: Predicate<A>): (self: SortedSet<A>) => boolean;
  <A>(self: SortedSet<A>, predicate: Predicate<A>): boolean;
};

has

Added in v2.0.0 Source

Signature

declare const has: {
  <A>(value: A): (self: SortedSet<A>) => boolean;
  <A>(self: SortedSet<A>, value: A): boolean;
};

isSubset

Added in v2.0.0 Source

Signature

declare const isSubset: {
  <A>(that: SortedSet<A>): (self: SortedSet<A>) => boolean;
  <A>(self: SortedSet<A>, that: SortedSet<A>): boolean;
};

remove

Added in v2.0.0 Source

Signature

declare const remove: {
  <A>(value: A): (self: SortedSet<A>) => SortedSet<A>;
  <A>(self: SortedSet<A>, value: A): SortedSet<A>;
};

some

Added in v2.0.0 Source

Check if a predicate holds true for some SortedSet element.

Signature

declare const some: {
  <A>(predicate: Predicate<A>): (self: SortedSet<A>) => boolean;
  <A>(self: SortedSet<A>, predicate: Predicate<A>): boolean;
};

toggle

Added in v2.0.0 Source

Signature

declare const toggle: {
  <A>(value: A): (self: SortedSet<A>) => SortedSet<A>;
  <A>(self: SortedSet<A>, value: A): SortedSet<A>;
};

Equivalence

Signature

declare function getEquivalence<A>(): Equivalence<SortedSet<A>>;

Filtering

filter

Added in v2.0.0 Source

Signature

declare const filter: {
  <A, B>(predicate: Predicate<B>): (self: SortedSet<A>) => SortedSet<A>;
  <A>(self: SortedSet<A>, predicate: Predicate<A>): SortedSet<A>;
};

partition

Added in v2.0.0 Source

Signature

declare const partition: {
  <A>(
    predicate: (a: NoInfer<A>) => boolean,
  ): (self: SortedSet<A>) => [excluded: SortedSet<A>, satisfying: SortedSet<A>];
  <A>(
    self: SortedSet<A>,
    predicate: (a: A) => boolean,
  ): [excluded: SortedSet<A>, satisfying: SortedSet<A>];
};

Getters

size

Added in v2.0.0 Source

Signature

declare function size<A>(self: SortedSet<A>): number;

values

Added in v2.0.0 Source

Signature

declare function values<A>(self: SortedSet<A>): IterableIterator<A>;

Mapping

map

Added in v2.0.0 Source

Signature

declare const map: {
  <B, A>(O: Order<B>, f: (a: A) => B): (self: SortedSet<A>) => SortedSet<B>;
  <B, A>(self: SortedSet<A>, O: Order<B>, f: (a: A) => B): SortedSet<B>;
};

Models

SortedSet interface

Added in v2.0.0 Source

Signature

interface SortedSet<in out A> extends Iterable<A>, Equal, Pipeable, Inspectable {
  readonly [TypeId]: {
    readonly _A: Invariant<A>;
  };
}

Other

difference

Added in v2.0.0 Source

Signature

declare const difference: {
  <A, B>(that: Iterable<B>): (self: SortedSet<A>) => SortedSet<A>;
  <A, B>(self: SortedSet<A>, that: Iterable<B>): SortedSet<A>;
};

intersection

Added in v2.0.0 Source

Signature

declare const intersection: {
  <A>(that: Iterable<A>): (self: SortedSet<A>) => SortedSet<A>;
  <A>(self: SortedSet<A>, that: Iterable<A>): SortedSet<A>;
};

union

Added in v2.0.0 Source

Signature

declare const union: {
  <A>(that: Iterable<A>): (self: SortedSet<A>) => SortedSet<A>;
  <A>(self: SortedSet<A>, that: Iterable<A>): SortedSet<A>;
};

Refinements

isSortedSet

Added in v2.0.0 Source

Signature

declare const isSortedSet: {
  <A>(u: Iterable<A>): u is SortedSet<A>;
  (u: unknown): u is SortedSet<unknown>;
};

Sequencing

flatMap

Added in v2.0.0 Source

Signature

declare const flatMap: {
  <B, A>(O: Order<B>, f: (a: A) => Iterable<B>): (self: SortedSet<A>) => SortedSet<B>;
  <A, B>(self: SortedSet<A>, O: Order<B>, f: (a: A) => Iterable<B>): SortedSet<B>;
};

Symbol

TypeId type

Added in v2.0.0 Source

Signature

type TypeId = typeof TypeId;

Traversing

forEach

Added in v2.0.0 Source

Signature

declare const forEach: {
  <A>(f: (a: A) => void): (self: SortedSet<A>) => void;
  <A>(self: SortedSet<A>, f: (a: A) => void): void;
};