Heracles.ts

@hydra-cg/heracles.ts > ITemplatedOperation

Interface: ITemplatedOperation

Describes an IOperation that uses an URI template to point to the target of the request.

interface:

Hierarchy

↳ IOperation

↳ ITemplatedResource<IOperation>

↳ ITemplatedOperation

Implemented by

• TemplatedOperation

Index

Properties

• baseUrl
• collections
• expectedHeaders
• expects
• iri
• links
• method
• operations
• returnedHeaders
• returns
• target
• type

Methods

• expandTarget

---

Properties

baseUrl

● baseUrl: string

Inherited from IPointingResource.baseUrl

Overrides 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

● collections: ResourceFilterableCollection<ICollection>

Inherited from IHydraResource.collections

Overrides IHydraResource.collections

Defined in DataModel/IHydraResource.ts:17

Gets collections exposed by that resource.

readonly:

returns:

---

expectedHeaders

● expectedHeaders: Iterable<string>

Inherited from IOperation.expectedHeaders

Defined in DataModel/IOperation.ts:37

Gets the expected headers.

readonly:

returns:

---

expects

● expects: ResourceFilterableCollection<IClass>

Inherited from IOperation.expects

Defined in DataModel/IOperation.ts:23

Gets the expected classes.

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:

---

method

● method: string

Inherited from IOperation.method

Defined in DataModel/IOperation.ts:16

Gets a method to be used for the call.

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:

---

returnedHeaders

● returnedHeaders: Iterable<string>

Inherited from IOperation.returnedHeaders

Defined in DataModel/IOperation.ts:44

Gets the returned headers.

readonly:

returns:

---

returns

● returns: ResourceFilterableCollection<IClass>

Inherited from IOperation.returns

Defined in DataModel/IOperation.ts:30

Gets the returned classes.

readonly:

returns:

---

target

● target: IResource

Inherited from IPointingResource.target

Overrides IPointingResource.target

Defined in DataModel/IPointingResource.ts:21

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): IOperation

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: IOperation

---

This site is open source. Improve this page.