Heracles.ts

@hydra-cg/heracles.ts > ITemplatedLink

Interface: ITemplatedLink

Provides a link that can has an URI template.

interface:

Hierarchy

↳ ILink

↳ ITemplatedResource<ILink>

↳ ITemplatedLink

Implemented by

• TemplatedLink

Index

Properties

• baseUrl
• collections
• iri
• links
• operations
• relation
• supportedOperations
• target
• type

Methods

• expandTarget

---

Properties

baseUrl

● baseUrl: string

Inherited from ILink.baseUrl

Overrides IPointingResource.baseUrl

Defined in DataModel/ILink.ts:22

Gets a base URL that can be used to resolve target in case it is relative.

readonly:

returns:

---

collections

● collections: ResourceFilterableCollection<ICollection>

Inherited from IHydraResource.collections

Overrides IHydraResource.collections

Defined in DataModel/IHydraResource.ts:17

Gets collections exposed by that resource.

readonly:

returns:

---

iri

● iri: string

Inherited from IResource.iri

Overrides IResource.iri

Defined in DataModel/IResource.ts:13

Gets an Iri of a resource.

readonly:

returns:

---

links

● links: LinksCollection

Inherited from IHydraResource.links

Overrides IHydraResource.links

Defined in DataModel/IHydraResource.ts:31

Gets links related to that resource.

readonly:

returns:

---

operations

● operations: OperationsCollection

Inherited from IHydraResource.operations

Overrides IHydraResource.operations

Defined in DataModel/IHydraResource.ts:24

Gets operations that can be performed on that resource.

readonly:

returns:

---

relation

● relation: string

Inherited from ILink.relation

Defined in DataModel/ILink.ts:16

Gets a relation of the link.

readonly:

returns:

---

supportedOperations

● supportedOperations: OperationsCollection

Inherited from ILink.supportedOperations

Defined in DataModel/ILink.ts:36

Gets a link’s supported operations.

readonly:

returns:

---

target

● target: IResource

Inherited from ILink.target

Overrides IPointingResource.target

Defined in DataModel/ILink.ts:29

Gets a target URL to be called.

readonly:

returns:

---

type

● type: TypesCollection

Inherited from IResource.type

Overrides IResource.type

Defined in DataModel/IResource.ts:20

Gets classes a given resource is of.

readonly:

returns:

---

Methods

expandTarget

▸ expandTarget(mappedVariables: IDictionary<string> | MappingBuilder): ILink

Inherited from ITemplatedResource.expandTarget

Defined in DataModel/ITemplatedResource.ts:17

Expands an URI template with given variables.

Parameters:

Name	Type	Description
mappedVariables	IDictionary<string> | MappingBuilder	Template variables with values or {@link MappingsBuilder}.

Returns: ILink

---

This site is open source. Improve this page.