GlobalH5Interface

GlobalH5Interface

Interface for globals.h5. Applications are expected to implement each of the documented methods.

Methods

close(handle) → {undefined|Promise.<undefined>}

Source:
Parameters:
Name Type Description
handle H5Group

Return value of open. This will already have its close method invoked.
Returns:

This should execute clean-up operations when the file used in open is no longer needed. No value is returned, possibly asynchronously.

Type
undefined | Promise.<undefined>

open(contents, optionsopt) → {H5Group|Promise.<H5Group>}

Source:
Parameters:
Name Type Attributes Default Description
contents string | Uint8Array

Path to a HDF5 file on the local filesystem, or a Uint8Array containing the contents of such a file. The latter may be provided if no filesystem is available.
options object <optional>
 {}

Further options.

Properties
Name Type Attributes Default Description
readOnly boolean <optional>
 true

Whether to open the file in read-only mode. If false and the file does not already exist, a new file will be created.
Returns:

A handle to the HDF5 file, or a promise thereof.

Type
H5Group | Promise.<H5Group>