DeliveryTrackingStore
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:125
Methods
Section titled “Methods”close()?
Section titled “close()?”
optionalclose():void|Promise<void>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:173
Returns
Section titled “Returns”void | Promise<void>
countBy()?
Section titled “countBy()?”
optionalcountBy(filter,groupBy):Promise<DeliveryTrackingCountByRow[]>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:168
Parameters
Section titled “Parameters”filter
Section titled “filter”groupBy
Section titled “groupBy”readonly DeliveryTrackingCountByField[]
Returns
Section titled “Returns”Promise<DeliveryTrackingCountByRow[]>
countRecords()?
Section titled “countRecords()?”
optionalcountRecords(filter):Promise<number>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:167
Parameters
Section titled “Parameters”filter
Section titled “filter”Returns
Section titled “Returns”Promise<number>
get(
messageId):Promise<TrackingRecord|undefined>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:128
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
Returns
Section titled “Returns”Promise<TrackingRecord | undefined>
init()
Section titled “init()”init():
Promise<void>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:126
Returns
Section titled “Returns”Promise<void>
leaseDue()?
Section titled “leaseDue()?”
optionalleaseDue(now,limit,leaseUntil):Promise<TrackingRecord[] |undefined>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:138
Like listDue, but also leases the records it returns: in the same
atomic step their nextCheckAt moves to leaseUntil, so other pollers
of the store skip them until the poll stores their next check or the
lease runs out. It resolves undefined when this store cannot lease
atomically. DeliveryTrackingService leases only with a store that has
both this and patchLeased, and otherwise uses listDue.
Parameters
Section titled “Parameters”Date
number
leaseUntil
Section titled “leaseUntil”Date
Returns
Section titled “Returns”Promise<TrackingRecord[] | undefined>
listDue()
Section titled “listDue()”listDue(
now,limit):Promise<TrackingRecord[]>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:129
Parameters
Section titled “Parameters”Date
number
Returns
Section titled “Returns”Promise<TrackingRecord[]>
listRecords()?
Section titled “listRecords()?”
optionallistRecords(options):Promise<TrackingRecord[]>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:166
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<TrackingRecord[]>
patch()
Section titled “patch()”patch(
messageId,patch):Promise<void>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:172
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
Partial<TrackingRecord>
Returns
Section titled “Returns”Promise<void>
patchLeased()?
Section titled “patchLeased()?”
optionalpatchLeased(messageId,leaseUntil,patch):Promise<boolean>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:150
Applies patch only while the record is still leased until leaseUntil
(its nextCheckAt equals it), and resolves whether it did. The check
and the write are one atomic step, as in leaseDue. A poll stores its
results this way, so one that ran past its lease cannot overwrite what
another poll stored since.
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
leaseUntil
Section titled “leaseUntil”Date
Partial<TrackingRecord>
Returns
Section titled “Returns”Promise<boolean>
releaseLeases()?
Section titled “releaseLeases()?”
optionalreleaseLeases(messageIds,leaseUntil,nextCheckAt):Promise<void>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:161
Hands back leases a poll did not finish: moves nextCheckAt to the
given time on those records whose nextCheckAt is still leaseUntil.
A record another poll has leased since is left alone. Without it,
DeliveryTrackingService lets such leases run out.
Parameters
Section titled “Parameters”messageIds
Section titled “messageIds”readonly string[]
leaseUntil
Section titled “leaseUntil”Date
nextCheckAt
Section titled “nextCheckAt”Date
Returns
Section titled “Returns”Promise<void>
upsert()
Section titled “upsert()”upsert(
record):Promise<void>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:127
Parameters
Section titled “Parameters”record
Section titled “record”Returns
Section titled “Returns”Promise<void>