Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Reference

Reference pairs a reference type constant (e.g., REFERENCE_CHILD_OF or REFERENCE_FOLLOWS_FROM) with the SpanContext it points to.

See the exported childOf() and followsFrom() functions at the package level.

Hierarchy

  • Reference

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initialize a new Reference instance.

    Parameters

    • type: string

      the Reference type constant (e.g., REFERENCE_CHILD_OF or REFERENCE_FOLLOWS_FROM).

    • referencedContext: SpanContext | Span

      the SpanContext being referred to. As a convenience, a Span instance may be passed in instead (in which case its .context() is used here).

    Returns Reference

Properties

Protected _referencedContext

_referencedContext: SpanContext

Protected _type

_type: string

Methods

referencedContext

  • Returns SpanContext

    The SpanContext being referred to (e.g., the parent in a REFERENCE_CHILD_OF Reference).

type

  • type(): string
  • Returns string

    The Reference type (e.g., REFERENCE_CHILD_OF or REFERENCE_FOLLOWS_FROM).

Generated using TypeDoc