Heracles.ts

@hydra-cg/heracles.ts > IOperation

Interface: IOperation

Describes an abstract Hydra operation.

interface:

Hierarchy

IHydraResource

IPointingResource

↳ IOperation

ITemplatedOperation

Index

Properties


Properties

baseUrl

● 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

● 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>

Defined in DataModel/IOperation.ts:37

Gets the expected headers.

readonly:

returns:


expects

● expects: ResourceFilterableCollection<IClass>

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

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>

Defined in DataModel/IOperation.ts:44

Gets the returned headers.

readonly:

returns:


returns

● returns: ResourceFilterableCollection<IClass>

Defined in DataModel/IOperation.ts:30

Gets the returned classes.

readonly:

returns:


target

● target: IResource

Inherited from 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: