Heracles.ts

@hydra-cg/heracles.ts > IHypermediaProcessingOptions

Interface: IHypermediaProcessingOptions

Describes a IHypermediaProcessor processing options.

Hierarchy

IHypermediaProcessingOptions

Index

Properties


Properties

<Optional> auxiliaryOriginalUrl

● auxiliaryOriginalUrl: string

Defined in IHypermediaProcessingOptions.ts:34

Gets an original auxiliary Url requested that was used to obtain currently processed one. This property should be set in case auxiliaryResponse is also set.

readonly:

returns:


<Optional> auxiliaryResponse

● auxiliaryResponse: Response

Defined in IHypermediaProcessingOptions.ts:26

Gets an auxiliary response that was used to obtain currently processed one.

readonly:

returns:


linksPolicy

● linksPolicy: LinksPolicy

Defined in IHypermediaProcessingOptions.ts:12

Gets a policy defining which related resources will be added to links collection.

readonly:

returns:


originalUrl

● originalUrl: string

Defined in IHypermediaProcessingOptions.ts:19

Gets an originally requested Url. This may be different than the one provided in the Response.url after redirects.

readonly:

returns: