DeliveryStore
Defined in: packages/webhook/src/registry/delivery.store.ts:19
Extends
Section titled “Extends”EventEmitter
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DeliveryStore(
config?):DeliveryStore
Defined in: packages/webhook/src/registry/delivery.store.ts:34
Parameters
Section titled “Parameters”config?
Section titled “config?”Partial<StorageConfig> = {}
Returns
Section titled “Returns”DeliveryStore
Overrides
Section titled “Overrides”EventEmitter.constructor
Methods
Section titled “Methods”addListener()
Section titled “addListener()”addListener(
eventName,listener):this
Defined in: packages/webhook/src/shared/event-emitter.ts:16
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.addListener
cleanupOldDeliveries()
Section titled “cleanupOldDeliveries()”cleanupOldDeliveries():
Promise<number>
Defined in: packages/webhook/src/registry/delivery.store.ts:281
오래된 전달 기록 정리
Returns
Section titled “Returns”Promise<number>
emit()
Section titled “emit()”emit(
eventName, …args):boolean
Defined in: packages/webhook/src/shared/event-emitter.ts:44
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
…unknown[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”EventEmitter.emit
getDeliveriesByEndpoint()
Section titled “getDeliveriesByEndpoint()”getDeliveriesByEndpoint(
endpointId,limit?):Promise<object[]>
Defined in: packages/webhook/src/registry/delivery.store.ts:175
엔드포인트별 전달 기록 조회
Parameters
Section titled “Parameters”endpointId
Section titled “endpointId”string
limit?
Section titled “limit?”number = 100
Returns
Section titled “Returns”Promise<object[]>
getDelivery()
Section titled “getDelivery()”getDelivery(
deliveryId):Promise<{attempts:object[];completedAt?:Date;createdAt:Date;endpointId:string;eventId:string;eventType?:MESSAGE_SENT|MESSAGE_DELIVERED|MESSAGE_FAILED|MESSAGE_CLICKED|MESSAGE_READ|TEMPLATE_CREATED|TEMPLATE_APPROVED|TEMPLATE_REJECTED|TEMPLATE_UPDATED|TEMPLATE_DELETED|CHANNEL_CREATED|CHANNEL_VERIFIED|SENDER_NUMBER_ADDED|SENDER_NUMBER_VERIFIED|QUOTA_WARNING|QUOTA_EXCEEDED|PROVIDER_ERROR|SYSTEM_MAINTENANCE|ANOMALY_DETECTED|THRESHOLD_EXCEEDED;headers:Record<string,string>;httpMethod:"POST"|"PUT"|"PATCH";id:string;nextRetryAt?:Date;payload:string;status:"failed"|"success"|"pending"|"exhausted";url:string; } |null>
Defined in: packages/webhook/src/registry/delivery.store.ts:82
전달 기록 조회
Parameters
Section titled “Parameters”deliveryId
Section titled “deliveryId”string
Returns
Section titled “Returns”Promise<{ attempts: object[]; completedAt?: Date; createdAt: Date; endpointId: string; eventId: string; eventType?: MESSAGE_SENT | MESSAGE_DELIVERED | MESSAGE_FAILED | MESSAGE_CLICKED | MESSAGE_READ | TEMPLATE_CREATED | TEMPLATE_APPROVED | TEMPLATE_REJECTED | TEMPLATE_UPDATED | TEMPLATE_DELETED | CHANNEL_CREATED | CHANNEL_VERIFIED | SENDER_NUMBER_ADDED | SENDER_NUMBER_VERIFIED | QUOTA_WARNING | QUOTA_EXCEEDED | PROVIDER_ERROR | SYSTEM_MAINTENANCE | ANOMALY_DETECTED | THRESHOLD_EXCEEDED; headers: Record<string, string>; httpMethod: "POST" | "PUT" | "PATCH"; id: string; nextRetryAt?: Date; payload: string; status: "failed" | "success" | "pending" | "exhausted"; url: string; } | null>
getDeliveryStats()
Section titled “getDeliveryStats()”getDeliveryStats(
endpointId?,timeRange?):Promise<{averageLatency:number;errorBreakdown:Record<string,number>;exhaustedDeliveries:number;failedDeliveries:number;pendingDeliveries:number;successfulDeliveries:number;successRate:number;totalDeliveries:number; }>
Defined in: packages/webhook/src/registry/delivery.store.ts:209
전달 통계 조회
Parameters
Section titled “Parameters”endpointId?
Section titled “endpointId?”string
timeRange?
Section titled “timeRange?”Date
Date
Returns
Section titled “Returns”Promise<{ averageLatency: number; errorBreakdown: Record<string, number>; exhaustedDeliveries: number; failedDeliveries: number; pendingDeliveries: number; successfulDeliveries: number; successRate: number; totalDeliveries: number; }>
getFailedDeliveries()
Section titled “getFailedDeliveries()”getFailedDeliveries(
endpointId?,limit?):Promise<object[]>
Defined in: packages/webhook/src/registry/delivery.store.ts:193
실패한 전달 기록 조회
Parameters
Section titled “Parameters”endpointId?
Section titled “endpointId?”string
limit?
Section titled “limit?”number = 100
Returns
Section titled “Returns”Promise<object[]>
getStorageStats()
Section titled “getStorageStats()”getStorageStats():
object
Defined in: packages/webhook/src/registry/delivery.store.ts:316
저장소 통계 조회
Returns
Section titled “Returns”object
indexSizes
Section titled “indexSizes”indexSizes:
object
indexSizes.byDate
Section titled “indexSizes.byDate”byDate:
number
indexSizes.byEndpoint
Section titled “indexSizes.byEndpoint”byEndpoint:
number
indexSizes.byStatus
Section titled “indexSizes.byStatus”byStatus:
number
memoryUsage
Section titled “memoryUsage”memoryUsage:
number
totalDeliveries
Section titled “totalDeliveries”totalDeliveries:
number
off(
eventName,listener):this
Defined in: packages/webhook/src/shared/event-emitter.ts:20
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.off
on(
eventName,listener):this
Defined in: packages/webhook/src/shared/event-emitter.ts:9
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”once(
eventName,listener):this
Defined in: packages/webhook/src/shared/event-emitter.ts:35
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.once
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
eventName?):this
Defined in: packages/webhook/src/shared/event-emitter.ts:57
Parameters
Section titled “Parameters”eventName?
Section titled “eventName?”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener(
eventName,listener):this
Defined in: packages/webhook/src/shared/event-emitter.ts:31
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeListener
saveDelivery()
Section titled “saveDelivery()”saveDelivery(
delivery):Promise<void>
Defined in: packages/webhook/src/registry/delivery.store.ts:51
전달 기록 저장
Parameters
Section titled “Parameters”delivery
Section titled “delivery”attempts
Section titled “attempts”object[] = ...
completedAt?
Section titled “completedAt?”Date = ...
createdAt
Section titled “createdAt”Date = ...
endpointId
Section titled “endpointId”string = ...
eventId
Section titled “eventId”string = ...
eventType?
Section titled “eventType?”MESSAGE_SENT | MESSAGE_DELIVERED | MESSAGE_FAILED | MESSAGE_CLICKED | MESSAGE_READ | TEMPLATE_CREATED | TEMPLATE_APPROVED | TEMPLATE_REJECTED | TEMPLATE_UPDATED | TEMPLATE_DELETED | CHANNEL_CREATED | CHANNEL_VERIFIED | SENDER_NUMBER_ADDED | SENDER_NUMBER_VERIFIED | QUOTA_WARNING | QUOTA_EXCEEDED | PROVIDER_ERROR | SYSTEM_MAINTENANCE | ANOMALY_DETECTED | THRESHOLD_EXCEEDED = ...
headers
Section titled “headers”Record<string, string> = ...
httpMethod
Section titled “httpMethod”"POST" | "PUT" | "PATCH" = ...
string = ...
nextRetryAt?
Section titled “nextRetryAt?”Date = ...
payload
Section titled “payload”string = ...
status
Section titled “status”"failed" | "success" | "pending" | "exhausted" = ...
string = ...
Returns
Section titled “Returns”Promise<void>
searchDeliveries()
Section titled “searchDeliveries()”searchDeliveries(
filter?,pagination?):Promise<SearchResult<{attempts:object[];completedAt?:Date;createdAt:Date;endpointId:string;eventId:string;eventType?:MESSAGE_SENT|MESSAGE_DELIVERED|MESSAGE_FAILED|MESSAGE_CLICKED|MESSAGE_READ|TEMPLATE_CREATED|TEMPLATE_APPROVED|TEMPLATE_REJECTED|TEMPLATE_UPDATED|TEMPLATE_DELETED|CHANNEL_CREATED|CHANNEL_VERIFIED|SENDER_NUMBER_ADDED|SENDER_NUMBER_VERIFIED|QUOTA_WARNING|QUOTA_EXCEEDED|PROVIDER_ERROR|SYSTEM_MAINTENANCE|ANOMALY_DETECTED|THRESHOLD_EXCEEDED;headers:Record<string,string>;httpMethod:"POST"|"PUT"|"PATCH";id:string;nextRetryAt?:Date;payload:string;status:"failed"|"success"|"pending"|"exhausted";url:string; }>>
Defined in: packages/webhook/src/registry/delivery.store.ts:89
필터 조건에 맞는 전달 기록 검색
Parameters
Section titled “Parameters”filter?
Section titled “filter?”DeliveryFilter = {}
pagination?
Section titled “pagination?”PaginationOptions = ...
Returns
Section titled “Returns”Promise<SearchResult<{ attempts: object[]; completedAt?: Date; createdAt: Date; endpointId: string; eventId: string; eventType?: MESSAGE_SENT | MESSAGE_DELIVERED | MESSAGE_FAILED | MESSAGE_CLICKED | MESSAGE_READ | TEMPLATE_CREATED | TEMPLATE_APPROVED | TEMPLATE_REJECTED | TEMPLATE_UPDATED | TEMPLATE_DELETED | CHANNEL_CREATED | CHANNEL_VERIFIED | SENDER_NUMBER_ADDED | SENDER_NUMBER_VERIFIED | QUOTA_WARNING | QUOTA_EXCEEDED | PROVIDER_ERROR | SYSTEM_MAINTENANCE | ANOMALY_DETECTED | THRESHOLD_EXCEEDED; headers: Record<string, string>; httpMethod: "POST" | "PUT" | "PATCH"; id: string; nextRetryAt?: Date; payload: string; status: "failed" | "success" | "pending" | "exhausted"; url: string; }>>
shutdown()
Section titled “shutdown()”shutdown():
Promise<void>
Defined in: packages/webhook/src/registry/delivery.store.ts:643
전달 저장소 종료
Returns
Section titled “Returns”Promise<void>