@hydra-cg/heracles.ts > ICollection
Describes an abstract Hydra collection.
interface:
↳ ICollection
● 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:
● members: ResourceFilterableCollection<IResource>
Defined in DataModel/ICollection.ts:17
Gets the collection’s member resources.
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:
● totalItems: number
Defined in DataModel/ICollection.ts:24
Gets the total items in the collection.
readonly:
returns:
● type: TypesCollection
Defined in DataModel/IResource.ts:20
Gets classes a given resource is of.
readonly:
returns:
<Optional> view● view: IPartialCollectionView
Defined in DataModel/ICollection.ts:31
Gets the optional partial collection view.
readonly:
returns:
▸ getIterator(): IPartialCollectionIterator
Defined in DataModel/ICollection.ts:37
Gets a partial collection iterator associated in case it is a partial one.
Returns: IPartialCollectionIterator