DeliveryTrackingStore
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:125
Methods
섹션 제목: “Methods”close()?
섹션 제목: “close()?”
optionalclose():void|Promise<void>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:173
Returns
섹션 제목: “Returns”void | Promise<void>
countBy()?
섹션 제목: “countBy()?”
optionalcountBy(filter,groupBy):Promise<DeliveryTrackingCountByRow[]>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:168
Parameters
섹션 제목: “Parameters”filter
섹션 제목: “filter”groupBy
섹션 제목: “groupBy”readonly DeliveryTrackingCountByField[]
Returns
섹션 제목: “Returns”Promise<DeliveryTrackingCountByRow[]>
countRecords()?
섹션 제목: “countRecords()?”
optionalcountRecords(filter):Promise<number>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:167
Parameters
섹션 제목: “Parameters”filter
섹션 제목: “filter”Returns
섹션 제목: “Returns”Promise<number>
get()
섹션 제목: “get()”get(
messageId):Promise<TrackingRecord|undefined>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:128
Parameters
섹션 제목: “Parameters”messageId
섹션 제목: “messageId”string
Returns
섹션 제목: “Returns”Promise<TrackingRecord | undefined>
init()
섹션 제목: “init()”init():
Promise<void>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:126
Returns
섹션 제목: “Returns”Promise<void>
leaseDue()?
섹션 제목: “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
섹션 제목: “Parameters”now
섹션 제목: “now”Date
limit
섹션 제목: “limit”number
leaseUntil
섹션 제목: “leaseUntil”Date
Returns
섹션 제목: “Returns”Promise<TrackingRecord[] | undefined>
listDue()
섹션 제목: “listDue()”listDue(
now,limit):Promise<TrackingRecord[]>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:129
Parameters
섹션 제목: “Parameters”now
섹션 제목: “now”Date
limit
섹션 제목: “limit”number
Returns
섹션 제목: “Returns”Promise<TrackingRecord[]>
listRecords()?
섹션 제목: “listRecords()?”
optionallistRecords(options):Promise<TrackingRecord[]>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:166
Parameters
섹션 제목: “Parameters”options
섹션 제목: “options”Returns
섹션 제목: “Returns”Promise<TrackingRecord[]>
patch()
섹션 제목: “patch()”patch(
messageId,patch):Promise<void>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:172
Parameters
섹션 제목: “Parameters”messageId
섹션 제목: “messageId”string
patch
섹션 제목: “patch”Partial<TrackingRecord>
Returns
섹션 제목: “Returns”Promise<void>
patchLeased()?
섹션 제목: “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
섹션 제목: “Parameters”messageId
섹션 제목: “messageId”string
leaseUntil
섹션 제목: “leaseUntil”Date
patch
섹션 제목: “patch”Partial<TrackingRecord>
Returns
섹션 제목: “Returns”Promise<boolean>
releaseLeases()?
섹션 제목: “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
섹션 제목: “Parameters”messageIds
섹션 제목: “messageIds”readonly string[]
leaseUntil
섹션 제목: “leaseUntil”Date
nextCheckAt
섹션 제목: “nextCheckAt”Date
Returns
섹션 제목: “Returns”Promise<void>
upsert()
섹션 제목: “upsert()”upsert(
record):Promise<void>
Defined in: packages/messaging/src/delivery-tracking/store.interface.ts:127
Parameters
섹션 제목: “Parameters”record
섹션 제목: “record”Returns
섹션 제목: “Returns”Promise<void>