/
HttpOperationResponse.yml
121 lines (119 loc) · 3.72 KB
/
HttpOperationResponse.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
### YamlMime:TSType
name: HttpOperationResponse
uid: '@azure/storage-file-share.HttpOperationResponse'
package: '@azure/storage-file-share'
summary: |-
Wrapper object for http request and response. Deserialized object is stored in
the `parsedBody` property when the response body is received in JSON or XML.
fullName: HttpOperationResponse
remarks: ''
isDeprecated: false
type: interface
properties:
- name: blobBody
uid: '@azure/storage-file-share.HttpOperationResponse.blobBody'
package: '@azure/storage-file-share'
summary: |-
BROWSER ONLY
The response body as a browser Blob.
Always undefined in node.js.
fullName: blobBody
remarks: ''
isDeprecated: false
syntax:
content: 'blobBody?: Promise<Blob>'
return:
description: ''
type: Promise<Blob>
- name: bodyAsText
uid: '@azure/storage-file-share.HttpOperationResponse.bodyAsText'
package: '@azure/storage-file-share'
summary: The response body as text (string format)
fullName: bodyAsText
remarks: ''
isDeprecated: false
syntax:
content: 'bodyAsText?: null | string'
return:
description: ''
type: null | string
- name: parsedBody
uid: '@azure/storage-file-share.HttpOperationResponse.parsedBody'
package: '@azure/storage-file-share'
summary: The response body as parsed JSON or XML
fullName: parsedBody
remarks: ''
isDeprecated: false
syntax:
content: 'parsedBody?: any'
return:
description: ''
type: any
- name: parsedHeaders
uid: '@azure/storage-file-share.HttpOperationResponse.parsedHeaders'
package: '@azure/storage-file-share'
summary: The parsed HTTP response headers.
fullName: parsedHeaders
remarks: ''
isDeprecated: false
syntax:
content: 'parsedHeaders?: {[key: string]: any}'
return:
description: ''
type: '{[key: string]: any}'
- name: readableStreamBody
uid: '@azure/storage-file-share.HttpOperationResponse.readableStreamBody'
package: '@azure/storage-file-share'
summary: |-
NODEJS ONLY
The response body as a node.js Readable stream.
Always undefined in the browser.
fullName: readableStreamBody
remarks: ''
isDeprecated: false
syntax:
content: 'readableStreamBody?: ReadableStream'
return:
description: ''
type: ReadableStream
inheritedProperties:
- name: headers
uid: '@azure/storage-file-share.HttpOperationResponse.headers'
package: '@azure/storage-file-share'
summary: The HTTP response headers.
fullName: headers
remarks: ''
isDeprecated: false
syntax:
content: 'headers: HttpHeadersLike'
return:
description: ''
type: <xref uid="@azure/core-http.HttpHeadersLike" />
inheritanceDescription: <b>Inherited From</b> HttpResponse.headers
- name: request
uid: '@azure/storage-file-share.HttpOperationResponse.request'
package: '@azure/storage-file-share'
summary: The raw request
fullName: request
remarks: ''
isDeprecated: false
syntax:
content: 'request: WebResourceLike'
return:
description: ''
type: <xref uid="@azure/core-http.WebResourceLike" />
inheritanceDescription: <b>Inherited From</b> HttpResponse.request
- name: status
uid: '@azure/storage-file-share.HttpOperationResponse.status'
package: '@azure/storage-file-share'
summary: The HTTP response status (e.g. 200)
fullName: status
remarks: ''
isDeprecated: false
syntax:
content: 'status: number'
return:
description: ''
type: number
inheritanceDescription: <b>Inherited From</b> HttpResponse.status
extends: <xref uid="@azure/core-http.HttpResponse" />