Options
All
  • Public
  • Public/Protected
  • All
Menu

A reference to a location in an object graph.

This type is used by this module to break cycles in an object graph and to reference locations that have already been visited when enumerating pointers.

Hierarchy

  • JsonReference

Index

Constructors

Properties

$ref: string

A reference to a position if an object graph.

Methods

  • resolve(target: unknown): unknown
  • Resolves the reference against the target object, returning the value at the referenced pointer's location.

    Parameters

    • target: unknown

      the target object

    Returns unknown

  • toString(): string
  • Gets the reference pointer's string representation (a URI fragment identifier).

    Returns string

  • Determines if the specified candidate is a JsonReference.

    Parameters

    • candidate: unknown

      the candidate

    Returns candidate is JsonReference

Generated using TypeDoc