QueryStreamsOptions
API reference for QueryStreamsOptions
Interface: QueryStreamsOptions
Section titled “Interface: QueryStreamsOptions”Query parameters for filtering streams
Properties
Section titled “Properties”fromDate?
Section titled “fromDate?”
optionalfromDate:string
includeArchived?
Section titled “includeArchived?”
optionalincludeArchived:boolean
includeCount?
Section titled “includeCount?”
optionalincludeCount:boolean
includeMetadata?
Section titled “includeMetadata?”
optionalincludeMetadata:boolean
limit?
Section titled “limit?”
optionallimit:number
maxPosition?
Section titled “maxPosition?”
optionalmaxPosition:number
minPosition?
Section titled “minPosition?”
optionalminPosition:number
offset?
Section titled “offset?”
optionaloffset:number
sortBy?
Section titled “sortBy?”
optionalsortBy:"streamId"|"createdAt"|"streamPosition"|"updatedAt"
sortDirection?
Section titled “sortDirection?”
optionalsortDirection:"asc"|"desc"
streamId?
Section titled “streamId?”
optionalstreamId:string
streamIdPattern?
Section titled “streamIdPattern?”
optionalstreamIdPattern:string
streamType?
Section titled “streamType?”
optionalstreamType:string|string[]
toDate?
Section titled “toDate?”
optionaltoDate:string