API reference

NodeMetadata Class

Metadata describing a registered introspection node, returned by IntrospectionRegistry.list.

Excludes the Node.reader closure — listing is metadata-only; consumers must call IntrospectionRegistry.read to obtain the actual value.

Signature

data class NodeMetadata(
    val path: String,
    val type: NodeType,
    val visibility: Visibility,
    val description: String,
    val unit: String?,
)

Constructors

NodeMetadata ( path , type , visibility , description , unit )

Signature

constructor(
    path: String,
    type: NodeType,
    visibility: Visibility,
    description: String,
    unit: String?,
)

Parameters

path: String Full hierarchical, slash-delimited path identifying the node. The leading prefix is opaque — treat it as a stable identifier.

type: NodeType Advisory type hint for formatting.

visibility: Visibility Whether this node is hidden in production builds.

description: String Short human-readable label.

unit: String? Optional unit string (e.g. "bytes", "ms", "count").

Returns

NodeMetadata

Properties

description : String [Get]	Short human-readable label. Signature val description: String
path : String [Get]	Full hierarchical, slash-delimited path identifying the node. The leading prefix is opaque — treat it as a stable identifier. Signature val path: String
type : NodeType [Get]	Advisory type hint for formatting. Signature val type: NodeType
unit : String? [Get]	Optional unit string (e.g. `"bytes"`, `"ms"`, `"count"`). Signature val unit: String?
visibility : Visibility [Get]	Whether this node is hidden in production builds. Signature val visibility: Visibility