DeliveryStore

Defined in: packages/webhook/src/registry/delivery.store.ts:19

Extends

• EventEmitter

Constructors

Constructor

new DeliveryStore(config?): DeliveryStore

Defined in: packages/webhook/src/registry/delivery.store.ts:34

Parameters

config?

Partial<StorageConfig> = {}

Returns

DeliveryStore

Overrides

EventEmitter.constructor

Methods

addListener()

addListener(eventName, listener): this

Defined in: packages/webhook/src/shared/event-emitter.ts:16

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.addListener

---

cleanupOldDeliveries()

cleanupOldDeliveries(): Promise<number>

Defined in: packages/webhook/src/registry/delivery.store.ts:281

오래된 전달 기록 정리

Returns

Promise<number>

---

emit()

emit(eventName, …args): boolean

Defined in: packages/webhook/src/shared/event-emitter.ts:44

Parameters

eventName

string

args

…unknown[]

Returns

boolean

Inherited from

EventEmitter.emit

---

getDeliveriesByEndpoint()

getDeliveriesByEndpoint(endpointId, limit?): Promise<object[]>

Defined in: packages/webhook/src/registry/delivery.store.ts:175

엔드포인트별 전달 기록 조회

Parameters

endpointId

string

limit?

number = 100

Returns

Promise<object[]>

---

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

deliveryId

string

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()

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

endpointId?

string

timeRange?

end

Date

start

Date

Returns

Promise<{ averageLatency: number; errorBreakdown: Record<string, number>; exhaustedDeliveries: number; failedDeliveries: number; pendingDeliveries: number; successfulDeliveries: number; successRate: number; totalDeliveries: number; }>

---

getFailedDeliveries()

getFailedDeliveries(endpointId?, limit?): Promise<object[]>

Defined in: packages/webhook/src/registry/delivery.store.ts:193

실패한 전달 기록 조회

Parameters

endpointId?

string

limit?

number = 100

Returns

Promise<object[]>

---

getStorageStats()

getStorageStats(): object

Defined in: packages/webhook/src/registry/delivery.store.ts:316

저장소 통계 조회

Returns

object

indexSizes

indexSizes: object

indexSizes.byDate

byDate: number

indexSizes.byEndpoint

byEndpoint: number

indexSizes.byStatus

byStatus: number

memoryUsage

memoryUsage: number

totalDeliveries

totalDeliveries: number

---

off()

off(eventName, listener): this

Defined in: packages/webhook/src/shared/event-emitter.ts:20

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.off

---

on()

on(eventName, listener): this

Defined in: packages/webhook/src/shared/event-emitter.ts:9

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.on

---

once()

once(eventName, listener): this

Defined in: packages/webhook/src/shared/event-emitter.ts:35

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.once

---

removeAllListeners()

removeAllListeners(eventName?): this

Defined in: packages/webhook/src/shared/event-emitter.ts:57

Parameters

eventName?

string

Returns

this

Inherited from

EventEmitter.removeAllListeners

---

removeListener()

removeListener(eventName, listener): this

Defined in: packages/webhook/src/shared/event-emitter.ts:31

Parameters

eventName

string

listener

Listener

Returns

this

Inherited from

EventEmitter.removeListener

---

saveDelivery()

saveDelivery(delivery): Promise<void>

Defined in: packages/webhook/src/registry/delivery.store.ts:51

전달 기록 저장

Parameters

delivery

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 = ...

Returns

Promise<void>

---

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

filter?

DeliveryFilter = {}

pagination?

PaginationOptions = ...

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()

shutdown(): Promise<void>

Defined in: packages/webhook/src/registry/delivery.store.ts:643

전달 저장소 종료

Returns

Promise<void>