meos.js

---

meos.js / TextSet

Class: TextSet

Defined in: core/types/collections/text/TextSet.ts:27

An ordered set of distinct text strings.

Example

const s = TextSet.fromString('{"apple", "banana", "cherry"}');
console.log(s.numValues()); // 3
console.log(s.startValue()); // 'apple'
console.log(s.endValue());   // 'cherry'
s.free();

Extends

• MeosSet<string>

Constructors

Constructor

new TextSet(inner): TextSet;

Defined in: core/types/collections/base/MeosSet.ts:46

Parameters

inner

number

Returns

TextSet

Inherited from

MeosSet.constructor

Accessors

inner

Get Signature

get inner(): number;

Defined in: core/types/collections/base/MeosSet.ts:58

Raw WASM heap pointer. Do not free this value directly; use free.

Returns

number

Inherited from

MeosSet.inner

Methods

[dispose]()

dispose: void;

Defined in: core/types/collections/base/MeosSet.ts:68

Implements the using resource-management protocol — calls free automatically.

Returns

void

Inherited from

MeosSet.[dispose]

---

asHexWKB()

asHexWKB(variant?): string;

Defined in: core/types/collections/base/MeosSet.ts:91

Serialises this set to a hex-encoded WKB string.

Parameters

variant?

number = 4

WKB encoding variant (default 4 = Extended WKB).

Returns

string

Inherited from

MeosSet.asHexWKB

---

contains()

contains(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:147

true if this contains every element of other.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.contains

---

copy()

copy(): this;

Defined in: core/types/collections/base/MeosSet.ts:76

Returns a deep copy of this set. The caller is responsible for calling free on the returned copy.

Returns

this

Inherited from

MeosSet.copy

---

distance()

distance(_other): never;

Defined in: core/types/collections/text/TextSet.ts:90

MEOS does not support text distance — always throws.

Parameters

_other

this

Returns

never

Overrides

MeosSet.distance

---

endValue()

endValue(): string;

Defined in: core/types/collections/text/TextSet.ts:71

Returns the lexicographically largest (last) string in this set.

Returns

string

Overrides

MeosSet.endValue

---

eq()

eq(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:232

true if this and other contain the same elements.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.eq

---

free()

free(): void;

Defined in: core/types/collections/base/MeosSet.ts:63

Releases the WASM-allocated memory. Must be called when the object is no longer needed.

Returns

void

Inherited from

MeosSet.free

---

ge()

ge(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:257

true if this is greater than or equal to other in MEOS total ordering.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.ge

---

gt()

gt(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:252

true if this is strictly greater than other in MEOS total ordering.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.gt

---

hash()

hash(): number;

Defined in: core/types/collections/base/MeosSet.ts:105

32-bit integer hash of this set.

Returns

number

Inherited from

MeosSet.hash

---

initcap()

initcap(): TextSet;

Defined in: core/types/collections/text/TextSet.ts:109

Returns a new TextSet with initcap applied to all strings.

Returns

TextSet

---

intersection()

intersection(other): TextSet | null;

Defined in: core/types/collections/base/MeosSet.ts:205

Returns the intersection of this and other, or null if they are disjoint. The caller is responsible for calling free on the result.

Parameters

other

this

Returns

TextSet | null

Inherited from

MeosSet.intersection

---

isAfter()

isAfter(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:174

true if every element of this is strictly greater than every element of other.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.isAfter

---

isBefore()

isBefore(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:161

true if every element of this is strictly less than every element of other.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.isBefore

---

isContainedIn()

isContainedIn(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:142

true if this is entirely contained within other (every element of this is in other).

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.isContainedIn

---

isOverOrAfter()

isOverOrAfter(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:182

true if this does not extend to the left of other (i.e. min(this) ≥ min(other)).

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.isOverOrAfter

---

isOverOrBefore()

isOverOrBefore(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:169

true if this does not extend to the right of other (i.e. max(this) ≤ max(other)).

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.isOverOrBefore

---

le()

le(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:247

true if this is less than or equal to other in MEOS total ordering.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.le

---

lower()

lower(): TextSet;

Defined in: core/types/collections/text/TextSet.ts:99

Returns a new TextSet with all strings lowercased.

Returns

TextSet

---

lt()

lt(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:242

true if this is strictly less than other in MEOS total ordering.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.lt

---

minus()

minus(other): TextSet | null;

Defined in: core/types/collections/base/MeosSet.ts:214

Returns the part of this not in other, or null if the result is empty. The caller is responsible for calling free on the result.

Parameters

other

this

Returns

TextSet | null

Inherited from

MeosSet.minus

---

ne()

ne(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:237

true if this and other differ in at least one element.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.ne

---

numValues()

numValues(): number;

Defined in: core/types/collections/base/MeosSet.ts:100

Number of elements in this set.

Returns

number

Inherited from

MeosSet.numValues

---

overlaps()

overlaps(other): boolean;

Defined in: core/types/collections/base/MeosSet.ts:152

true if this and other share at least one element.

Parameters

other

this

Returns

boolean

Inherited from

MeosSet.overlaps

---

startValue()

startValue(): string;

Defined in: core/types/collections/text/TextSet.ts:66

Returns the lexicographically smallest (first) string in this set.

Returns

string

Overrides

MeosSet.startValue

---

toSpan()

toSpan(): number;

Defined in: core/types/collections/base/MeosSet.ts:113

Returns the bounding span of this set as a raw WASM pointer. Use the appropriate Span constructor to obtain a typed object.

Returns

number

Inherited from

MeosSet.toSpan

---

toSpanSet()

toSpanSet(): number;

Defined in: core/types/collections/base/MeosSet.ts:121

Returns this set converted to a SpanSet as a raw WASM pointer. Use the appropriate SpanSet constructor to obtain a typed object.

Returns

number

Inherited from

MeosSet.toSpanSet

---

toString()

toString(): string;

Defined in: core/types/collections/text/TextSet.ts:57

Returns the WKT string representation (e.g. {"apple", "banana"}).

Returns

string

Overrides

MeosSet.toString

---

union()

union(other): this;

Defined in: core/types/collections/base/MeosSet.ts:223

Returns the union of this and other. The caller is responsible for calling free on the result.

Parameters

other

this

Returns

this

Inherited from

MeosSet.union

---

upper()

upper(): TextSet;

Defined in: core/types/collections/text/TextSet.ts:104

Returns a new TextSet with all strings uppercased.

Returns

TextSet

---

valueN()

valueN(n): string | null;

Defined in: core/types/collections/text/TextSet.ts:79

Returns the n-th string (0-based index).

Parameters

n

number

0-based index (MEOS internally uses 1-based indexing).

Returns

string | null

Overrides

MeosSet.valueN

---

fromHexWKB()

static fromHexWKB(hexwkb): TextSet;

Defined in: core/types/collections/text/TextSet.ts:48

Deserialises a TextSet from a hex-encoded WKB string produced by asHexWKB.

Parameters

hexwkb

string

Hex-encoded WKB string.

Returns

TextSet

---

fromString()

static fromString(str): TextSet;

Defined in: core/types/collections/text/TextSet.ts:40

Parses a TextSet from its WKT string representation.

Parameters

str

string

WKT string, e.g. '{"apple", "banana"}'.

Returns

TextSet