meos.js

---

meos.js / TText

Class: TText

Defined in: core/types/basic/ttext/TText.ts:58

Temporal text type.

Wraps a MEOS TText pointer and exposes text-specific operations on top of the generic Temporal API defined in Temporal.ts.

Supports all three subtypes (Instant, Sequence, SequenceSet) through the same class — the subtype is determined by the WKT string at parse time.

Note: TText uses stepwise interpolation (text values cannot be interpolated).

Example

await initMeos();
const t = TText.fromString('[hello@2001-01-01, world@2001-01-02]');
console.log(t.startValue()); // hello
console.log(t.upper().startValue()); // HELLO
t.free();

Extends

• Temporal<string>

Extended by

• TTextInst
• TTextSeq
• TTextSeqSet

Constructors

Constructor

new TText(inner): TText;

Defined in: core/types/basic/ttext/TText.ts:63

Parameters

inner

number

Returns

TText

Overrides

Temporal<string>.constructor

Accessors

inner

Get Signature

get inner(): number;

Defined in: core/types/temporal/Temporal.ts:188

Raw WASM pointer. Use when passing this value to low-level functions.

Returns

number

Inherited from

Temporal.inner

Methods

[dispose]()

dispose: void;

Defined in: core/types/temporal/Temporal.ts:206

Explicit Resource Management support. Allows using t = TBool.fromString(...) to free automatically.

Returns

void

Inherited from

Temporal.[dispose]

---

alwaysEq()

alwaysEq(s): boolean;

Defined in: core/types/basic/ttext/TText.ts:228

Returns true if the value is always equal to s. MEOS: always_eq_ttext_text

Parameters

s

string

Returns

boolean

---

alwaysLt()

alwaysLt(s): boolean;

Defined in: core/types/basic/ttext/TText.ts:237

Returns true if the value is always less than s. MEOS: always_lt_ttext_text

Parameters

s

string

Returns

boolean

---

appendInstant()

appendInstant(
   inst, 
   maxdist?, 
   maxt?, 
   expand?): this;

Defined in: core/types/temporal/Temporal.ts:572

Appends an instant to this temporal, returning a new temporal. MEOS: temporal_append_tinstant

Parameters

inst

this

The instant to append (same subtype as this).

maxdist?

number = 0

Maximum distance gap allowed (0 = no limit).

maxt?

number = 0

Maximum time gap as interval pointer (0 = no limit).

expand?

boolean = false

Whether to expand the sequence in-place.

Returns

this

Inherited from

Temporal.appendInstant

---

appendSequence()

appendSequence(seq, expand?): this;

Defined in: core/types/temporal/Temporal.ts:582

Appends a sequence to this temporal, returning a new temporal. MEOS: temporal_append_tsequence

Parameters

seq

this

expand?

boolean = false

Returns

this

Inherited from

Temporal.appendSequence

---

asHexWKB()

asHexWKB(): string;

Defined in: core/types/temporal/Temporal.ts:228

Returns the hex-encoded WKB representation.

Uses the hand-written temporal_as_hexwkb_w wrapper which internally passes variant=4 (extended WKB) and discards size_out.

MEOS: temporal_as_hexwkb

Returns

string

Inherited from

Temporal.asHexWKB

---

asMFJSON()

asMFJSON(
   withBbox?, 
   flags?, 
   precision?, 
   srs?): string;

Defined in: core/types/temporal/Temporal.ts:250

Returns the MF-JSON representation.

The hand-written wrapper converts an empty srs string to C NULL so that callers can omit the SRS without passing a null pointer directly.

MEOS: temporal_as_mfjson

Parameters

withBbox?

boolean = true

Include bounding box in the output (default true)

flags?

number = 3

Output flags (default 3)

precision?

number = 6

Coordinate decimal precision (default 6)

srs?

string | null

Spatial Reference System string, or null to omit

Returns

string

Inherited from

Temporal.asMFJSON

---

at()

at(s): TText | null;

Defined in: core/types/basic/ttext/TText.ts:206

Restrict to instants where the value equals s. MEOS: ttext_at_value

Parameters

s

string

Returns

TText | null

---

atMax()

atMax(): this;

Defined in: core/types/temporal/Temporal.ts:421

Restricts to instants where the value is the maximum. MEOS: temporal_at_max

Returns

this

Inherited from

Temporal.atMax

---

atMin()

atMin(): this;

Defined in: core/types/temporal/Temporal.ts:416

Restricts to instants where the value is the minimum. MEOS: temporal_at_min

Returns

this

Inherited from

Temporal.atMin

---

atTsTzSet()

atTsTzSet(s): this;

Defined in: core/types/temporal/Temporal.ts:440

Restricts to the given timestamp set. MEOS: temporal_at_tstzset

Parameters

s

number

Returns

this

Inherited from

Temporal.atTsTzSet

---

atTsTzSpan()

atTsTzSpan(s): this;

Defined in: core/types/temporal/Temporal.ts:445

Restricts to the given timestamp span. MEOS: temporal_at_tstzspan

Parameters

s

number

Returns

this

Inherited from

Temporal.atTsTzSpan

---

atTsTzSpanSet()

atTsTzSpanSet(ss): this;

Defined in: core/types/temporal/Temporal.ts:450

Restricts to the given timestamp span set. MEOS: temporal_at_tstzspanset

Parameters

ss

number

Returns

this

Inherited from

Temporal.atTsTzSpanSet

---

concat()

concat(other): TText;

Defined in: core/types/basic/ttext/TText.ts:184

Concatenates other to this TText. MEOS: textcat_ttext_text / textcat_ttext_ttext

Parameters

other

string | TText

Returns

TText

---

copy()

copy(): this;

Defined in: core/types/temporal/Temporal.ts:214

Returns a deep copy of this temporal value. MEOS: temporal_copy

Returns

this

Inherited from

Temporal.copy

---

durationMs()

durationMs(ignoreGaps?): number;

Defined in: core/types/temporal/Temporal.ts:400

Returns the total duration as a number of milliseconds.

Uses the hand-written temporal_duration_us_w wrapper which converts the MEOS Interval* return value to a plain int64 (total microseconds). The result is divided by 1000 to return milliseconds.

Pass ignoreGaps=true to sum only sequence durations, ignoring the time gaps between sequences in a SequenceSet.

MEOS: temporal_duration

Parameters

ignoreGaps?

boolean = false

Returns

number

Inherited from

Temporal.durationMs

---

endInstant()

endInstant(): this;

Defined in: core/types/temporal/Temporal.ts:301

Returns the last instant as a new instance of the same subtype. MEOS: temporal_end_instant

Returns

this

Inherited from

Temporal.endInstant

---

endTimestamp()

endTimestamp(): number;

Defined in: core/types/temporal/Temporal.ts:377

Returns the last timestamp as microseconds since 2000-01-01 UTC. MEOS: temporal_end_timestamptz

Returns

number

Inherited from

Temporal.endTimestamp

---

endValue()

endValue(): string;

Defined in: core/types/basic/ttext/TText.ts:122

Ending value. MEOS: ttext_end_value

Returns

string

Overrides

Temporal.endValue

---

equals()

equals(other): boolean;

Defined in: core/types/temporal/Temporal.ts:602

Pointer-based identity check. For value equality, use the generated teq_* / temporal_eq functions.

Parameters

other

Temporal<string>

Returns

boolean

Inherited from

Temporal.equals

---

everEq()

everEq(s): boolean;

Defined in: core/types/basic/ttext/TText.ts:225

Returns true if the value is ever equal to s. MEOS: ever_eq_ttext_text

Parameters

s

string

Returns

boolean

---

everLt()

everLt(s): boolean;

Defined in: core/types/basic/ttext/TText.ts:234

Returns true if the value is ever less than s. MEOS: ever_lt_ttext_text

Parameters

s

string

Returns

boolean

---

free()

free(): void;

Defined in: core/types/temporal/Temporal.ts:198

Frees the underlying MEOS allocation.

After calling free(), the instance must not be used. Calls the hand-written meos_free wrapper from res/bindings_c_header.txt.

Returns

void

Inherited from

Temporal.free

---

initcap()

initcap(): TText;

Defined in: core/types/basic/ttext/TText.ts:176

Returns a new TText with initcap applied (first letter of each word uppercased). MEOS: ttext_initcap

Returns

TText

---

instantN()

instantN(n): this;

Defined in: core/types/temporal/Temporal.ts:335

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

Uses the hand-written temporal_instant_n_w wrapper which converts the 0-based JS index to the 1-based index expected by MEOS internally.

MEOS: temporal_instant_n

Parameters

n

number

Returns

this

Inherited from

Temporal.instantN

---

interpolation()

interpolation(): TInterpolation;

Defined in: core/types/temporal/Temporal.ts:263

Returns the interpolation mode of this temporal value. MEOS: temporal_interp

Returns

TInterpolation

Inherited from

Temporal.interpolation

---

lower()

lower(): TText;

Defined in: core/types/basic/ttext/TText.ts:171

Returns a new TText with all characters lowercased. MEOS: ttext_lower

Returns

TText

---

maxInstant()

maxInstant(): this;

Defined in: core/types/temporal/Temporal.ts:321

Returns the instant with the maximum value. MEOS: temporal_max_instant

Returns

this

Inherited from

Temporal.maxInstant

---

maxValue()

maxValue(): string;

Defined in: core/types/basic/ttext/TText.ts:136

Maximum value (lexicographic). MEOS: ttext_max_value

Returns

string

---

merge()

merge(other): this;

Defined in: core/types/temporal/Temporal.ts:590

Merges this temporal with another, returning a new temporal. MEOS: temporal_merge

Parameters

other

this

Returns

this

Inherited from

Temporal.merge

---

minInstant()

minInstant(): this;

Defined in: core/types/temporal/Temporal.ts:311

Returns the instant with the minimum value. MEOS: temporal_min_instant

Returns

this

Inherited from

Temporal.minInstant

---

minus()

minus(s): TText | null;

Defined in: core/types/basic/ttext/TText.ts:215

Restrict to instants where the value differs from s. MEOS: ttext_minus_value

Parameters

s

string

Returns

TText | null

---

minusMax()

minusMax(): this;

Defined in: core/types/temporal/Temporal.ts:431

Excludes instants where the value is the maximum. MEOS: temporal_minus_max

Returns

this

Inherited from

Temporal.minusMax

---

minusMin()

minusMin(): this;

Defined in: core/types/temporal/Temporal.ts:426

Excludes instants where the value is the minimum. MEOS: temporal_minus_min

Returns

this

Inherited from

Temporal.minusMin

---

minusTsTzSet()

minusTsTzSet(s): this;

Defined in: core/types/temporal/Temporal.ts:455

Excludes the given timestamp set. MEOS: temporal_minus_tstzset

Parameters

s

number

Returns

this

Inherited from

Temporal.minusTsTzSet

---

minusTsTzSpan()

minusTsTzSpan(s): this;

Defined in: core/types/temporal/Temporal.ts:460

Excludes the given timestamp span. MEOS: temporal_minus_tstzspan

Parameters

s

number

Returns

this

Inherited from

Temporal.minusTsTzSpan

---

minusTsTzSpanSet()

minusTsTzSpanSet(ss): this;

Defined in: core/types/temporal/Temporal.ts:465

Excludes the given timestamp span set. MEOS: temporal_minus_tstzspanset

Parameters

ss

number

Returns

this

Inherited from

Temporal.minusTsTzSpanSet

---

minValue()

minValue(): string;

Defined in: core/types/basic/ttext/TText.ts:131

Minimum value (lexicographic). MEOS: ttext_min_value

Returns

string

---

neverEq()

neverEq(s): boolean;

Defined in: core/types/basic/ttext/TText.ts:231

Returns true if the value is never equal to s.

Parameters

s

string

Returns

boolean

---

numInstants()

numInstants(): number;

Defined in: core/types/temporal/Temporal.ts:278

Returns the number of distinct instants in this temporal value. MEOS: temporal_num_instants

Returns

number

Inherited from

Temporal.numInstants

---

numTimestamps()

numTimestamps(): number;

Defined in: core/types/temporal/Temporal.ts:349

Returns the number of distinct timestamps. MEOS: temporal_num_timestamps

Returns

number

Inherited from

Temporal.numTimestamps

---

prepend()

prepend(prefix): TText;

Defined in: core/types/basic/ttext/TText.ts:194

Prepends prefix before this TText. MEOS: textcat_text_ttext

Parameters

prefix

string

Returns

TText

---

scaleTime()

scaleTime(duration): this;

Defined in: core/types/temporal/Temporal.ts:492

Scales the temporal domain to last duration, a Postgres interval string (e.g. '10 minutes') or a raw interval Ptr. MEOS: temporal_scale_time

Parameters

duration

string | number

Returns

this

Inherited from

Temporal.scaleTime

---

setInterp()

setInterp(interp): this;

Defined in: core/types/temporal/Temporal.ts:522

Returns a new temporal with the interpolation changed to interp. Pass TInterpolation values as numbers: Discrete=0, Stepwise=1, Linear=2. MEOS: temporal_set_interp

Parameters

interp

TInterpolation

Returns

this

Inherited from

Temporal.setInterp

---

shiftScaleTime()

shiftScaleTime(shift, duration): this;

Defined in: core/types/temporal/Temporal.ts:506

Shifts then scales the temporal domain. shift and duration may each be a Postgres interval string (e.g. '1 hour', '10 minutes') or a raw Ptr. MEOS: temporal_shift_scale_time

Parameters

shift

string | number

duration

string | number

Returns

this

Inherited from

Temporal.shiftScaleTime

---

shiftTime()

shiftTime(shift): this;

Defined in: core/types/temporal/Temporal.ts:478

Shifts the temporal domain by shift, a Postgres interval string (e.g. '1 hour', '-30 minutes') or a raw interval Ptr. MEOS: temporal_shift_time

Parameters

shift

string | number

Returns

this

Inherited from

Temporal.shiftTime

---

startInstant()

startInstant(): this;

Defined in: core/types/temporal/Temporal.ts:291

Returns the first instant as a new instance of the same subtype. MEOS: temporal_start_instant

Returns

this

Inherited from

Temporal.startInstant

---

startTimestamp()

startTimestamp(): number;

Defined in: core/types/temporal/Temporal.ts:362

Returns the first timestamp as microseconds since 2000-01-01 UTC. MEOS: temporal_start_timestamptz

Returns

number

Inherited from

Temporal.startTimestamp

---

startValue()

startValue(): string;

Defined in: core/types/basic/ttext/TText.ts:117

Starting value. MEOS: ttext_start_value

Returns

string

Overrides

Temporal.startValue

---

temporalEq()

temporalEq(s): number;

Defined in: core/types/basic/ttext/TText.ts:244

Temporal equality: returns a TBool ptr that is true where this == s. MEOS: teq_ttext_text

Parameters

s

string

Returns

number

---

temporalGe()

temporalGe(s): number;

Defined in: core/types/basic/ttext/TText.ts:259

Temporal greater-than-or-equal. MEOS: tge_ttext_text

Parameters

s

string

Returns

number

---

temporalGt()

temporalGt(s): number;

Defined in: core/types/basic/ttext/TText.ts:256

Temporal greater-than. MEOS: tgt_ttext_text

Parameters

s

string

Returns

number

---

temporalLe()

temporalLe(s): number;

Defined in: core/types/basic/ttext/TText.ts:253

Temporal less-than-or-equal. MEOS: tle_ttext_text

Parameters

s

string

Returns

number

---

temporalLt()

temporalLt(s): number;

Defined in: core/types/basic/ttext/TText.ts:250

Temporal less-than. MEOS: tlt_ttext_text

Parameters

s

string

Returns

number

---

temporalNe()

temporalNe(s): number;

Defined in: core/types/basic/ttext/TText.ts:247

Temporal inequality. MEOS: tne_ttext_text

Parameters

s

string

Returns

number

---

toInstant()

toInstant(): this;

Defined in: core/types/temporal/Temporal.ts:533

Converts to TInstant (must already be an instant). MEOS: temporal_as_tinstant

Returns

this

Inherited from

Temporal.toInstant

---

toSequence()

toSequence(interp): this;

Defined in: core/types/temporal/Temporal.ts:538

Converts to TSequence with the given interpolation. MEOS: temporal_as_tsequence

Parameters

interp

TInterpolation

Returns

this

Inherited from

Temporal.toSequence

---

toSequenceSet()

toSequenceSet(interp): this;

Defined in: core/types/temporal/Temporal.ts:549

Converts to TSequenceSet with the given interpolation. MEOS: temporal_as_tsequenceset

Parameters

interp

TInterpolation

Returns

this

Inherited from

Temporal.toSequenceSet

---

toString()

toString(): string;

Defined in: core/types/basic/ttext/TText.ts:112

WKT string representation. MEOS: ttext_out

Returns

string

Overrides

Temporal.toString

---

upper()

upper(): TText;

Defined in: core/types/basic/ttext/TText.ts:166

Returns a new TText with all characters uppercased. MEOS: ttext_upper

Returns

TText

---

valueAtTimestamp()

valueAtTimestamp(t): string | null;

Defined in: core/types/basic/ttext/TText.ts:153

Evaluates the temporal at a specific timestamp. Returns null when the timestamp is outside the temporal's domain. MEOS: temporal_at_timestamptz + ttext_start_value

Parameters

t

number

Returns

string | null

---

valueN()

valueN(n): string | null;

Defined in: core/types/basic/ttext/TText.ts:144

Returns the n-th distinct value (0-based index), or null if out of range. MEOS: ttext_value_n

Parameters

n

number

Returns

string | null

---

fromBaseTemporal()

static fromBaseTemporal(s, domain): TText;

Defined in: core/types/basic/ttext/TText.ts:87

Create a TText with constant value s spanning the same domain as domain. MEOS: ttext_from_base_temp

Parameters

s

string

domain

TText

Returns

TText

---

fromBaseTime()

static fromBaseTime(
   s, 
   time, 
   type): TText;

Defined in: core/types/basic/ttext/TText.ts:95

Create a TText with constant value s over a time object. MEOS: ttextseq_from_base_tstzset / tstzspan / ttextseqset_from_base_tstzspanset

Parameters

s

string

time

number

type

"tstzset" | "tstzspan" | "tstzspanset"

Returns

TText

---

fromMFJSON()

static fromMFJSON(mfjson): TText;

Defined in: core/types/basic/ttext/TText.ts:79

Parse a TText from a MF-JSON string. MEOS: ttext_from_mfjson

Parameters

mfjson

string

Returns

TText

---

fromString()

static fromString(wkt): TText;

Defined in: core/types/basic/ttext/TText.ts:71

Parse a TText from a WKT string. MEOS: ttext_in

Parameters

wkt

string

Returns

TText