@hydra-cg/heracles.ts > ITemplatedResource
Provides an abstract description of a resource with expandable template.
interface:
↳ ITemplatedResource
● baseUrl: string
Inherited from IPointingResource.baseUrl
Defined in DataModel/IPointingResource.ts:14
Gets a base URL that can be used to resolve target in case it is relative.
readonly:
returns:
● collections: ResourceFilterableCollection<ICollection>
Inherited from IHydraResource.collections
Defined in DataModel/IHydraResource.ts:17
Gets collections exposed by that resource.
readonly:
returns:
● iri: string
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: OperationsCollection
Inherited from IHydraResource.operations
Defined in DataModel/IHydraResource.ts:24
Gets operations that can be performed on that resource.
readonly:
returns:
● target: IResource
Inherited from IPointingResource.target
Defined in DataModel/IPointingResource.ts:21
Gets a target URL to be called.
readonly:
returns:
● type: TypesCollection
Defined in DataModel/IResource.ts:20
Gets classes a given resource is of.
readonly:
returns:
▸ expandTarget(mappedVariables: IDictionary<string> | MappingBuilder): T
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: T