forked from HydraCG/Heracles.ts
/
IHypermediaProcessingOptions.ts
49 lines (43 loc) · 1.43 KB
/
IHypermediaProcessingOptions.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
import { ApiDocumentationPolicy } from "./ApiDocumentationPolicy";
import { IApiDocumentation } from "./DataModel/IApiDocumentation";
import { LinksPolicy } from "./LinksPolicy";
/**
* Describes a {@link IHypermediaProcessor} processing options.
*/
export interface IHypermediaProcessingOptions {
/**
* Gets a policy defining which related resources will be added to links collection.
* @readonly
* @returns {LinksPolicy}
*/
readonly linksPolicy: LinksPolicy;
/**
* Gets a policy defining how API documentations should be handled when obtaining resources.
* @readonly
* @returns {ApiDocumentationPolicy}
*/
readonly apiDocumentationPolicy: ApiDocumentationPolicy;
/**
* Gets an API documentations obtained.
*/
readonly apiDocumentations: Iterable<IApiDocumentation>;
/**
* Gets an originally requested Url. This may be different than the one provided in the Response.url after redirects.
* @readonly
* @returns {string}
*/
readonly originalUrl: string;
/**
* Gets an auxiliary response that was used to obtain currently processed one.
* @readonly
* @returns {Response}
*/
readonly auxiliaryResponse?: Response;
/**
* Gets an original auxiliary Url requested that was used to obtain currently processed one.
* This property should be set in case {@link auxiliaryResponse} is also set.
* @readonly
* @returns {string}
*/
readonly auxiliaryOriginalUrl?: string;
}