@hydra-cg/heracles.ts > PartialCollectionCrawler
Provides capability of crawling through partial collection views.
PartialCollectionCrawler
<Private> constructor⊕ new PartialCollectionCrawler(collection: ICollection): PartialCollectionCrawler
Defined in PartialCollectionCrawler.ts:59
Parameters:
| Name | Type |
|---|---|
| collection | ICollection |
Returns: PartialCollectionCrawler
<Private> collection● collection: ICollection
Defined in PartialCollectionCrawler.ts:59
<Private> addWithLimitReached▸ addWithLimitReached(result: IResource[], part: Iterable<IResource>, memberLimit: number): boolean
Defined in PartialCollectionCrawler.ts:117
Parameters:
| Name | Type |
|---|---|
| result | IResource[] |
| part | Iterable<IResource> |
| memberLimit | number |
Returns: boolean
▸ getMembers(options?: ICrawlingOptions): Promise<Iterable<IResource»
Defined in PartialCollectionCrawler.ts:79
Crawls partial collection views starting with a given one.
Parameters:
| Name | Type | Description |
|---|---|---|
Optional options |
ICrawlingOptions | Crawling options. |
Returns: Promise<Iterable<IResource»
<Static> from▸ from(collection: ICollection): PartialCollectionCrawler
Defined in PartialCollectionCrawler.ts:70
Creates a new instance of the PartialCollectionCrawler from a given partial collection view.
Parameters:
| Name | Type | Description |
|---|---|---|
| collection | ICollection | Partial collection view to start with. |
Returns: PartialCollectionCrawler