BC-DCBOR TypeScript Library - v1.0.0-alpha.13
    Preparing search index...

    Function edgeLabel

    • Returns a short text label for the edge type, or undefined if no label is needed.

      This is primarily used for tree formatting to identify relationships between elements.

      Parameters

      Returns string | undefined

      Short label string, or undefined for None edge type

      edgeLabel({ type: EdgeType.ArrayElement, index: 0 }); // Returns "arr[0]"
      edgeLabel({ type: EdgeType.MapKeyValue }); // Returns "kv"
      edgeLabel({ type: EdgeType.MapKey }); // Returns "key"
      edgeLabel({ type: EdgeType.MapValue }); // Returns "val"
      edgeLabel({ type: EdgeType.TaggedContent }); // Returns "content"
      edgeLabel({ type: EdgeType.None }); // Returns undefined