Skip to main content
Version: Next

StoreCollectionListOptions

Hierarchy

Added in 2.7.2

Index

Properties

Properties

optionalcategory

category?: string

optionalinheritedchunkSize

chunkSize?: number

Maximum number of items returned in one API response. Relevant in the context of asyncIterator, the iterator will fetch results in chunks of this size from API and yield them one by one. It will stop fetching once the limit is reached or once all items from API have been fetched.

Chunk size is usually limited by API. Minimum of those two limits will be used.

Added in 2.21.0

optionalincludeUnrunnableActors

includeUnrunnableActors?: boolean

If true, the response will include Actors that cannot be run (e.g., Actors that require a linked integration account that the current user does not have).

Added in 2.23.0

optionalinheritedlimit

limit?: number

Maximum number of entries requested.

optionalinheritedoffset

offset?: number

Position of the first returned entry.

optionalpricingModel

pricingModel?: string

optionalsearch

search?: string

optionalinheritedsignal

signal?: AbortSignal

Aborts the method. Once the signal aborts, the request in flight is ended, no retry or further poll follows, and the method rejects with the signal's reason.

optionalsortBy

sortBy?: string

optionalinheritedtimeoutSecs

timeoutSecs?: Timeout

Timeout for the API request: a tier name ('short', 'medium', 'long'), a number of seconds, or 'noTimeout'. Defaults to the tier the method is assigned, which its documentation names.

optionalusername

username?: string
Page Options