forked from HydraCG/Heracles.ts
/
ILink.ts
51 lines (45 loc) · 1.05 KB
/
ILink.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
import OperationsCollection from "./Collections/OperationsCollection";
import { IHydraResource } from "./IHydraResource";
import { IResource } from "./IResource";
/**
* Describes a link to another resource.
* @interface
*/
export interface ILink extends IHydraResource {
/**
* Gets the link's title.
* @readonly
* @returns {string}
*/
readonly title: string;
/**
* Gets the link's description.
* @readonly
* @returns {string}
*/
readonly description: string;
/**
* Gets a relation of the link.
* @readonly
* @returns {string}
*/
readonly relation: string;
/**
* Gets a base URL that can be used to resolve target in case it is relative.
* @readonly
* @returns {string}
*/
readonly baseUrl: string;
/**
* Gets a target URL to be called.
* @readonly
* @returns {IResource}
*/
readonly target: IResource;
/**
* Gets a link's supported operations.
* @readonly
* @returns {ResourceFilterableCollection<IOperation>}
*/
readonly supportedOperations: OperationsCollection;
}