oceanum-js

@oceanum/datamesh

---

@oceanum/datamesh / index / ZarrOptions

Interface: ZarrOptions

Defined in: packages/datamesh/src/lib/datamodel.ts:565

Represents a dataset with dimensions, data variables, and attributes. Implements the DatasetApi interface.

Properties

chunks?

optional chunks?: string

Defined in: packages/datamesh/src/lib/datamodel.ts:573

---

coordkeys?

optional coordkeys?: Coordkeys

Defined in: packages/datamesh/src/lib/datamodel.ts:575

---

downsample?

optional downsample?: Record<string, number>

Defined in: packages/datamesh/src/lib/datamodel.ts:574

---

group?

optional group?: string

Defined in: packages/datamesh/src/lib/datamodel.ts:594

Path to a specific group within the zarr hierarchy to open as a dataset. If not specified, the root group is used. Supports both Datamesh zarr groups and external zarr archives with nested groups. Example: “/group1” or “group1”

---

nocache?

optional nocache?: boolean

Defined in: packages/datamesh/src/lib/datamodel.ts:580

Deprecated

Use ttl: 0 instead to disable caching

---

parameters?

optional parameters?: Record<string, string | number>

Defined in: packages/datamesh/src/lib/datamodel.ts:572

---

renewHeaders?

optional renewHeaders?: () => Promise<Record<string, string>>

Defined in: packages/datamesh/src/lib/datamodel.ts:571

Renew session headers after a gateway 401 (idle-expired oceanql session); the failed zarr request is retried once with the fresh headers. Wired automatically by Connector.openZarr.

Returns

Promise<Record<string, string>>

---

timeout?

optional timeout?: number

Defined in: packages/datamesh/src/lib/datamodel.ts:576

---

ttl?

optional ttl?: number

Defined in: packages/datamesh/src/lib/datamodel.ts:587

Time to live for cache entries in seconds.

• If undefined, cache never expires
• If 0, caching is disabled entirely
• If > 0, cache will be invalidated after this many seconds

This site is open source. Improve this page.