UNPKG

3.66 kBTypeScriptView Raw
1// Copyright (c) .NET Foundation. All rights reserved.
2// Licensed under the MIT License.
3
4import { CosmosDBTrigger, CosmosDBTriggerOptions } from './cosmosDB';
5import { EventGridTrigger, EventGridTriggerOptions } from './eventGrid';
6import { EventHubTrigger, EventHubTriggerOptions } from './eventHub';
7import { GenericTriggerOptions } from './generic';
8import { HttpTrigger, HttpTriggerOptions } from './http';
9import { FunctionTrigger } from './index';
10import {
11 ServiceBusQueueTrigger,
12 ServiceBusQueueTriggerOptions,
13 ServiceBusTopicTrigger,
14 ServiceBusTopicTriggerOptions,
15} from './serviceBus';
16import {
17 StorageBlobTrigger,
18 StorageBlobTriggerOptions,
19 StorageQueueTrigger,
20 StorageQueueTriggerOptions,
21} from './storage';
22import { TimerTrigger, TimerTriggerOptions } from './timer';
23import { WarmupTrigger, WarmupTriggerOptions } from './warmup';
24
25/**
26 * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-http-webhook-trigger?&pivots=programming-language-javascript)
27 */
28export function http(options: HttpTriggerOptions): HttpTrigger;
29
30/**
31 * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-timer?pivots=programming-language-javascript)
32 */
33export function timer(options: TimerTriggerOptions): TimerTrigger;
34
35/**
36 * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-storage-blob-trigger?pivots=programming-language-javascript)
37 */
38export function storageBlob(options: StorageBlobTriggerOptions): StorageBlobTrigger;
39
40/**
41 * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-storage-queue-trigger?pivots=programming-language-javascript)
42 */
43export function storageQueue(options: StorageQueueTriggerOptions): StorageQueueTrigger;
44
45/**
46 * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-service-bus-trigger?pivots=programming-language-javascript)
47 */
48export function serviceBusQueue(options: ServiceBusQueueTriggerOptions): ServiceBusQueueTrigger;
49
50/**
51 * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-service-bus-trigger?pivots=programming-language-javascript)
52 */
53export function serviceBusTopic(options: ServiceBusTopicTriggerOptions): ServiceBusTopicTrigger;
54
55/**
56 * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-event-hubs-trigger?pivots=programming-language-javascript)
57 */
58export function eventHub(options: EventHubTriggerOptions): EventHubTrigger;
59
60/**
61 * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-event-grid-trigger?pivots=programming-language-javascript)
62 */
63export function eventGrid(options: EventGridTriggerOptions): EventGridTrigger;
64
65/**
66 * [Link to docs and examples](https://docs.microsoft.com/azure/azure-functions/functions-bindings-cosmosdb-v2-trigger?pivots=programming-language-javascript)
67 */
68export function cosmosDB(options: CosmosDBTriggerOptions): CosmosDBTrigger;
69
70/**
71 * [Link to docs and examples](https://learn.microsoft.com/azure/azure-functions/functions-bindings-warmup?tabs=isolated-process&pivots=programming-language-javascript)
72 */
73export function warmup(options: WarmupTriggerOptions): WarmupTrigger;
74
75/**
76 * A generic option that can be used for any trigger type
77 * Use this method if your desired trigger type does not already have its own method
78 */
79export function generic(options: GenericTriggerOptions): FunctionTrigger;