Class: WebHooks
Constructors#
constructor#
+ new WebHooks(options: Options): default
Parameters#
| Name | Type |
|---|---|
options | Options |
Returns: default
Defined in: WebHooks.ts:23
Properties#
db#
• db: DB
Defined in: WebHooks.ts:21
emitter#
• emitter: EventEmitter
Defined in: WebHooks.ts:22
requestFunctions#
• requestFunctions: Record<string, RequestFunction>= {}
Defined in: WebHooks.ts:23
Methods#
add#
â–¸ add(key: string, url: string): Promise<void>
Add WebHook to key.
Parameters#
| Name | Type |
|---|---|
key | string |
url | string |
Returns: Promise<void>
Defined in: WebHooks.ts:90
getDB#
â–¸ getDB(): Promise<Hook[]>
Return all keys, and URL arrays.
Returns: Promise<Hook[]>
Promise
Defined in: WebHooks.ts:139
getRequestFunction#
â–¸ getRequestFunction(url: string): RequestFunction
Parameters#
| Name | Type |
|---|---|
url | string |
Returns: RequestFunction
Defined in: WebHooks.ts:51
getWebHook#
â–¸ getWebHook(key: string): Promise<string[]>
Return array of URLs for specified key.
Parameters#
| Name | Type |
|---|---|
key | string |
Returns: Promise<string[]>
Promise
Defined in: WebHooks.ts:149
remove#
â–¸ remove(key: string, url?: string): Promise<void>
Remove URL from specified key. If no URL is specified, then remove key from Database.
Parameters#
| Name | Type |
|---|---|
key | string |
url? | string |
Returns: Promise<void>
Defined in: WebHooks.ts:107
setListeners#
â–¸ setListeners(): Promise<void>
Returns: Promise<void>
Defined in: WebHooks.ts:36
trigger#
â–¸ trigger(__namedParameters: TriggerOptions): void
Parameters#
| Name | Type |
|---|---|
__namedParameters | TriggerOptions |
Returns: void
Defined in: WebHooks.ts:77