src/lib/src/hal-link.ts
Hyperlink according to [JSON HAL specification draft]{@link https://tools.ietf.org/html/draft-kelly-json-hal-08}.
Properties |
deprecation |
deprecation:
|
Type : string
|
Defined in src/lib/src/hal-link.ts:17
|
Its presence indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation. |
href |
href:
|
Type : string
|
Defined in src/lib/src/hal-link.ts:8
|
URI according to RFC3986. |
hreflang |
hreflang:
|
Type : string
|
Defined in src/lib/src/hal-link.ts:29
|
Its value is a string and is intended for indicating the language of the target resource (as defined by RFC5988). |
name |
name:
|
Type : string
|
Defined in src/lib/src/hal-link.ts:21
|
Its value MAY be used as a secondary key for selecting Link Objects, which share the same relation type. |
profile |
profile:
|
Type : string
|
Defined in src/lib/src/hal-link.ts:41
|
Its value is a string which is a URI that hints about the profile of the target resource. |
templated |
templated:
|
Type : boolean
|
Defined in src/lib/src/hal-link.ts:37
|
Its value is boolean and SHOULD be true when the Link Object's "href" property is a URI Template. Its value SHOULD be considered false if it is undefined or any other value than true. |
title |
title:
|
Type : string
|
Defined in src/lib/src/hal-link.ts:25
|
Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by RFC5988). |
type |
type:
|
Type : string
|
Defined in src/lib/src/hal-link.ts:12
|
Its value is a string used as a hint to indicate the media type expected when dereferencing the target resource. |
export interface Link {
/**
* URI according to RFC3986.
*/
readonly href: string;
/**
* Its value is a string used as a hint to indicate the media type expected when dereferencing the target resource.
*/
readonly type?: string;
/**
* Its presence indicates that the link is to be deprecated (i.e. removed) at a future date.
* Its value is a URL that SHOULD provide further information about the deprecation.
*/
readonly deprecation?: string;
/**
* Its value MAY be used as a secondary key for selecting Link Objects, which share the same relation type.
*/
readonly name?: string;
/**
* Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by RFC5988).
*/
readonly title?: string;
/**
* Its value is a string and is intended for indicating the language of the target resource (as defined by RFC5988).
*/
readonly hreflang?: string;
/**
* Its value is boolean and SHOULD be true when the Link Object's "href"
* property is a URI Template.
*
* Its value SHOULD be considered false if it is undefined or any other
* value than true.
*/
readonly templated?: boolean;
/**
* Its value is a string which is a URI that hints about the profile of the target resource.
*/
readonly profile?: string;
}