-
Notifications
You must be signed in to change notification settings - Fork 181
/
HttpHeaders.yml
174 lines (171 loc) · 5.33 KB
/
HttpHeaders.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
### YamlMime:TSType
name: HttpHeaders
uid: '@azure/ms-rest-js.HttpHeaders'
package: '@azure/ms-rest-js'
summary: A collection of HTTP header key/value pairs.
fullName: HttpHeaders
remarks: ''
isDeprecated: false
type: class
constructors:
- name: HttpHeaders(RawHttpHeaders)
uid: '@azure/ms-rest-js.HttpHeaders.constructor'
package: '@azure/ms-rest-js'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'new HttpHeaders(rawHeaders?: RawHttpHeaders)'
parameters:
- id: rawHeaders
type: <xref uid="@azure/ms-rest-js.RawHttpHeaders" />
description: ''
methods:
- name: clone()
uid: '@azure/ms-rest-js.HttpHeaders.clone'
package: '@azure/ms-rest-js'
summary: Create a deep clone/copy of this HttpHeaders collection.
remarks: ''
isDeprecated: false
syntax:
content: 'function clone(): HttpHeaders'
return:
description: ''
type: <xref uid="@azure/ms-rest-js.HttpHeaders" />
- name: contains(string)
uid: '@azure/ms-rest-js.HttpHeaders.contains'
package: '@azure/ms-rest-js'
summary: >-
Get whether or not this header collection contains a header entry for the
provided header name.
remarks: ''
isDeprecated: false
syntax:
content: 'function contains(headerName: string): boolean'
parameters:
- id: headerName
type: string
description: ''
return:
description: ''
type: boolean
- name: get(string)
uid: '@azure/ms-rest-js.HttpHeaders.get'
package: '@azure/ms-rest-js'
summary: >-
Get the header value for the provided header name, or undefined if no
header exists in this
collection with the provided name.
remarks: ''
isDeprecated: false
syntax:
content: 'function get(headerName: string): undefined | string'
parameters:
- id: headerName
type: string
description: The name of the header.
return:
description: ''
type: undefined | string
- name: headerNames()
uid: '@azure/ms-rest-js.HttpHeaders.headerNames'
package: '@azure/ms-rest-js'
summary: Get the header names that are contained in this collection.
remarks: ''
isDeprecated: false
syntax:
content: 'function headerNames(): string[]'
return:
description: ''
type: string[]
- name: headersArray()
uid: '@azure/ms-rest-js.HttpHeaders.headersArray'
package: '@azure/ms-rest-js'
summary: Get the headers that are contained in this collection as an array.
remarks: ''
isDeprecated: false
syntax:
content: 'function headersArray(): HttpHeader[]'
return:
description: ''
type: <xref uid="@azure/ms-rest-js.HttpHeader" />[]
- name: headerValues()
uid: '@azure/ms-rest-js.HttpHeaders.headerValues'
package: '@azure/ms-rest-js'
summary: Get the header names that are contained in this collection.
remarks: ''
isDeprecated: false
syntax:
content: 'function headerValues(): string[]'
return:
description: ''
type: string[]
- name: rawHeaders()
uid: '@azure/ms-rest-js.HttpHeaders.rawHeaders'
package: '@azure/ms-rest-js'
summary: Get the headers that are contained this collection as an object.
remarks: ''
isDeprecated: false
syntax:
content: 'function rawHeaders(): RawHttpHeaders'
return:
description: ''
type: <xref uid="@azure/ms-rest-js.RawHttpHeaders" />
- name: remove(string)
uid: '@azure/ms-rest-js.HttpHeaders.remove'
package: '@azure/ms-rest-js'
summary: >-
Remove the header with the provided headerName. Return whether or not the
header existed and
was removed.
remarks: ''
isDeprecated: false
syntax:
content: 'function remove(headerName: string): boolean'
parameters:
- id: headerName
type: string
description: The name of the header to remove.
return:
description: ''
type: boolean
- name: set(string, string | number)
uid: '@azure/ms-rest-js.HttpHeaders.set'
package: '@azure/ms-rest-js'
summary: >-
Set a header in this collection with the provided name and value. The name
is
case-insensitive.
remarks: ''
isDeprecated: false
syntax:
content: 'function set(headerName: string, headerValue: string | number)'
parameters:
- id: headerName
type: string
description: The name of the header to set. This value is case-insensitive.
- id: headerValue
type: string | number
description: The value of the header to set.
- name: toJson()
uid: '@azure/ms-rest-js.HttpHeaders.toJson'
package: '@azure/ms-rest-js'
summary: Get the JSON object representation of this HTTP header collection.
remarks: ''
isDeprecated: false
syntax:
content: 'function toJson(): RawHttpHeaders'
return:
description: ''
type: <xref uid="@azure/ms-rest-js.RawHttpHeaders" />
- name: toString()
uid: '@azure/ms-rest-js.HttpHeaders.toString'
package: '@azure/ms-rest-js'
summary: Get the string representation of this HTTP header collection.
remarks: ''
isDeprecated: false
syntax:
content: 'function toString(): string'
return:
description: ''
type: string