/
ErrorWithCode.yml
127 lines (126 loc) · 3.7 KB
/
ErrorWithCode.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
### YamlMime:TSType
name: ErrorWithCode
uid: '@microsoft/teamsfx.ErrorWithCode'
package: '@microsoft/teamsfx'
summary: Error class with code and message thrown by the SDK.
fullName: ErrorWithCode
remarks: ''
isDeprecated: false
type: class
constructors:
- name: ErrorWithCode(string, ErrorCode)
uid: '@microsoft/teamsfx.ErrorWithCode.constructor'
package: '@microsoft/teamsfx'
summary: Constructor of ErrorWithCode.
remarks: ''
isDeprecated: false
syntax:
content: 'new ErrorWithCode(message?: string, code?: ErrorCode)'
parameters:
- id: message
type: string
description: error message.
- id: code
type: <xref uid="@microsoft/teamsfx.ErrorCode" />
description: error code.
properties:
- name: code
uid: '@microsoft/teamsfx.ErrorWithCode.code'
package: '@microsoft/teamsfx'
summary: Error code
fullName: code
remarks: ''
isDeprecated: false
syntax:
content: 'code: undefined | string'
return:
description: ''
type: undefined | string
inheritedProperties:
- name: message
uid: '@microsoft/teamsfx.ErrorWithCode.message'
package: '@microsoft/teamsfx'
summary: ''
fullName: message
remarks: ''
isDeprecated: false
syntax:
content: 'message: string'
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> Error.message
- name: name
uid: '@microsoft/teamsfx.ErrorWithCode.name'
package: '@microsoft/teamsfx'
summary: ''
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name: string'
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> Error.name
- name: prepareStackTrace
uid: '@microsoft/teamsfx.ErrorWithCode.prepareStackTrace'
package: '@microsoft/teamsfx'
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: '@microsoft/teamsfx.ErrorWithCode.stack'
package: '@microsoft/teamsfx'
summary: ''
fullName: stack
remarks: ''
isDeprecated: false
syntax:
content: 'stack?: string'
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> Error.stack
- name: stackTraceLimit
uid: '@microsoft/teamsfx.ErrorWithCode.stackTraceLimit'
package: '@microsoft/teamsfx'
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: '@microsoft/teamsfx.ErrorWithCode.captureStackTrace'
package: '@microsoft/teamsfx'
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