Skip to main content

JavaScript / TypeScript

The oceanum-js library provides TypeScript/JavaScript access to the Oceanum.io platform, including Datamesh.

Installation​

Install from npm:

npm install @oceanum/datamesh

Or with yarn:

yarn add @oceanum/datamesh

Authentication​

Set your Datamesh token:

import { Connector } from '@oceanum/datamesh';

const connector = new Connector({
  token: 'your-datamesh-token'
});

Or use environment variables:

export DATAMESH_TOKEN="your-token-here"

Quick Start​

Connect to the Datamesh​

import { Connector } from '@oceanum/datamesh';

// Initialize connector
const connector = new Connector({ token: process.env.DATAMESH_TOKEN });

// Get catalog
const catalog = await connector.getCatalog();
console.log(catalog);

// Search for datasets
const results = await connector.getCatalog({ search: 'wave' });

Query Data​

// Load a datasource
const datasource = await connector.getDatasource('datasource-id');

// Execute a query
const query = {
  datasource: 'datasource-id',
  geofilter: {
    type: 'bbox',
    geom: [170, -40, 180, -35]
  }
};

const result = await connector.query(query);

Features​

  • TypeScript support - Full type definitions included
  • Catalog browsing - Search and discover datasets
  • OceanQL queries - Filter by space, time, and variables
  • Browser & Node.js - Works in both environments
  • Eidos integration - Create interactive visualizations

Documentation​

Full documentation: oceanum-js.oceanum.io

Source Code​

GitHub: github.com/oceanum-io/oceanum-js