Heracles.ts

@hydra-cg/heracles.ts > ICrawlingOptions

Interface: ICrawlingOptions

Describes {@link PartialCollectionCrawler.getMoreMembersStartingFrom(IPartialCollectionView)} crawling options.

interface:

Hierarchy

ICrawlingOptions

Index

Properties


Properties

<Optional> direction

● direction: CrawlingDirection

Defined in PartialCollectionCrawler.ts:31

The crawling direction.

readonly:

returns:


<Optional> memberLimit

● memberLimit: number

Defined in PartialCollectionCrawler.ts:37

The limit of the members to retrieve.

readonly:

returns:


<Optional> requestLimit

● requestLimit: number

Defined in PartialCollectionCrawler.ts:44

The limit of requests to make.

readonly:

returns:


<Optional> rewind

● rewind: boolean

Defined in PartialCollectionCrawler.ts:52

Value indicating whether to rewind back to the beginning (or end) of the collection in case the starting point was not the first (or last) possible view.

readonly:

returns: