-
Notifications
You must be signed in to change notification settings - Fork 180
/
HttpRequest.yml
184 lines (184 loc) · 5.3 KB
/
HttpRequest.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
### YamlMime:TSType
name: HttpRequest
uid: '@azure/functions.HttpRequest'
package: '@azure/functions'
summary: HTTP request object. Provided to your function when using HTTP Bindings.
fullName: HttpRequest
remarks: ''
isDeprecated: false
type: class
constructors:
- name: HttpRequest(HttpRequestInit)
uid: '@azure/functions.HttpRequest.constructor'
package: '@azure/functions'
summary: >-
For testing purposes only. This will always be constructed for you when
run in the context of the Azure Functions runtime
remarks: ''
isDeprecated: false
syntax:
content: 'new HttpRequest(httpRequestInit: HttpRequestInit)'
parameters:
- id: httpRequestInit
type: <xref uid="@azure/functions.HttpRequestInit" />
description: ''
properties:
- name: arrayBuffer
uid: '@azure/functions.HttpRequest.arrayBuffer'
package: '@azure/functions'
summary: Returns a promise fulfilled with the body as an ArrayBuffer
fullName: arrayBuffer
remarks: ''
isDeprecated: false
syntax:
content: 'arrayBuffer: () => Promise<ArrayBuffer>'
return:
description: ''
type: () => Promise<ArrayBuffer>
- name: blob
uid: '@azure/functions.HttpRequest.blob'
package: '@azure/functions'
summary: Returns a promise fulfilled with the body as a Blob
fullName: blob
remarks: ''
isDeprecated: false
syntax:
content: 'blob: () => Promise<Blob>'
return:
description: ''
type: () => Promise<Blob>
- name: body
uid: '@azure/functions.HttpRequest.body'
package: '@azure/functions'
summary: Returns the body as a ReadableStream
fullName: body
remarks: ''
isDeprecated: false
syntax:
content: 'body: null | ReadableStream<any>'
return:
description: ''
type: null | ReadableStream<any>
- name: bodyUsed
uid: '@azure/functions.HttpRequest.bodyUsed'
package: '@azure/functions'
summary: Returns whether the body has been read from
fullName: bodyUsed
remarks: ''
isDeprecated: false
syntax:
content: 'bodyUsed: boolean'
return:
description: ''
type: boolean
- name: formData
uid: '@azure/functions.HttpRequest.formData'
package: '@azure/functions'
summary: Returns a promise fulfilled with the body as FormData
fullName: formData
remarks: ''
isDeprecated: false
syntax:
content: 'formData: () => Promise<FormData>'
return:
description: ''
type: () => Promise<FormData>
- name: headers
uid: '@azure/functions.HttpRequest.headers'
package: '@azure/functions'
summary: HTTP request headers.
fullName: headers
remarks: ''
isDeprecated: false
syntax:
content: 'headers: Headers'
return:
description: ''
type: Headers
- name: json
uid: '@azure/functions.HttpRequest.json'
package: '@azure/functions'
summary: Returns a promise fulfilled with the body parsed as JSON
fullName: json
remarks: ''
isDeprecated: false
syntax:
content: 'json: () => Promise<unknown>'
return:
description: ''
type: () => Promise<unknown>
- name: method
uid: '@azure/functions.HttpRequest.method'
package: '@azure/functions'
summary: HTTP request method used to invoke this function.
fullName: method
remarks: ''
isDeprecated: false
syntax:
content: 'method: string'
return:
description: ''
type: string
- name: params
uid: '@azure/functions.HttpRequest.params'
package: '@azure/functions'
summary: Route parameter keys and values.
fullName: params
remarks: ''
isDeprecated: false
syntax:
content: 'params: HttpRequestParams'
return:
description: ''
type: <xref uid="@azure/functions.HttpRequestParams" />
- name: query
uid: '@azure/functions.HttpRequest.query'
package: '@azure/functions'
summary: Query string parameter keys and values from the URL.
fullName: query
remarks: ''
isDeprecated: false
syntax:
content: 'query: URLSearchParams'
return:
description: ''
type: URLSearchParams
- name: text
uid: '@azure/functions.HttpRequest.text'
package: '@azure/functions'
summary: Returns a promise fulfilled with the body as a string
fullName: text
remarks: ''
isDeprecated: false
syntax:
content: 'text: () => Promise<string>'
return:
description: ''
type: () => Promise<string>
- name: url
uid: '@azure/functions.HttpRequest.url'
package: '@azure/functions'
summary: Request URL.
fullName: url
remarks: ''
isDeprecated: false
syntax:
content: 'url: string'
return:
description: ''
type: string
- name: user
uid: '@azure/functions.HttpRequest.user'
package: '@azure/functions'
summary: |-
Object representing logged-in user, either through
AppService/Functions authentication, or SWA Authentication
null when no such user is logged in.
fullName: user
remarks: ''
isDeprecated: false
syntax:
content: 'user: null | HttpRequestUser'
return:
description: ''
type: null | <xref uid="@azure/functions.HttpRequestUser" />