-
Notifications
You must be signed in to change notification settings - Fork 181
/
RestError.yml
227 lines (226 loc) · 6.16 KB
/
RestError.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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
### YamlMime:TSType
name: RestError
uid: '@azure/ms-rest-js.RestError'
package: '@azure/ms-rest-js'
summary: ''
fullName: RestError
remarks: ''
isDeprecated: false
type: class
constructors:
- name: >-
RestError(string, string, number, WebResourceLike, HttpOperationResponse,
any)
uid: '@azure/ms-rest-js.RestError.constructor'
package: '@azure/ms-rest-js'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
new RestError(message: string, code?: string, statusCode?: number,
request?: WebResourceLike, response?: HttpOperationResponse, body?: any)
parameters:
- id: message
type: string
description: ''
- id: code
type: string
description: ''
- id: statusCode
type: number
description: ''
- id: request
type: <xref uid="@azure/ms-rest-js.WebResourceLike" />
description: ''
- id: response
type: <xref uid="@azure/ms-rest-js.HttpOperationResponse" />
description: ''
- id: body
type: any
description: ''
properties:
- name: body
uid: '@azure/ms-rest-js.RestError.body'
package: '@azure/ms-rest-js'
summary: ''
fullName: body
remarks: ''
isDeprecated: false
syntax:
content: 'body?: any'
return:
description: ''
type: any
- name: code
uid: '@azure/ms-rest-js.RestError.code'
package: '@azure/ms-rest-js'
summary: ''
fullName: code
remarks: ''
isDeprecated: false
syntax:
content: 'code?: string'
return:
description: ''
type: string
- name: PARSE_ERROR
uid: '@azure/ms-rest-js.RestError.PARSE_ERROR'
package: '@azure/ms-rest-js'
summary: ''
fullName: PARSE_ERROR
remarks: ''
isDeprecated: false
syntax:
content: 'static PARSE_ERROR: string'
return:
description: ''
type: string
- name: request
uid: '@azure/ms-rest-js.RestError.request'
package: '@azure/ms-rest-js'
summary: ''
fullName: request
remarks: ''
isDeprecated: false
syntax:
content: 'request?: WebResourceLike'
return:
description: ''
type: <xref uid="@azure/ms-rest-js.WebResourceLike" />
- name: REQUEST_ABORTED_ERROR
uid: '@azure/ms-rest-js.RestError.REQUEST_ABORTED_ERROR'
package: '@azure/ms-rest-js'
summary: ''
fullName: REQUEST_ABORTED_ERROR
remarks: ''
isDeprecated: false
syntax:
content: 'static REQUEST_ABORTED_ERROR: string'
return:
description: ''
type: string
- name: REQUEST_SEND_ERROR
uid: '@azure/ms-rest-js.RestError.REQUEST_SEND_ERROR'
package: '@azure/ms-rest-js'
summary: ''
fullName: REQUEST_SEND_ERROR
remarks: ''
isDeprecated: false
syntax:
content: 'static REQUEST_SEND_ERROR: string'
return:
description: ''
type: string
- name: response
uid: '@azure/ms-rest-js.RestError.response'
package: '@azure/ms-rest-js'
summary: ''
fullName: response
remarks: ''
isDeprecated: false
syntax:
content: 'response?: HttpOperationResponse'
return:
description: ''
type: <xref uid="@azure/ms-rest-js.HttpOperationResponse" />
- name: statusCode
uid: '@azure/ms-rest-js.RestError.statusCode'
package: '@azure/ms-rest-js'
summary: ''
fullName: statusCode
remarks: ''
isDeprecated: false
syntax:
content: 'statusCode?: number'
return:
description: ''
type: number
inheritedProperties:
- name: message
uid: '@azure/ms-rest-js.RestError.message'
package: '@azure/ms-rest-js'
summary: ''
fullName: message
remarks: ''
isDeprecated: false
syntax:
content: 'message: string'
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> Error.message
- name: name
uid: '@azure/ms-rest-js.RestError.name'
package: '@azure/ms-rest-js'
summary: ''
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> Error.name
- name: prepareStackTrace
uid: '@azure/ms-rest-js.RestError.prepareStackTrace'
package: '@azure/ms-rest-js'
summary: |-
Optional override for formatting stack traces
See https://v8.dev/docs/stack-trace-api#customizing-stack-traces
fullName: prepareStackTrace
remarks: ''
isDeprecated: false
syntax:
content: 'static prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any'
return:
description: ''
type: '(err: Error, stackTraces: CallSite[]) => any'
inheritanceDescription: <b>Inherited From</b> Error.prepareStackTrace
- name: stack
uid: '@azure/ms-rest-js.RestError.stack'
package: '@azure/ms-rest-js'
summary: ''
fullName: stack
remarks: ''
isDeprecated: false
syntax:
content: 'stack?: string'
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> Error.stack
- name: stackTraceLimit
uid: '@azure/ms-rest-js.RestError.stackTraceLimit'
package: '@azure/ms-rest-js'
summary: ''
fullName: stackTraceLimit
remarks: ''
isDeprecated: false
syntax:
content: 'static stackTraceLimit: number'
return:
description: ''
type: number
inheritanceDescription: <b>Inherited From</b> Error.stackTraceLimit
inheritedMethods:
- name: captureStackTrace(object, Function)
uid: '@azure/ms-rest-js.RestError.captureStackTrace'
package: '@azure/ms-rest-js'
summary: Create .stack property on a target object
remarks: ''
isDeprecated: false
syntax:
content: >-
static function captureStackTrace(targetObject: object, constructorOpt?:
Function)
parameters:
- id: targetObject
type: object
description: ''
- id: constructorOpt
type: Function
description: ''
inheritanceDescription: <b>Inherited From</b> Error.captureStackTrace
extends: Error