-
Notifications
You must be signed in to change notification settings - Fork 180
/
PollerLikeWithCancellation.yml
157 lines (153 loc) · 5.31 KB
/
PollerLikeWithCancellation.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
### YamlMime:TSType
name: PollerLikeWithCancellation
uid: '@azure/keyvault-certificates.PollerLikeWithCancellation'
package: '@azure/keyvault-certificates'
summary: >-
Abstract representation of a poller, intended to expose just the minimal API
that the user needs to work with.
fullName: PollerLikeWithCancellation<TState, TResult>
remarks: ''
isDeprecated: false
type: interface
methods:
- name: 'cancelOperation({ abortSignal?: AbortSignalLike })'
uid: '@azure/keyvault-certificates.PollerLikeWithCancellation.cancelOperation'
package: '@azure/keyvault-certificates'
summary: Attempts to cancel the underlying operation.
remarks: ''
isDeprecated: false
syntax:
content: >-
function cancelOperation(options?: { abortSignal?: AbortSignalLike }):
Promise<void>
parameters:
- id: options
type: '{ abortSignal?: AbortSignalLike }'
description: ''
return:
description: ''
type: Promise<void>
- name: getOperationState()
uid: '@azure/keyvault-certificates.PollerLikeWithCancellation.getOperationState'
package: '@azure/keyvault-certificates'
summary: |-
Returns the state of the operation.
The TState defined in PollerLike can be a subset of the TState defined in
the Poller implementation.
remarks: ''
isDeprecated: false
syntax:
content: 'function getOperationState(): TState'
return:
description: ''
type: TState
- name: getResult()
uid: '@azure/keyvault-certificates.PollerLikeWithCancellation.getResult'
package: '@azure/keyvault-certificates'
summary: |-
Returns the result value of the operation,
regardless of the state of the poller.
It can return undefined or an incomplete form of the final TResult value
depending on the implementation.
remarks: ''
isDeprecated: false
syntax:
content: 'function getResult(): undefined | TResult'
return:
description: ''
type: undefined | TResult
- name: isDone()
uid: '@azure/keyvault-certificates.PollerLikeWithCancellation.isDone'
package: '@azure/keyvault-certificates'
summary: Returns true if the poller has finished polling.
remarks: ''
isDeprecated: false
syntax:
content: 'function isDone(): boolean'
return:
description: ''
type: boolean
- name: isStopped()
uid: '@azure/keyvault-certificates.PollerLikeWithCancellation.isStopped'
package: '@azure/keyvault-certificates'
summary: Returns true if the poller is stopped.
remarks: ''
isDeprecated: false
syntax:
content: 'function isStopped(): boolean'
return:
description: ''
type: boolean
- name: 'onProgress((state: TState) => void)'
uid: '@azure/keyvault-certificates.PollerLikeWithCancellation.onProgress'
package: '@azure/keyvault-certificates'
summary: >-
Invokes the provided callback after each polling is completed,
sending the current state of the poller's operation.
It returns a method that can be used to stop receiving updates on the
given callback function.
remarks: ''
isDeprecated: false
syntax:
content: 'function onProgress(callback: (state: TState) => void): CancelOnProgress'
parameters:
- id: callback
type: '(state: TState) => void'
description: ''
return:
description: ''
type: <xref uid="@azure/core-lro.CancelOnProgress" />
- name: 'poll({ abortSignal?: AbortSignalLike })'
uid: '@azure/keyvault-certificates.PollerLikeWithCancellation.poll'
package: '@azure/keyvault-certificates'
summary: >-
Returns a promise that will resolve once a single polling request
finishes.
It does this by calling the update method of the Poller's operation.
remarks: ''
isDeprecated: false
syntax:
content: >-
function poll(options?: { abortSignal?: AbortSignalLike }):
Promise<void>
parameters:
- id: options
type: '{ abortSignal?: AbortSignalLike }'
description: ''
return:
description: ''
type: Promise<void>
- name: pollUntilDone()
uid: '@azure/keyvault-certificates.PollerLikeWithCancellation.pollUntilDone'
package: '@azure/keyvault-certificates'
summary: >-
Returns a promise that will resolve once the underlying operation is
completed.
remarks: ''
isDeprecated: false
syntax:
content: 'function pollUntilDone(): Promise<TResult>'
return:
description: ''
type: Promise<TResult>
- name: stopPolling()
uid: '@azure/keyvault-certificates.PollerLikeWithCancellation.stopPolling'
package: '@azure/keyvault-certificates'
summary: Stops the poller. After this, no manual or automated requests can be sent.
remarks: ''
isDeprecated: false
syntax:
content: function stopPolling()
- name: toString()
uid: '@azure/keyvault-certificates.PollerLikeWithCancellation.toString'
package: '@azure/keyvault-certificates'
summary: |-
Returns a serialized version of the poller's operation
by invoking the operation's toString method.
remarks: ''
isDeprecated: false
syntax:
content: 'function toString(): string'
return:
description: ''
type: string