meos.js

---

meos.js / TsTzSpanSet

Class: TsTzSpanSet

Defined in: core/types/collections/time/TsTzSpanSet.ts:34

An ordered set of disjoint TsTzSpan values.

Timestamps are represented as TimestampTz integers (microseconds since 2000-01-01 UTC).

Example

const ss = TsTzSpanSet.fromString('{[2020-01-01, 2020-06-01), [2020-09-01, 2020-12-31]}');
console.log(ss.numSpans());      // 2
console.log(ss.numTimestamps()); // total timestamps across all spans
ss.free();

Extends

• SpanSet<TsTzSpan>

Constructors

Constructor

new TsTzSpanSet(inner): TsTzSpanSet;

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

Parameters

inner

number

Returns

TsTzSpanSet

Inherited from

SpanSet.constructor

Accessors

inner

Get Signature

get inner(): number;

Defined in: core/types/collections/base/SpanSet.ts:77

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

Returns

number

Inherited from

SpanSet.inner

Methods

[dispose]()

dispose: void;

Defined in: core/types/collections/base/SpanSet.ts:87

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

Returns

void

Inherited from

SpanSet.[dispose]

---

asHexWKB()

asHexWKB(variant?): string;

Defined in: core/types/collections/base/SpanSet.ts:110

Serialises this span set to a hex-encoded WKB string.

Parameters

variant?

number = 4

WKB encoding variant (default 4 = Extended WKB).

Returns

string

Inherited from

SpanSet.asHexWKB

---

boundingSpan()

boundingSpan(): TsTzSpan;

Defined in: core/types/collections/base/SpanSet.ts:154

Returns the smallest span that covers all spans in this set (the bounding span). The caller is responsible for calling Span.free on the result.

Returns

TsTzSpan

Inherited from

SpanSet.boundingSpan

---

contains()

contains(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:209

true if this entirely contains other. Accepts either a companion span or another span set of the same type.

Parameters

other

TsTzSpan | TsTzSpanSet

Returns

boolean

Inherited from

SpanSet.contains

---

copy()

copy(): this;

Defined in: core/types/collections/base/SpanSet.ts:95

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

Returns

this

Inherited from

SpanSet.copy

---

distance()

distance(other): number;

Defined in: core/types/collections/time/TsTzSpanSet.ts:135

Returns the distance (gap) between this and other in microseconds. Returns 0 if they overlap. Accepts either a TsTzSpan or a TsTzSpanSet.

Parameters

other

TsTzSpan | TsTzSpanSet

Returns

number

Overrides

SpanSet.distance

---

durationMs()

durationMs(boundSpan?): number;

Defined in: core/types/collections/time/TsTzSpanSet.ts:123

Returns the total duration of this span set in milliseconds.

Parameters

boundSpan?

boolean = false

false (default): sum of all individual span durations.

• true: duration of the bounding span (from first lower to last upper).

Returns

number

---

endSpan()

endSpan(): TsTzSpan;

Defined in: core/types/collections/base/SpanSet.ts:170

Returns the last (rightmost) span in this set. The caller is responsible for calling Span.free on the result.

Returns

TsTzSpan

Inherited from

SpanSet.endSpan

---

endTimestamp()

endTimestamp(): number;

Defined in: core/types/collections/time/TsTzSpanSet.ts:105

Returns the timestamp of the last span's upper bound as microseconds since 2000-01-01 UTC.

Returns

number

---

eq()

eq(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:324

true if this and other are identical (same spans, bounds, and inclusivity).

Parameters

other

this

Returns

boolean

Inherited from

SpanSet.eq

---

free()

free(): void;

Defined in: core/types/collections/base/SpanSet.ts:82

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

Returns

void

Inherited from

SpanSet.free

---

ge()

ge(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:349

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

Parameters

other

this

Returns

boolean

Inherited from

SpanSet.ge

---

gt()

gt(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:344

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

Parameters

other

this

Returns

boolean

Inherited from

SpanSet.gt

---

hash()

hash(): number;

Defined in: core/types/collections/base/SpanSet.ts:146

32-bit integer hash of this span set.

Returns

number

Inherited from

SpanSet.hash

---

intersection()

intersection(other): TsTzSpanSet | null;

Defined in: core/types/collections/base/SpanSet.ts:285

Returns the intersection of this and other, or null if they are disjoint. Accepts either a companion span or another span set of the same type. The caller is responsible for calling free on the result.

Parameters

other

TsTzSpan | TsTzSpanSet

Returns

TsTzSpanSet | null

Inherited from

SpanSet.intersection

---

isAdjacent()

isAdjacent(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:191

true if this and other share exactly one boundary point without overlapping. Accepts either a companion span or another span set of the same type.

Parameters

other

TsTzSpan | TsTzSpanSet

Returns

boolean

Inherited from

SpanSet.isAdjacent

---

isAfter()

isAfter(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:250

true if every point in this is strictly greater than every point in other. Accepts either a companion span or another span set of the same type.

Parameters

other

TsTzSpan | TsTzSpanSet

Returns

boolean

Inherited from

SpanSet.isAfter

---

isBefore()

isBefore(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:231

true if every point in this is strictly less than every point in other. Accepts either a companion span or another span set of the same type.

Parameters

other

TsTzSpan | TsTzSpanSet

Returns

boolean

Inherited from

SpanSet.isBefore

---

isContainedIn()

isContainedIn(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:200

true if this is entirely contained within other. Accepts either a companion span or another span set of the same type.

Parameters

other

TsTzSpan | TsTzSpanSet

Returns

boolean

Inherited from

SpanSet.isContainedIn

---

isOverOrAfter()

isOverOrAfter(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:260

true if this does not extend to the left of other (i.e. min(this) ≥ min(other)). Accepts either a companion span or another span set of the same type.

Parameters

other

TsTzSpan | TsTzSpanSet

Returns

boolean

Inherited from

SpanSet.isOverOrAfter

---

isOverOrBefore()

isOverOrBefore(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:241

true if this does not extend to the right of other (i.e. max(this) ≤ max(other)). Accepts either a companion span or another span set of the same type.

Parameters

other

TsTzSpan | TsTzSpanSet

Returns

boolean

Inherited from

SpanSet.isOverOrBefore

---

le()

le(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:339

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

Parameters

other

this

Returns

boolean

Inherited from

SpanSet.le

---

lower()

lower(): number;

Defined in: core/types/collections/time/TsTzSpanSet.ts:85

Returns the lower bound of the first span as microseconds since 2000-01-01 UTC.

Returns

number

Overrides

SpanSet.lower

---

lowerInc()

lowerInc(): boolean;

Defined in: core/types/collections/base/SpanSet.ts:131

true if the lower bound of the first span is inclusive ([).

Returns

boolean

Inherited from

SpanSet.lowerInc

---

lt()

lt(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:334

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

Parameters

other

this

Returns

boolean

Inherited from

SpanSet.lt

---

minus()

minus(other): TsTzSpanSet | null;

Defined in: core/types/collections/base/SpanSet.ts:298

Returns the part of this that is not in other, or null if the result is empty. Accepts either a companion span or another span set of the same type. The caller is responsible for calling free on the result.

Parameters

other

TsTzSpan | TsTzSpanSet

Returns

TsTzSpanSet | null

Inherited from

SpanSet.minus

---

ne()

ne(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:329

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

Parameters

other

this

Returns

boolean

Inherited from

SpanSet.ne

---

numSpans()

numSpans(): number;

Defined in: core/types/collections/base/SpanSet.ts:141

Number of spans in this set.

Returns

number

Inherited from

SpanSet.numSpans

---

numTimestamps()

numTimestamps(): number;

Defined in: core/types/collections/time/TsTzSpanSet.ts:95

Returns the total number of distinct timestamps across all spans.

Returns

number

---

overlaps()

overlaps(other): boolean;

Defined in: core/types/collections/base/SpanSet.ts:218

true if this and other share at least one point. Accepts either a companion span or another span set of the same type.

Parameters

other

TsTzSpan | TsTzSpanSet

Returns

boolean

Inherited from

SpanSet.overlaps

---

shiftScale()

shiftScale(shift, duration): TsTzSpanSet;

Defined in: core/types/collections/time/TsTzSpanSet.ts:150

Returns a new span set shifted and/or scaled along the time axis.

Parameters

shift

number

Raw WASM pointer to a MEOS interval for the shift amount (0 to skip).

duration

number

Raw WASM pointer to a MEOS interval for the new duration (0 to skip).

Returns

TsTzSpanSet

---

spanN()

spanN(n): TsTzSpan;

Defined in: core/types/collections/base/SpanSet.ts:179

Returns the n-th span (0-based index). The caller is responsible for calling Span.free on the result.

Parameters

n

number

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

Returns

TsTzSpan

Inherited from

SpanSet.spanN

---

startSpan()

startSpan(): TsTzSpan;

Defined in: core/types/collections/base/SpanSet.ts:162

Returns the first (leftmost) span in this set. The caller is responsible for calling Span.free on the result.

Returns

TsTzSpan

Inherited from

SpanSet.startSpan

---

startTimestamp()

startTimestamp(): number;

Defined in: core/types/collections/time/TsTzSpanSet.ts:100

Returns the timestamp of the first span's lower bound as microseconds since 2000-01-01 UTC.

Returns

number

---

timestampN()

timestampN(n): number;

Defined in: core/types/collections/time/TsTzSpanSet.ts:113

Returns the n-th timestamp (0-based index) as microseconds since 2000-01-01 UTC.

Parameters

n

number

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

Returns

number

---

toDateSpanSet()

toDateSpanSet(): number;

Defined in: core/types/collections/time/TsTzSpanSet.ts:171

Converts this span set to a DateSpanSet (timestamps truncated to midnight UTC) and returns the raw WASM pointer. Use new DateSpanSet(ptr) to obtain a typed object.

Returns

number

---

toString()

toString(): string;

Defined in: core/types/collections/time/TsTzSpanSet.ts:76

Returns the WKT string representation.

Returns

string

Overrides

SpanSet.toString

---

tprecision()

tprecision(duration, origin): TsTzSpanSet;

Defined in: core/types/collections/time/TsTzSpanSet.ts:159

Returns a new span set with each span snapped to the nearest multiple of duration from origin.

Parameters

duration

number

Raw WASM pointer to a MEOS interval defining the bucket size.

origin

number

Reference timestamp in microseconds since 2000-01-01 UTC.

Returns

TsTzSpanSet

---

union()

union(other): this;

Defined in: core/types/collections/base/SpanSet.ts:311

Returns the union of this and other. Accepts either a companion span or another span set of the same type. The caller is responsible for calling free on the result.

Parameters

other

TsTzSpan | TsTzSpanSet

Returns

this

Inherited from

SpanSet.union

---

upper()

upper(): number;

Defined in: core/types/collections/time/TsTzSpanSet.ts:90

Returns the upper bound of the last span as microseconds since 2000-01-01 UTC.

Returns

number

Overrides

SpanSet.upper

---

upperInc()

upperInc(): boolean;

Defined in: core/types/collections/base/SpanSet.ts:136

true if the upper bound of the last span is inclusive (]).

Returns

boolean

Inherited from

SpanSet.upperInc

---

fromHexWKB()

static fromHexWKB(hexwkb): TsTzSpanSet;

Defined in: core/types/collections/time/TsTzSpanSet.ts:59

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

Parameters

hexwkb

string

Hex-encoded WKB string.

Returns

TsTzSpanSet

---

fromSpan()

static fromSpan(span): TsTzSpanSet;

Defined in: core/types/collections/time/TsTzSpanSet.ts:67

Wraps a single TsTzSpan into a one-element TsTzSpanSet.

Parameters

span

TsTzSpan

The span to wrap.

Returns

TsTzSpanSet

---

fromString()

static fromString(str): TsTzSpanSet;

Defined in: core/types/collections/time/TsTzSpanSet.ts:51

Parses a TsTzSpanSet from its WKT string representation.

Parameters

str

string

WKT string, e.g. "{[2020-01-01, 2020-06-01), [2020-09-01, 2020-12-31]}".

Returns

TsTzSpanSet