meos.js

meos.js

Namespaces

Namespace	Description
TemporalType	-
TInterpolation	-

Enumerations

Enumeration	Description
TemporalType	Subtype of a temporal value.
TInterpolation	Interpolation mode of a temporal sequence.

Classes

Class	Description
BigIntSet	An ordered set of distinct 64-bit integers.
BigIntSpan	A contiguous range of 64-bit integers, stored internally as a half-open interval `[lower, upper)`.
BigIntSpanSet	An ordered set of disjoint BigIntSpan values.
DateSet	An ordered set of distinct calendar dates.
DateSpan	A contiguous range of calendar dates.
DateSpanSet	An ordered set of disjoint DateSpan values.
FloatSet	An ordered set of distinct IEEE 754 double-precision floats.
FloatSpan	A contiguous range of IEEE 754 double-precision floats.
FloatSpanSet	An ordered set of disjoint FloatSpan values.
IntSet	An ordered set of distinct integers.
IntSpan	A contiguous range of integers, stored internally as a half-open interval `[lower, upper)`.
IntSpanSet	An ordered set of disjoint IntSpan values.
MeosAggregationError	Error during a temporal aggregation (code 6).
MeosArgumentError	Abstract base for all invalid-argument errors.
MeosDirectoryError	Filesystem directory error (code 7).
MeosDivisionByZeroError	Division by zero (code 4).
MeosException	Base class for all MEOS runtime errors. Carries the raw error `code` (from `meos.h`) and `level` (PostgreSQL severity).
MeosFeatureNotSupported	The requested feature is not supported (code 13).
MeosFileError	Filesystem file error (code 8).
MeosGeoJsonInputError	GeoJSON input parsing error (code 26).
MeosGeoJsonOutputError	GeoJSON output serialisation error (code 27).
MeosInternalError	Unspecified internal MEOS error (code 1).
MeosInternalTypeError	Internal type mismatch in MEOS (code 2).
MeosInvalidArgError	Invalid argument (code 10).
MeosInvalidArgTypeError	Argument has the wrong type (code 11).
MeosInvalidArgValueError	Argument value is not accepted (code 12).
MeosIoError	Abstract base for all serialisation/deserialisation errors.
MeosMemoryAllocError	WASM/C heap allocation failure (code 5).
MeosMfJsonInputError	MF-JSON input parsing error (code 20).
MeosMfJsonOutputError	MF-JSON output serialisation error (code 21).
MeosSet	Abstract base class for all MEOS set types (ordered sets of discrete values).
MeosTextInputError	WKT/text input parsing error (code 22).
MeosTextOutputError	WKT/text output serialisation error (code 23).
MeosValueOutOfRangeError	A numeric value is outside its valid range (code 3).
MeosWkbInputError	WKB input parsing error (code 24).
MeosWkbOutputError	WKB output serialisation error (code 25).
Span	Abstract base class for all MEOS span types (contiguous ranges).
SpanSet	Abstract base class for all MEOS span-set types (ordered sets of disjoint spans).
STBox	A spatio-temporal bounding box with an optional spatial (XYZ) dimension and an optional temporal (T) dimension.
TBool	Temporal boolean type.
TBoolInst	Temporal boolean — Instant subtype.
TBoolSeq	Temporal boolean — Sequence subtype.
TBoolSeqSet	Temporal boolean — SequenceSet subtype.
TBox	A temporal bounding box with an optional numeric (X) dimension and an optional temporal (T) dimension.
TextSet	An ordered set of distinct text strings.
TFloat	Temporal float type.
TFloatInst	Temporal float — Instant subtype.
TFloatSeq	Temporal float — Sequence subtype.
TFloatSeqSet	Temporal float — SequenceSet subtype.
TGeogPoint	Temporal geography point type.
TGeogPointInst	Temporal geography point - Instant subtype.
TGeogPointSeq	Temporal geography point - Sequence subtype.
TGeogPointSeqSet	Temporal geography point - SequenceSet subtype.
TGeomPoint	Temporal geometry point type.
TGeomPointInst	Temporal geometry point - Instant subtype.
TGeomPointSeq	Temporal geometry point - Sequence subtype.
TGeomPointSeqSet	Temporal geometry point - SequenceSet subtype.
TInt	Temporal integer type.
TIntInst	Temporal integer — Instant subtype.
TIntSeq	Temporal integer — Sequence subtype.
TIntSeqSet	Temporal integer — SequenceSet subtype.
TsTzSet	An ordered set of distinct timestamps with timezone.
TsTzSpan	A contiguous range of timestamps with timezone.
TsTzSpanSet	An ordered set of disjoint TsTzSpan values.
TText	Temporal text type.
TTextInst	Temporal text — Instant subtype.
TTextSeq	Temporal text — Sequence subtype.
TTextSeqSet	Temporal text — SequenceSet subtype.

Type Aliases

TBoolSubtype

type TBoolSubtype = 
  | TBoolInst
  | TBoolSeq
  | TBoolSeqSet;

Defined in: core/types/temporal/TemporalFactory.ts:22

TFloatSubtype

type TFloatSubtype = 
  | TFloatInst
  | TFloatSeq
  | TFloatSeqSet;

Defined in: core/types/temporal/TemporalFactory.ts:24

TGeogPointSubtype

type TGeogPointSubtype = 
  | TGeogPointInst
  | TGeogPointSeq
  | TGeogPointSeqSet;

Defined in: core/types/temporal/TemporalFactory.ts:27

TGeomPointSubtype

type TGeomPointSubtype = 
  | TGeomPointInst
  | TGeomPointSeq
  | TGeomPointSeqSet;

Defined in: core/types/temporal/TemporalFactory.ts:26

TIntSubtype

type TIntSubtype = 
  | TIntInst
  | TIntSeq
  | TIntSeqSet;

Defined in: core/types/temporal/TemporalFactory.ts:23

TTextSubtype

type TTextSubtype = 
  | TTextInst
  | TTextSeq
  | TTextSeqSet;

Defined in: core/types/temporal/TemporalFactory.ts:25

Variables

MEOS_ERR_AGGREGATION_ERROR

const MEOS_ERR_AGGREGATION_ERROR: 6 = 6;

Defined in: core/functions/errors.ts:14

MEOS_ERR_DIRECTORY_ERROR

const MEOS_ERR_DIRECTORY_ERROR: 7 = 7;

Defined in: core/functions/errors.ts:15

MEOS_ERR_DIVISION_BY_ZERO

const MEOS_ERR_DIVISION_BY_ZERO: 4 = 4;

Defined in: core/functions/errors.ts:12

MEOS_ERR_FEATURE_NOT_SUPPORTED

const MEOS_ERR_FEATURE_NOT_SUPPORTED: 13 = 13;

Defined in: core/functions/errors.ts:20

MEOS_ERR_FILE_ERROR

const MEOS_ERR_FILE_ERROR: 8 = 8;

Defined in: core/functions/errors.ts:16

MEOS_ERR_GEOJSON_INPUT

const MEOS_ERR_GEOJSON_INPUT: 26 = 26;

Defined in: core/functions/errors.ts:27

MEOS_ERR_GEOJSON_OUTPUT

const MEOS_ERR_GEOJSON_OUTPUT: 27 = 27;

Defined in: core/functions/errors.ts:28

MEOS_ERR_INTERNAL_ERROR

const MEOS_ERR_INTERNAL_ERROR: 1 = 1;

Defined in: core/functions/errors.ts:9

MEOS_ERR_INTERNAL_TYPE_ERROR

const MEOS_ERR_INTERNAL_TYPE_ERROR: 2 = 2;

Defined in: core/functions/errors.ts:10

MEOS_ERR_INVALID_ARG

const MEOS_ERR_INVALID_ARG: 10 = 10;

Defined in: core/functions/errors.ts:17

MEOS_ERR_INVALID_ARG_TYPE

const MEOS_ERR_INVALID_ARG_TYPE: 11 = 11;

Defined in: core/functions/errors.ts:18

MEOS_ERR_INVALID_ARG_VALUE

const MEOS_ERR_INVALID_ARG_VALUE: 12 = 12;

Defined in: core/functions/errors.ts:19

MEOS_ERR_MEMORY_ALLOC_ERROR

const MEOS_ERR_MEMORY_ALLOC_ERROR: 5 = 5;

Defined in: core/functions/errors.ts:13

MEOS_ERR_MFJSON_INPUT

const MEOS_ERR_MFJSON_INPUT: 20 = 20;

Defined in: core/functions/errors.ts:21

MEOS_ERR_MFJSON_OUTPUT

const MEOS_ERR_MFJSON_OUTPUT: 21 = 21;

Defined in: core/functions/errors.ts:22

MEOS_ERR_TEXT_INPUT

const MEOS_ERR_TEXT_INPUT: 22 = 22;

Defined in: core/functions/errors.ts:23

MEOS_ERR_TEXT_OUTPUT

const MEOS_ERR_TEXT_OUTPUT: 23 = 23;

Defined in: core/functions/errors.ts:24

MEOS_ERR_VALUE_OUT_OF_RANGE

const MEOS_ERR_VALUE_OUT_OF_RANGE: 3 = 3;

Defined in: core/functions/errors.ts:11

MEOS_ERR_WKB_INPUT

const MEOS_ERR_WKB_INPUT: 24 = 24;

Defined in: core/functions/errors.ts:25

MEOS_ERR_WKB_OUTPUT

const MEOS_ERR_WKB_OUTPUT: 25 = 25;

Defined in: core/functions/errors.ts:26

MEOS_ERROR

const MEOS_ERROR: 21 = 21;

Defined in: core/functions/errors.ts:5

MEOS_NOTICE

const MEOS_NOTICE: 18 = 18;

Defined in: core/functions/errors.ts:3

MEOS_WARNING

const MEOS_WARNING: 19 = 19;

Defined in: core/functions/errors.ts:4

Functions

createTBool()

function createTBool(ptr): TBoolSubtype;

Defined in: core/types/temporal/TemporalFactory.ts:34

Routes a raw TBool pointer to TBoolInst | TBoolSeq | TBoolSeqSet.

Parameters

ptr

number

Returns

TBoolSubtype

createTFloat()

function createTFloat(ptr): TFloatSubtype;

Defined in: core/types/temporal/TemporalFactory.ts:50

Routes a raw TFloat pointer to TFloatInst | TFloatSeq | TFloatSeqSet.

Parameters

ptr

number

Returns

TFloatSubtype

createTGeogPoint()

function createTGeogPoint(ptr): TGeogPointSubtype;

Defined in: core/types/temporal/TemporalFactory.ts:74

Routes a raw TGeogPoint pointer to TGeogPointInst | TGeogPointSeq | TGeogPointSeqSet.

Parameters

ptr

number

Returns

TGeogPointSubtype

createTGeomPoint()

function createTGeomPoint(ptr): TGeomPointSubtype;

Defined in: core/types/temporal/TemporalFactory.ts:66

Routes a raw TGeomPoint pointer to TGeomPointInst | TGeomPointSeq | TGeomPointSeqSet.

Parameters

ptr

number

Returns

TGeomPointSubtype

createTInt()

function createTInt(ptr): TIntSubtype;

Defined in: core/types/temporal/TemporalFactory.ts:42

Routes a raw TInt pointer to TIntInst | TIntSeq | TIntSeqSet.

Parameters

ptr

number

Returns

TIntSubtype

createTText()

function createTText(ptr): TTextSubtype;

Defined in: core/types/temporal/TemporalFactory.ts:58

Routes a raw TText pointer to TTextInst | TTextSeq | TTextSeqSet.

Parameters

ptr

number

Returns

TTextSubtype

getModule()

function getModule(): MeosModule;

Defined in: core/runtime/meos.ts:97

Returns the initialised MeosModule.

Throws if initMeos() has not been called yet. All generated wrappers in core/functions.ts call this via the call<T>() helper.

Returns

MeosModule

initMeos()

function initMeos(): Promise<void>;

Defined in: core/runtime/meos.ts:84

Initialises the MEOS WASM module.

Must be awaited before calling any MEOS function. Safe to call multiple times. Subsequent calls are no-ops once the module is loaded.

Throws if the runtime does not support WebAssembly MEMORY64.

Returns

Promise<void>

makeMeosException()

function makeMeosException(
   code, 
   level, 
   message): MeosException;

Defined in: core/functions/errors.ts:156

Constructs the most specific MeosException subclass for the given error code. Falls back to the base MeosException for unknown codes.

Parameters

code

number

level

number

message

string

Returns

MeosException

meos.js ​

Namespaces ​

Enumerations ​

Classes ​

Type Aliases ​

TBoolSubtype ​

TFloatSubtype ​

TGeogPointSubtype ​

TGeomPointSubtype ​

TIntSubtype ​

TTextSubtype ​

Variables ​

MEOS_ERR_AGGREGATION_ERROR ​

MEOS_ERR_DIRECTORY_ERROR ​

MEOS_ERR_DIVISION_BY_ZERO ​

MEOS_ERR_FEATURE_NOT_SUPPORTED ​

MEOS_ERR_FILE_ERROR ​

MEOS_ERR_GEOJSON_INPUT ​

MEOS_ERR_GEOJSON_OUTPUT ​

MEOS_ERR_INTERNAL_ERROR ​

MEOS_ERR_INTERNAL_TYPE_ERROR ​

MEOS_ERR_INVALID_ARG ​

MEOS_ERR_INVALID_ARG_TYPE ​

MEOS_ERR_INVALID_ARG_VALUE ​

MEOS_ERR_MEMORY_ALLOC_ERROR ​

MEOS_ERR_MFJSON_INPUT ​

MEOS_ERR_MFJSON_OUTPUT ​

MEOS_ERR_TEXT_INPUT ​

MEOS_ERR_TEXT_OUTPUT ​

MEOS_ERR_VALUE_OUT_OF_RANGE ​

MEOS_ERR_WKB_INPUT ​

MEOS_ERR_WKB_OUTPUT ​

MEOS_ERROR ​

MEOS_NOTICE ​

MEOS_WARNING ​

Functions ​

createTBool() ​

Parameters ​

ptr ​

Returns ​

createTFloat() ​

Parameters ​

ptr ​

Returns ​

createTGeogPoint() ​

Parameters ​

ptr ​

Returns ​

createTGeomPoint() ​

Parameters ​

ptr ​

Returns ​

createTInt() ​

Parameters ​

ptr ​

Returns ​

createTText() ​

Parameters ​

ptr ​

Returns ​

getModule() ​

Returns ​

initMeos() ​

Returns ​

makeMeosException() ​

Parameters ​

code ​

level ​

message ​

Returns ​

meos.js

Namespaces

Enumerations

Classes

Type Aliases

TBoolSubtype

TFloatSubtype

TGeogPointSubtype

TGeomPointSubtype

TIntSubtype

TTextSubtype

Variables

MEOS_ERR_AGGREGATION_ERROR

MEOS_ERR_DIRECTORY_ERROR

MEOS_ERR_DIVISION_BY_ZERO

MEOS_ERR_FEATURE_NOT_SUPPORTED

MEOS_ERR_FILE_ERROR

MEOS_ERR_GEOJSON_INPUT

MEOS_ERR_GEOJSON_OUTPUT

MEOS_ERR_INTERNAL_ERROR

MEOS_ERR_INTERNAL_TYPE_ERROR

MEOS_ERR_INVALID_ARG

MEOS_ERR_INVALID_ARG_TYPE

MEOS_ERR_INVALID_ARG_VALUE

MEOS_ERR_MEMORY_ALLOC_ERROR

MEOS_ERR_MFJSON_INPUT

MEOS_ERR_MFJSON_OUTPUT

MEOS_ERR_TEXT_INPUT

MEOS_ERR_TEXT_OUTPUT

MEOS_ERR_VALUE_OUT_OF_RANGE

MEOS_ERR_WKB_INPUT

MEOS_ERR_WKB_OUTPUT

MEOS_ERROR

MEOS_NOTICE

MEOS_WARNING

Functions

createTBool()

Parameters

ptr

Returns

createTFloat()

Parameters

ptr

Returns

createTGeogPoint()

Parameters

ptr

Returns

createTGeomPoint()

Parameters

ptr

Returns

createTInt()

Parameters

ptr

Returns

createTText()

Parameters

ptr

Returns

getModule()

Returns

initMeos()

Returns

makeMeosException()

Parameters

code

level

message

Returns