Helios Network JS/WASM API

Version 0.6.0

The JavaScript/WASM package wraps the WebAssembly graph store with selectors, attribute APIs, serialization helpers, and direct typed-buffer access. Use the chainable attribute helpers for everyday code; the direct buffer methods remain documented as the low-level performance path when performance requires operating on WASM-backed views directly.

Classes

Network and selector classes exposed by the JavaScript/WASM package.

class EdgeSelector Selector specialized for edge indices. class HeliosNetwork High-level JavaScript wrapper around the Helios WASM network implementation. Manages lifetime, attribute registration, and buffer views. class NodeSelector Selector specialized for node indices.

Methods

High-level chainable attribute helpers and low-level buffer access methods.

method defineEdgeAttribute Defines an edge attribute backed by linear WASM memory. method defineNetworkAttribute Defines a network-level attribute backed by linear WASM memory. method defineNodeAttribute Defines a node attribute backed by linear WASM memory. method edgeAttribute Defines or updates one edge attribute and returns the network for chaining. method edgeAttributes Defines or updates several edge attributes and returns the network for chaining. method getEdgeAttributeBuffer Retrieves a wrapper around the edge attribute buffer. method getNetworkAttributeBuffer Retrieves a wrapper around the network attribute buffer. method getNodeAttributeBuffer Retrieves a wrapper around the node attribute buffer. method networkAttribute Defines or updates one network-level attribute and returns the network for chaining. Network attributes store one graph-wide value at id/ordinal `0`. Missing attributes are defined from `options.type` / `options.dimension`, or inferred from the provided value or callback result. method networkAttributes Defines or updates several network-level attributes and returns the network for chaining. `valuesOrFn` may be an object keyed by attribute name, an array aligned with `names`, or a callback returning either an array aligned with `names` or an object keyed by attribute name. method nodeAttribute Defines or updates one node attribute and returns the network for chaining. Missing attributes are defined from `options.type` / `options.dimension`, or inferred from the provided scalar, array-like value, or callback result. Array-like values are indexed by active ordinal by default; pass `{ indexBy: 'id' }` to index them by node id instead. method nodeAttributes Defines or updates several node attributes and returns the network for chaining. `valuesOrFn` may be an object keyed by attribute name, an array of per-attribute scalar values, or a callback returning either an array aligned with `names` or an object keyed by attribute name. method withBufferAccess Runs a callback inside a buffer access session, ensuring cleanup even on throw.

Enums And Constants

Constants mirrored from the WASM/native core for attributes, traversal, measurements, and execution modes.

symbol AttributeType Enumeration of attribute types supported by the WASM network core. Values align with the constants defined in the native implementation. symbol CategorySortOrder Ordering strategies used when converting string attributes to categories. Frequency ordering is useful for visualization legends; natural ordering keeps labels such as "item2" before "item10". symbol ClusteringCoefficientVariant Local clustering coefficient formula selector. symbol ConnectedComponentsMode Connected-component mode selector for weak or strongly connected components. symbol DimensionDifferenceMethod Finite-difference estimators for local and global graph dimension measures. symbol MeasurementExecutionMode Execution policy for native graph measurements that can run in serial or parallel. symbol NeighborDirection Direction policy for neighbor traversal and degree-like measurements. symbol StrengthMeasure Aggregation policy for edge-weight based node strength.

Coverage Notes

The current JavaScript/WASM package does not publish TypeScript declarations. Until declarations are added, this extractor uses the public package entry plus implementation JSDoc and refuses to document deep modules. The structured reference is available at ../reference.json.