StoreCollectionListOptions

Hierarchy

• PaginationOptions
  • StoreCollectionListOptions

Index

Properties

• category
• chunkSize
• limit
• offset
• pricingModel
• search
• sortBy
• username

Properties

optionalcategory

category?: string

optionalinheritedchunkSize

chunkSize?: number

Inherited from PaginationOptions.chunkSize

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.

optionalinheritedlimit

limit?: number

Inherited from PaginationOptions.limit

Maximum number of entries requested.

optionalinheritedoffset

offset?: number

Inherited from PaginationOptions.offset

Position of the first returned entry.

optionalpricingModel

pricingModel?: string

optionalsearch

search?: string

optionalsortBy

sortBy?: string

optionalusername

username?: string