Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Link

Represents a link to another resource.

Hierarchy

  • Link

Index

Constructors

Properties

Constructors

constructor

  • new Link(rel: string, href: string, title?: undefined | string, templated?: boolean): Link

  • Creates a new link.

    Parameters

    • rel: string

      The relation type of the link.

    • href: string

      The href/target of the link.

    • Optional title: undefined | string

      The title of the link.

    • Default value templated: boolean = false

      Indicates whether the link is an URI Template (RFC 6570).

    Returns Link

Properties

href

href: string

The href/target of the link.

rel

rel: string

The relation type of the link.

templated

templated: boolean

Indicates whether the link is an URI Template (RFC 6570).

Optional title

title: undefined | string

The title of the link.

Generated using TypeDoc