Class Link

Represents a link with URL and optional meta data

See

https://jsonapi.org/format/1.0/#document-links

Hierarchy

  • Link

Constructors

constructor

Properties

meta? url

Constructors

constructor

  • Parameters

    • rawData: Spec.Link

      Can be a string containing an href or a LinkObject

    • Optional referringDocumentURL: URL

      The origin part of this URL will be used as prefix if rawData only refers to a pathname and not a full URL

    Returns JsonApi.Link

Properties

Optional Readonly meta

meta?: object

Any additional meta data

Readonly url

url: URL

The complete url for this link

Settings

Member Visibility

Theme

Generated using TypeDoc