Interface IResourceCollection

Collections of IResource.

interface IResourceCollection {
    add(
        resource: string | IResource | IResourceCollection.AddOptions,
    ): IResource;
    beginPersist(): IPersistScope<JSON>;
    getCount(): number;
}

Hierarchy (View Summary)

ICollection
- IResourceCollection

Implemented by

ResourceCollection

Index

Methods

add beginPersist getCount

Methods

add

add(resource: string | IResource | IResourceCollection.AddOptions): IResource
Add a resource to a collection with an initial reference.
Parameters
- resource: string | IResource | IResourceCollection.AddOptions
Returns IResource
Remarks
Resources are not removed from the the collection. They are autoGCed when there are no references.

beginPersist

beginPersist(): IPersistScope<JSON>
Used for saving resource. Returns a visitor that will allow for a toJSON that will only save the resource that were accessed within the persist scope.

Returns IPersistScope<JSON>

getCount

getCount(): number
Returns the total items available.

Returns number
Remarks
Useful as a quick escape for search.

Inherited from ICollection.getCount