Heracles.ts

@hydra-cg/heracles.ts > ILink

Interface: ILink

Describes a link to another resource.

interface:

Hierarchy

IHydraResource

↳ ILink

IPartialCollectionView

ITemplatedLink

Index

Properties


Properties

baseUrl

● baseUrl: string

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

Defined in DataModel/IHydraResource.ts:17

Gets collections exposed by that resource.

readonly:

returns:


iri

● iri: string

Inherited from IResource.iri

Defined in DataModel/IResource.ts:13

Gets an Iri of a resource.

readonly:

returns:


● links: LinksCollection

Inherited from IHydraResource.links

Defined in DataModel/IHydraResource.ts:31

Gets links related to that resource.

readonly:

returns:


operations

● operations: OperationsCollection

Inherited from IHydraResource.operations

Defined in DataModel/IHydraResource.ts:24

Gets operations that can be performed on that resource.

readonly:

returns:


relation

● relation: string

Defined in DataModel/ILink.ts:16

Gets a relation of the link.

readonly:

returns:


supportedOperations

● supportedOperations: OperationsCollection

Defined in DataModel/ILink.ts:36

Gets a link’s supported operations.

readonly:

returns:


target

● target: IResource

Defined in DataModel/ILink.ts:29

Gets a target URL to be called.

readonly:

returns:


type

● type: TypesCollection

Inherited from IResource.type

Defined in DataModel/IResource.ts:20

Gets classes a given resource is of.

readonly:

returns: