@azure/core-lro 3.0.0-beta.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/dist/browser/http/models.d.ts +2 -2
  2. package/dist/browser/http/models.d.ts.map +1 -1
  3. package/dist/browser/http/models.js.map +1 -1
  4. package/dist/browser/http/operation.d.ts +11 -12
  5. package/dist/browser/http/operation.d.ts.map +1 -1
  6. package/dist/browser/http/operation.js +22 -16
  7. package/dist/browser/http/operation.js.map +1 -1
  8. package/dist/browser/http/poller.d.ts +2 -2
  9. package/dist/browser/http/poller.d.ts.map +1 -1
  10. package/dist/browser/http/poller.js +1 -15
  11. package/dist/browser/http/poller.js.map +1 -1
  12. package/dist/browser/index.d.ts +1 -1
  13. package/dist/browser/index.d.ts.map +1 -1
  14. package/dist/browser/index.js.map +1 -1
  15. package/dist/browser/poller/models.d.ts +15 -39
  16. package/dist/browser/poller/models.d.ts.map +1 -1
  17. package/dist/browser/poller/models.js.map +1 -1
  18. package/dist/browser/poller/operation.d.ts +12 -14
  19. package/dist/browser/poller/operation.d.ts.map +1 -1
  20. package/dist/browser/poller/operation.js +25 -29
  21. package/dist/browser/poller/operation.js.map +1 -1
  22. package/dist/browser/poller/poller.d.ts +1 -1
  23. package/dist/browser/poller/poller.d.ts.map +1 -1
  24. package/dist/browser/poller/poller.js +9 -34
  25. package/dist/browser/poller/poller.js.map +1 -1
  26. package/dist/commonjs/http/models.d.ts +2 -2
  27. package/dist/commonjs/http/models.d.ts.map +1 -1
  28. package/dist/commonjs/http/models.js.map +1 -1
  29. package/dist/commonjs/http/operation.d.ts +11 -12
  30. package/dist/commonjs/http/operation.d.ts.map +1 -1
  31. package/dist/commonjs/http/operation.js +22 -16
  32. package/dist/commonjs/http/operation.js.map +1 -1
  33. package/dist/commonjs/http/poller.d.ts +2 -2
  34. package/dist/commonjs/http/poller.d.ts.map +1 -1
  35. package/dist/commonjs/http/poller.js +1 -15
  36. package/dist/commonjs/http/poller.js.map +1 -1
  37. package/dist/commonjs/index.d.ts +1 -1
  38. package/dist/commonjs/index.d.ts.map +1 -1
  39. package/dist/commonjs/index.js.map +1 -1
  40. package/dist/commonjs/poller/models.d.ts +15 -39
  41. package/dist/commonjs/poller/models.d.ts.map +1 -1
  42. package/dist/commonjs/poller/models.js.map +1 -1
  43. package/dist/commonjs/poller/operation.d.ts +12 -14
  44. package/dist/commonjs/poller/operation.d.ts.map +1 -1
  45. package/dist/commonjs/poller/operation.js +25 -29
  46. package/dist/commonjs/poller/operation.js.map +1 -1
  47. package/dist/commonjs/poller/poller.d.ts +1 -1
  48. package/dist/commonjs/poller/poller.d.ts.map +1 -1
  49. package/dist/commonjs/poller/poller.js +9 -34
  50. package/dist/commonjs/poller/poller.js.map +1 -1
  51. package/dist/commonjs/tsdoc-metadata.json +1 -1
  52. package/dist/core-lro.d.ts +28 -32
  53. package/dist/esm/http/models.d.ts +2 -2
  54. package/dist/esm/http/models.d.ts.map +1 -1
  55. package/dist/esm/http/models.js.map +1 -1
  56. package/dist/esm/http/operation.d.ts +11 -12
  57. package/dist/esm/http/operation.d.ts.map +1 -1
  58. package/dist/esm/http/operation.js +22 -16
  59. package/dist/esm/http/operation.js.map +1 -1
  60. package/dist/esm/http/poller.d.ts +2 -2
  61. package/dist/esm/http/poller.d.ts.map +1 -1
  62. package/dist/esm/http/poller.js +1 -15
  63. package/dist/esm/http/poller.js.map +1 -1
  64. package/dist/esm/index.d.ts +1 -1
  65. package/dist/esm/index.d.ts.map +1 -1
  66. package/dist/esm/index.js.map +1 -1
  67. package/dist/esm/poller/models.d.ts +15 -39
  68. package/dist/esm/poller/models.d.ts.map +1 -1
  69. package/dist/esm/poller/models.js.map +1 -1
  70. package/dist/esm/poller/operation.d.ts +12 -14
  71. package/dist/esm/poller/operation.d.ts.map +1 -1
  72. package/dist/esm/poller/operation.js +25 -29
  73. package/dist/esm/poller/operation.js.map +1 -1
  74. package/dist/esm/poller/poller.d.ts +1 -1
  75. package/dist/esm/poller/poller.d.ts.map +1 -1
  76. package/dist/esm/poller/poller.js +9 -34
  77. package/dist/esm/poller/poller.js.map +1 -1
  78. package/dist/react-native/http/models.d.ts +2 -2
  79. package/dist/react-native/http/models.d.ts.map +1 -1
  80. package/dist/react-native/http/models.js.map +1 -1
  81. package/dist/react-native/http/operation.d.ts +11 -12
  82. package/dist/react-native/http/operation.d.ts.map +1 -1
  83. package/dist/react-native/http/operation.js +22 -16
  84. package/dist/react-native/http/operation.js.map +1 -1
  85. package/dist/react-native/http/poller.d.ts +2 -2
  86. package/dist/react-native/http/poller.d.ts.map +1 -1
  87. package/dist/react-native/http/poller.js +1 -15
  88. package/dist/react-native/http/poller.js.map +1 -1
  89. package/dist/react-native/index.d.ts +1 -1
  90. package/dist/react-native/index.d.ts.map +1 -1
  91. package/dist/react-native/index.js.map +1 -1
  92. package/dist/react-native/poller/models.d.ts +15 -39
  93. package/dist/react-native/poller/models.d.ts.map +1 -1
  94. package/dist/react-native/poller/models.js.map +1 -1
  95. package/dist/react-native/poller/operation.d.ts +12 -14
  96. package/dist/react-native/poller/operation.d.ts.map +1 -1
  97. package/dist/react-native/poller/operation.js +25 -29
  98. package/dist/react-native/poller/operation.js.map +1 -1
  99. package/dist/react-native/poller/poller.d.ts +1 -1
  100. package/dist/react-native/poller/poller.d.ts.map +1 -1
  101. package/dist/react-native/poller/poller.js +9 -34
  102. package/dist/react-native/poller/poller.js.map +1 -1
  103. package/package.json +26 -20
  104. package/.rush/temp/operation/build/state.json +0 -3
  105. package/.rush/temp/operation/build_samples/all.log +0 -2
  106. package/.rush/temp/operation/build_samples/state.json +0 -3
  107. package/.rush/temp/shrinkwrap-deps.json +0 -510
  108. package/.tshy/browser.json +0 -12
  109. package/.tshy/build.json +0 -9
  110. package/.tshy/commonjs.json +0 -14
  111. package/.tshy/esm.json +0 -12
  112. package/.tshy/react-native.json +0 -12
  113. package/CHANGELOG.md +0 -179
  114. package/api-extractor.json +0 -31
  115. package/config/rush-project.json +0 -3
  116. package/core-lro.build.cache.error.log +0 -1
  117. package/core-lro.build_samples.cache.log +0 -1
  118. package/core-lro.build_samples.log +0 -2
  119. package/core-lro.pack.cache.log +0 -1
  120. package/core-lro.pack.log +0 -1
  121. package/docs/LROEngine.md +0 -158
  122. package/review/core-lro.api.md +0 -106
  123. package/samples/README.md +0 -284
  124. package/samples/typescript/samplesClient.ts +0 -254
  125. package/src/http/models.ts +0 -119
  126. package/src/http/operation.ts +0 -343
  127. package/src/http/poller.ts +0 -83
  128. package/src/index.ts +0 -21
  129. package/src/logger.ts +0 -10
  130. package/src/poller/constants.ts +0 -11
  131. package/src/poller/models.ts +0 -251
  132. package/src/poller/operation.ts +0 -315
  133. package/src/poller/poller.ts +0 -250
  134. package/temp/core-lro.api.json +0 -1892
  135. package/temp/core-lro.api.md +0 -106
  136. package/test/getYieldedValue.ts +0 -16
  137. package/test/lro.spec.ts +0 -3141
  138. package/test/matrix.ts +0 -46
  139. package/test/utils/coreRestPipelineLro.ts +0 -25
  140. package/test/utils/router.ts +0 -231
  141. package/test/utils/utils.ts +0 -144
  142. package/tsconfig.browser.config.json +0 -10
  143. package/tsconfig.json +0 -13
  144. package/tsdoc.json +0 -4
  145. package/tslint.json +0 -47
  146. package/vitest.browser.config.ts +0 -34
  147. package/vitest.config.ts +0 -31
@@ -1,1892 +0,0 @@
1
- {
2
- "metadata": {
3
- "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.40.3",
5
- "schemaVersion": 1011,
6
- "oldestForwardsCompatibleVersion": 1001,
7
- "tsdocConfig": {
8
- "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
9
- "noStandardTags": true,
10
- "tagDefinitions": [
11
- {
12
- "tagName": "@alpha",
13
- "syntaxKind": "modifier"
14
- },
15
- {
16
- "tagName": "@beta",
17
- "syntaxKind": "modifier"
18
- },
19
- {
20
- "tagName": "@defaultValue",
21
- "syntaxKind": "block"
22
- },
23
- {
24
- "tagName": "@decorator",
25
- "syntaxKind": "block",
26
- "allowMultiple": true
27
- },
28
- {
29
- "tagName": "@deprecated",
30
- "syntaxKind": "block"
31
- },
32
- {
33
- "tagName": "@eventProperty",
34
- "syntaxKind": "modifier"
35
- },
36
- {
37
- "tagName": "@example",
38
- "syntaxKind": "block",
39
- "allowMultiple": true
40
- },
41
- {
42
- "tagName": "@experimental",
43
- "syntaxKind": "modifier"
44
- },
45
- {
46
- "tagName": "@inheritDoc",
47
- "syntaxKind": "inline"
48
- },
49
- {
50
- "tagName": "@internal",
51
- "syntaxKind": "modifier"
52
- },
53
- {
54
- "tagName": "@label",
55
- "syntaxKind": "inline"
56
- },
57
- {
58
- "tagName": "@link",
59
- "syntaxKind": "inline",
60
- "allowMultiple": true
61
- },
62
- {
63
- "tagName": "@override",
64
- "syntaxKind": "modifier"
65
- },
66
- {
67
- "tagName": "@packageDocumentation",
68
- "syntaxKind": "modifier"
69
- },
70
- {
71
- "tagName": "@param",
72
- "syntaxKind": "block",
73
- "allowMultiple": true
74
- },
75
- {
76
- "tagName": "@privateRemarks",
77
- "syntaxKind": "block"
78
- },
79
- {
80
- "tagName": "@public",
81
- "syntaxKind": "modifier"
82
- },
83
- {
84
- "tagName": "@readonly",
85
- "syntaxKind": "modifier"
86
- },
87
- {
88
- "tagName": "@remarks",
89
- "syntaxKind": "block"
90
- },
91
- {
92
- "tagName": "@returns",
93
- "syntaxKind": "block"
94
- },
95
- {
96
- "tagName": "@sealed",
97
- "syntaxKind": "modifier"
98
- },
99
- {
100
- "tagName": "@see",
101
- "syntaxKind": "block"
102
- },
103
- {
104
- "tagName": "@throws",
105
- "syntaxKind": "block",
106
- "allowMultiple": true
107
- },
108
- {
109
- "tagName": "@typeParam",
110
- "syntaxKind": "block",
111
- "allowMultiple": true
112
- },
113
- {
114
- "tagName": "@virtual",
115
- "syntaxKind": "modifier"
116
- },
117
- {
118
- "tagName": "@hidden",
119
- "syntaxKind": "modifier"
120
- }
121
- ],
122
- "reportUnsupportedHtmlElements": false
123
- }
124
- },
125
- "kind": "Package",
126
- "canonicalReference": "@azure/core-lro!",
127
- "docComment": "",
128
- "name": "@azure/core-lro",
129
- "preserveMemberOrder": false,
130
- "members": [
131
- {
132
- "kind": "EntryPoint",
133
- "canonicalReference": "@azure/core-lro!",
134
- "name": "",
135
- "preserveMemberOrder": false,
136
- "members": [
137
- {
138
- "kind": "TypeAlias",
139
- "canonicalReference": "@azure/core-lro!CancelOnProgress:type",
140
- "docComment": "/**\n * CancelOnProgress is used as the return value of a Poller's onProgress method. When a user invokes onProgress, they're required to pass in a function that will be called as a callback with the new data received each time the poll operation is updated. onProgress returns a function that will prevent any further update to reach the original callback.\n */\n",
141
- "excerptTokens": [
142
- {
143
- "kind": "Content",
144
- "text": "export type CancelOnProgress = "
145
- },
146
- {
147
- "kind": "Content",
148
- "text": "() => void"
149
- },
150
- {
151
- "kind": "Content",
152
- "text": ";"
153
- }
154
- ],
155
- "fileUrlPath": "src/poller/models.ts",
156
- "releaseTag": "Public",
157
- "name": "CancelOnProgress",
158
- "typeTokenRange": {
159
- "startIndex": 1,
160
- "endIndex": 2
161
- }
162
- },
163
- {
164
- "kind": "Function",
165
- "canonicalReference": "@azure/core-lro!createHttpPoller:function(1)",
166
- "docComment": "/**\n * Creates a poller that can be used to poll a long-running operation.\n *\n * @param lro - Description of the long-running operation\n *\n * @param options - options to configure the poller\n *\n * @returns an initialized poller\n */\n",
167
- "excerptTokens": [
168
- {
169
- "kind": "Content",
170
- "text": "export declare function createHttpPoller<TResult, TState extends "
171
- },
172
- {
173
- "kind": "Reference",
174
- "text": "OperationState",
175
- "canonicalReference": "@azure/core-lro!OperationState:interface"
176
- },
177
- {
178
- "kind": "Content",
179
- "text": "<TResult>"
180
- },
181
- {
182
- "kind": "Content",
183
- "text": ">(lro: "
184
- },
185
- {
186
- "kind": "Reference",
187
- "text": "LongRunningOperation",
188
- "canonicalReference": "@azure/core-lro!LongRunningOperation:interface"
189
- },
190
- {
191
- "kind": "Content",
192
- "text": ", options?: "
193
- },
194
- {
195
- "kind": "Reference",
196
- "text": "CreateHttpPollerOptions",
197
- "canonicalReference": "@azure/core-lro!CreateHttpPollerOptions:interface"
198
- },
199
- {
200
- "kind": "Content",
201
- "text": "<TResult, TState>"
202
- },
203
- {
204
- "kind": "Content",
205
- "text": "): "
206
- },
207
- {
208
- "kind": "Reference",
209
- "text": "PollerLike",
210
- "canonicalReference": "@azure/core-lro!PollerLike:interface"
211
- },
212
- {
213
- "kind": "Content",
214
- "text": "<TState, TResult>"
215
- },
216
- {
217
- "kind": "Content",
218
- "text": ";"
219
- }
220
- ],
221
- "fileUrlPath": "src/http/poller.ts",
222
- "returnTypeTokenRange": {
223
- "startIndex": 9,
224
- "endIndex": 11
225
- },
226
- "releaseTag": "Public",
227
- "overloadIndex": 1,
228
- "parameters": [
229
- {
230
- "parameterName": "lro",
231
- "parameterTypeTokenRange": {
232
- "startIndex": 4,
233
- "endIndex": 5
234
- },
235
- "isOptional": false
236
- },
237
- {
238
- "parameterName": "options",
239
- "parameterTypeTokenRange": {
240
- "startIndex": 6,
241
- "endIndex": 8
242
- },
243
- "isOptional": true
244
- }
245
- ],
246
- "typeParameters": [
247
- {
248
- "typeParameterName": "TResult",
249
- "constraintTokenRange": {
250
- "startIndex": 0,
251
- "endIndex": 0
252
- },
253
- "defaultTypeTokenRange": {
254
- "startIndex": 0,
255
- "endIndex": 0
256
- }
257
- },
258
- {
259
- "typeParameterName": "TState",
260
- "constraintTokenRange": {
261
- "startIndex": 1,
262
- "endIndex": 3
263
- },
264
- "defaultTypeTokenRange": {
265
- "startIndex": 0,
266
- "endIndex": 0
267
- }
268
- }
269
- ],
270
- "name": "createHttpPoller"
271
- },
272
- {
273
- "kind": "Interface",
274
- "canonicalReference": "@azure/core-lro!CreateHttpPollerOptions:interface",
275
- "docComment": "/**\n * Options for `createPoller`.\n */\n",
276
- "excerptTokens": [
277
- {
278
- "kind": "Content",
279
- "text": "export interface CreateHttpPollerOptions<TResult, TState> "
280
- }
281
- ],
282
- "fileUrlPath": "src/http/models.ts",
283
- "releaseTag": "Public",
284
- "typeParameters": [
285
- {
286
- "typeParameterName": "TResult",
287
- "constraintTokenRange": {
288
- "startIndex": 0,
289
- "endIndex": 0
290
- },
291
- "defaultTypeTokenRange": {
292
- "startIndex": 0,
293
- "endIndex": 0
294
- }
295
- },
296
- {
297
- "typeParameterName": "TState",
298
- "constraintTokenRange": {
299
- "startIndex": 0,
300
- "endIndex": 0
301
- },
302
- "defaultTypeTokenRange": {
303
- "startIndex": 0,
304
- "endIndex": 0
305
- }
306
- }
307
- ],
308
- "name": "CreateHttpPollerOptions",
309
- "preserveMemberOrder": false,
310
- "members": [
311
- {
312
- "kind": "PropertySignature",
313
- "canonicalReference": "@azure/core-lro!CreateHttpPollerOptions#intervalInMs:member",
314
- "docComment": "/**\n * Defines how much time the poller is going to wait before making a new request to the service.\n */\n",
315
- "excerptTokens": [
316
- {
317
- "kind": "Content",
318
- "text": "intervalInMs?: "
319
- },
320
- {
321
- "kind": "Content",
322
- "text": "number"
323
- },
324
- {
325
- "kind": "Content",
326
- "text": ";"
327
- }
328
- ],
329
- "isReadonly": false,
330
- "isOptional": true,
331
- "releaseTag": "Public",
332
- "name": "intervalInMs",
333
- "propertyTypeTokenRange": {
334
- "startIndex": 1,
335
- "endIndex": 2
336
- }
337
- },
338
- {
339
- "kind": "PropertySignature",
340
- "canonicalReference": "@azure/core-lro!CreateHttpPollerOptions#processResult:member",
341
- "docComment": "/**\n * A function to process the result of the LRO.\n */\n",
342
- "excerptTokens": [
343
- {
344
- "kind": "Content",
345
- "text": "processResult?: "
346
- },
347
- {
348
- "kind": "Content",
349
- "text": "(result: unknown, state: TState) => TResult | "
350
- },
351
- {
352
- "kind": "Reference",
353
- "text": "Promise",
354
- "canonicalReference": "!Promise:interface"
355
- },
356
- {
357
- "kind": "Content",
358
- "text": "<TResult>"
359
- },
360
- {
361
- "kind": "Content",
362
- "text": ";"
363
- }
364
- ],
365
- "isReadonly": false,
366
- "isOptional": true,
367
- "releaseTag": "Public",
368
- "name": "processResult",
369
- "propertyTypeTokenRange": {
370
- "startIndex": 1,
371
- "endIndex": 4
372
- }
373
- },
374
- {
375
- "kind": "PropertySignature",
376
- "canonicalReference": "@azure/core-lro!CreateHttpPollerOptions#resolveOnUnsuccessful:member",
377
- "docComment": "/**\n * Control whether to throw an exception if the operation failed or was canceled.\n */\n",
378
- "excerptTokens": [
379
- {
380
- "kind": "Content",
381
- "text": "resolveOnUnsuccessful?: "
382
- },
383
- {
384
- "kind": "Content",
385
- "text": "boolean"
386
- },
387
- {
388
- "kind": "Content",
389
- "text": ";"
390
- }
391
- ],
392
- "isReadonly": false,
393
- "isOptional": true,
394
- "releaseTag": "Public",
395
- "name": "resolveOnUnsuccessful",
396
- "propertyTypeTokenRange": {
397
- "startIndex": 1,
398
- "endIndex": 2
399
- }
400
- },
401
- {
402
- "kind": "PropertySignature",
403
- "canonicalReference": "@azure/core-lro!CreateHttpPollerOptions#resourceLocationConfig:member",
404
- "docComment": "/**\n * The potential location of the result of the LRO if specified by the LRO extension in the swagger.\n */\n",
405
- "excerptTokens": [
406
- {
407
- "kind": "Content",
408
- "text": "resourceLocationConfig?: "
409
- },
410
- {
411
- "kind": "Reference",
412
- "text": "ResourceLocationConfig",
413
- "canonicalReference": "@azure/core-lro!ResourceLocationConfig:type"
414
- },
415
- {
416
- "kind": "Content",
417
- "text": ";"
418
- }
419
- ],
420
- "isReadonly": false,
421
- "isOptional": true,
422
- "releaseTag": "Public",
423
- "name": "resourceLocationConfig",
424
- "propertyTypeTokenRange": {
425
- "startIndex": 1,
426
- "endIndex": 2
427
- }
428
- },
429
- {
430
- "kind": "PropertySignature",
431
- "canonicalReference": "@azure/core-lro!CreateHttpPollerOptions#restoreFrom:member",
432
- "docComment": "/**\n * A serialized poller which can be used to resume an existing paused Long-Running-Operation.\n */\n",
433
- "excerptTokens": [
434
- {
435
- "kind": "Content",
436
- "text": "restoreFrom?: "
437
- },
438
- {
439
- "kind": "Content",
440
- "text": "string"
441
- },
442
- {
443
- "kind": "Content",
444
- "text": ";"
445
- }
446
- ],
447
- "isReadonly": false,
448
- "isOptional": true,
449
- "releaseTag": "Public",
450
- "name": "restoreFrom",
451
- "propertyTypeTokenRange": {
452
- "startIndex": 1,
453
- "endIndex": 2
454
- }
455
- },
456
- {
457
- "kind": "PropertySignature",
458
- "canonicalReference": "@azure/core-lro!CreateHttpPollerOptions#updateState:member",
459
- "docComment": "/**\n * A function to process the state of the LRO.\n */\n",
460
- "excerptTokens": [
461
- {
462
- "kind": "Content",
463
- "text": "updateState?: "
464
- },
465
- {
466
- "kind": "Content",
467
- "text": "(state: TState, response: "
468
- },
469
- {
470
- "kind": "Reference",
471
- "text": "OperationResponse",
472
- "canonicalReference": "@azure/core-lro!OperationResponse:interface"
473
- },
474
- {
475
- "kind": "Content",
476
- "text": ") => void"
477
- },
478
- {
479
- "kind": "Content",
480
- "text": ";"
481
- }
482
- ],
483
- "isReadonly": false,
484
- "isOptional": true,
485
- "releaseTag": "Public",
486
- "name": "updateState",
487
- "propertyTypeTokenRange": {
488
- "startIndex": 1,
489
- "endIndex": 4
490
- }
491
- },
492
- {
493
- "kind": "PropertySignature",
494
- "canonicalReference": "@azure/core-lro!CreateHttpPollerOptions#withOperationLocation:member",
495
- "docComment": "/**\n * A function to be called each time the operation location is updated by the service.\n */\n",
496
- "excerptTokens": [
497
- {
498
- "kind": "Content",
499
- "text": "withOperationLocation?: "
500
- },
501
- {
502
- "kind": "Content",
503
- "text": "(operationLocation: string) => void"
504
- },
505
- {
506
- "kind": "Content",
507
- "text": ";"
508
- }
509
- ],
510
- "isReadonly": false,
511
- "isOptional": true,
512
- "releaseTag": "Public",
513
- "name": "withOperationLocation",
514
- "propertyTypeTokenRange": {
515
- "startIndex": 1,
516
- "endIndex": 2
517
- }
518
- }
519
- ],
520
- "extendsTokenRanges": []
521
- },
522
- {
523
- "kind": "Function",
524
- "canonicalReference": "@azure/core-lro!deserializeState:function(1)",
525
- "docComment": "/**\n * Deserializes the state\n */\n",
526
- "excerptTokens": [
527
- {
528
- "kind": "Content",
529
- "text": "export declare function deserializeState<TState>(serializedState: "
530
- },
531
- {
532
- "kind": "Content",
533
- "text": "string"
534
- },
535
- {
536
- "kind": "Content",
537
- "text": "): "
538
- },
539
- {
540
- "kind": "Reference",
541
- "text": "RestorableOperationState",
542
- "canonicalReference": "@azure/core-lro!RestorableOperationState:type"
543
- },
544
- {
545
- "kind": "Content",
546
- "text": "<TState>"
547
- },
548
- {
549
- "kind": "Content",
550
- "text": ";"
551
- }
552
- ],
553
- "fileUrlPath": "src/poller/operation.ts",
554
- "returnTypeTokenRange": {
555
- "startIndex": 3,
556
- "endIndex": 5
557
- },
558
- "releaseTag": "Public",
559
- "overloadIndex": 1,
560
- "parameters": [
561
- {
562
- "parameterName": "serializedState",
563
- "parameterTypeTokenRange": {
564
- "startIndex": 1,
565
- "endIndex": 2
566
- },
567
- "isOptional": false
568
- }
569
- ],
570
- "typeParameters": [
571
- {
572
- "typeParameterName": "TState",
573
- "constraintTokenRange": {
574
- "startIndex": 0,
575
- "endIndex": 0
576
- },
577
- "defaultTypeTokenRange": {
578
- "startIndex": 0,
579
- "endIndex": 0
580
- }
581
- }
582
- ],
583
- "name": "deserializeState"
584
- },
585
- {
586
- "kind": "Interface",
587
- "canonicalReference": "@azure/core-lro!LongRunningOperation:interface",
588
- "docComment": "/**\n * Description of a long running operation.\n */\n",
589
- "excerptTokens": [
590
- {
591
- "kind": "Content",
592
- "text": "export interface LongRunningOperation<T = "
593
- },
594
- {
595
- "kind": "Content",
596
- "text": "unknown"
597
- },
598
- {
599
- "kind": "Content",
600
- "text": "> "
601
- }
602
- ],
603
- "fileUrlPath": "src/http/models.ts",
604
- "releaseTag": "Public",
605
- "typeParameters": [
606
- {
607
- "typeParameterName": "T",
608
- "constraintTokenRange": {
609
- "startIndex": 0,
610
- "endIndex": 0
611
- },
612
- "defaultTypeTokenRange": {
613
- "startIndex": 1,
614
- "endIndex": 2
615
- }
616
- }
617
- ],
618
- "name": "LongRunningOperation",
619
- "preserveMemberOrder": false,
620
- "members": [
621
- {
622
- "kind": "PropertySignature",
623
- "canonicalReference": "@azure/core-lro!LongRunningOperation#sendInitialRequest:member",
624
- "docComment": "/**\n * A function that can be used to send initial request to the service.\n */\n",
625
- "excerptTokens": [
626
- {
627
- "kind": "Content",
628
- "text": "sendInitialRequest: "
629
- },
630
- {
631
- "kind": "Content",
632
- "text": "() => "
633
- },
634
- {
635
- "kind": "Reference",
636
- "text": "Promise",
637
- "canonicalReference": "!Promise:interface"
638
- },
639
- {
640
- "kind": "Content",
641
- "text": "<"
642
- },
643
- {
644
- "kind": "Reference",
645
- "text": "OperationResponse",
646
- "canonicalReference": "@azure/core-lro!OperationResponse:interface"
647
- },
648
- {
649
- "kind": "Content",
650
- "text": "<unknown>>"
651
- },
652
- {
653
- "kind": "Content",
654
- "text": ";"
655
- }
656
- ],
657
- "isReadonly": false,
658
- "isOptional": false,
659
- "releaseTag": "Public",
660
- "name": "sendInitialRequest",
661
- "propertyTypeTokenRange": {
662
- "startIndex": 1,
663
- "endIndex": 6
664
- }
665
- },
666
- {
667
- "kind": "PropertySignature",
668
- "canonicalReference": "@azure/core-lro!LongRunningOperation#sendPollRequest:member",
669
- "docComment": "/**\n * A function that can be used to poll for the current status of a long running operation.\n */\n",
670
- "excerptTokens": [
671
- {
672
- "kind": "Content",
673
- "text": "sendPollRequest: "
674
- },
675
- {
676
- "kind": "Content",
677
- "text": "(path: string, options?: {\n abortSignal?: "
678
- },
679
- {
680
- "kind": "Reference",
681
- "text": "AbortSignalLike",
682
- "canonicalReference": "@azure/abort-controller!AbortSignalLike:interface"
683
- },
684
- {
685
- "kind": "Content",
686
- "text": ";\n }) => "
687
- },
688
- {
689
- "kind": "Reference",
690
- "text": "Promise",
691
- "canonicalReference": "!Promise:interface"
692
- },
693
- {
694
- "kind": "Content",
695
- "text": "<"
696
- },
697
- {
698
- "kind": "Reference",
699
- "text": "OperationResponse",
700
- "canonicalReference": "@azure/core-lro!OperationResponse:interface"
701
- },
702
- {
703
- "kind": "Content",
704
- "text": "<T>>"
705
- },
706
- {
707
- "kind": "Content",
708
- "text": ";"
709
- }
710
- ],
711
- "isReadonly": false,
712
- "isOptional": false,
713
- "releaseTag": "Public",
714
- "name": "sendPollRequest",
715
- "propertyTypeTokenRange": {
716
- "startIndex": 1,
717
- "endIndex": 8
718
- }
719
- }
720
- ],
721
- "extendsTokenRanges": []
722
- },
723
- {
724
- "kind": "Interface",
725
- "canonicalReference": "@azure/core-lro!OperationConfig:interface",
726
- "docComment": "/**\n * Configurations for how to poll the operation and to check whether it has terminated.\n */\n",
727
- "excerptTokens": [
728
- {
729
- "kind": "Content",
730
- "text": "export interface OperationConfig "
731
- }
732
- ],
733
- "fileUrlPath": "src/poller/models.ts",
734
- "releaseTag": "Public",
735
- "name": "OperationConfig",
736
- "preserveMemberOrder": false,
737
- "members": [
738
- {
739
- "kind": "PropertySignature",
740
- "canonicalReference": "@azure/core-lro!OperationConfig#initialUrl:member",
741
- "docComment": "/**\n * The initial Url\n */\n",
742
- "excerptTokens": [
743
- {
744
- "kind": "Content",
745
- "text": "initialUrl?: "
746
- },
747
- {
748
- "kind": "Content",
749
- "text": "string"
750
- },
751
- {
752
- "kind": "Content",
753
- "text": ";"
754
- }
755
- ],
756
- "isReadonly": false,
757
- "isOptional": true,
758
- "releaseTag": "Public",
759
- "name": "initialUrl",
760
- "propertyTypeTokenRange": {
761
- "startIndex": 1,
762
- "endIndex": 2
763
- }
764
- },
765
- {
766
- "kind": "PropertySignature",
767
- "canonicalReference": "@azure/core-lro!OperationConfig#metadata:member",
768
- "docComment": "/**\n * metadata about the operation\n */\n",
769
- "excerptTokens": [
770
- {
771
- "kind": "Content",
772
- "text": "metadata?: "
773
- },
774
- {
775
- "kind": "Reference",
776
- "text": "Record",
777
- "canonicalReference": "!Record:type"
778
- },
779
- {
780
- "kind": "Content",
781
- "text": "<string, string>"
782
- },
783
- {
784
- "kind": "Content",
785
- "text": ";"
786
- }
787
- ],
788
- "isReadonly": false,
789
- "isOptional": true,
790
- "releaseTag": "Public",
791
- "name": "metadata",
792
- "propertyTypeTokenRange": {
793
- "startIndex": 1,
794
- "endIndex": 3
795
- }
796
- },
797
- {
798
- "kind": "PropertySignature",
799
- "canonicalReference": "@azure/core-lro!OperationConfig#operationLocation:member",
800
- "docComment": "/**\n * The operation location\n */\n",
801
- "excerptTokens": [
802
- {
803
- "kind": "Content",
804
- "text": "operationLocation?: "
805
- },
806
- {
807
- "kind": "Content",
808
- "text": "string"
809
- },
810
- {
811
- "kind": "Content",
812
- "text": ";"
813
- }
814
- ],
815
- "isReadonly": false,
816
- "isOptional": true,
817
- "releaseTag": "Public",
818
- "name": "operationLocation",
819
- "propertyTypeTokenRange": {
820
- "startIndex": 1,
821
- "endIndex": 2
822
- }
823
- },
824
- {
825
- "kind": "PropertySignature",
826
- "canonicalReference": "@azure/core-lro!OperationConfig#requestMethod:member",
827
- "docComment": "/**\n * The request method\n */\n",
828
- "excerptTokens": [
829
- {
830
- "kind": "Content",
831
- "text": "requestMethod?: "
832
- },
833
- {
834
- "kind": "Content",
835
- "text": "string"
836
- },
837
- {
838
- "kind": "Content",
839
- "text": ";"
840
- }
841
- ],
842
- "isReadonly": false,
843
- "isOptional": true,
844
- "releaseTag": "Public",
845
- "name": "requestMethod",
846
- "propertyTypeTokenRange": {
847
- "startIndex": 1,
848
- "endIndex": 2
849
- }
850
- },
851
- {
852
- "kind": "PropertySignature",
853
- "canonicalReference": "@azure/core-lro!OperationConfig#resourceLocation:member",
854
- "docComment": "/**\n * The resource location\n */\n",
855
- "excerptTokens": [
856
- {
857
- "kind": "Content",
858
- "text": "resourceLocation?: "
859
- },
860
- {
861
- "kind": "Content",
862
- "text": "string"
863
- },
864
- {
865
- "kind": "Content",
866
- "text": ";"
867
- }
868
- ],
869
- "isReadonly": false,
870
- "isOptional": true,
871
- "releaseTag": "Public",
872
- "name": "resourceLocation",
873
- "propertyTypeTokenRange": {
874
- "startIndex": 1,
875
- "endIndex": 2
876
- }
877
- }
878
- ],
879
- "extendsTokenRanges": []
880
- },
881
- {
882
- "kind": "Interface",
883
- "canonicalReference": "@azure/core-lro!OperationResponse:interface",
884
- "docComment": "/**\n * The type of the response of a LRO.\n */\n",
885
- "excerptTokens": [
886
- {
887
- "kind": "Content",
888
- "text": "export interface OperationResponse<T = "
889
- },
890
- {
891
- "kind": "Content",
892
- "text": "unknown"
893
- },
894
- {
895
- "kind": "Content",
896
- "text": ", TRequest extends "
897
- },
898
- {
899
- "kind": "Reference",
900
- "text": "RawRequest",
901
- "canonicalReference": "@azure/core-lro!RawRequest:interface"
902
- },
903
- {
904
- "kind": "Content",
905
- "text": " = "
906
- },
907
- {
908
- "kind": "Reference",
909
- "text": "RawRequest",
910
- "canonicalReference": "@azure/core-lro!RawRequest:interface"
911
- },
912
- {
913
- "kind": "Content",
914
- "text": "> "
915
- }
916
- ],
917
- "fileUrlPath": "src/http/models.ts",
918
- "releaseTag": "Public",
919
- "typeParameters": [
920
- {
921
- "typeParameterName": "T",
922
- "constraintTokenRange": {
923
- "startIndex": 0,
924
- "endIndex": 0
925
- },
926
- "defaultTypeTokenRange": {
927
- "startIndex": 1,
928
- "endIndex": 2
929
- }
930
- },
931
- {
932
- "typeParameterName": "TRequest",
933
- "constraintTokenRange": {
934
- "startIndex": 3,
935
- "endIndex": 4
936
- },
937
- "defaultTypeTokenRange": {
938
- "startIndex": 5,
939
- "endIndex": 6
940
- }
941
- }
942
- ],
943
- "name": "OperationResponse",
944
- "preserveMemberOrder": false,
945
- "members": [
946
- {
947
- "kind": "PropertySignature",
948
- "canonicalReference": "@azure/core-lro!OperationResponse#flatResponse:member",
949
- "docComment": "/**\n * The flattened response\n */\n",
950
- "excerptTokens": [
951
- {
952
- "kind": "Content",
953
- "text": "flatResponse: "
954
- },
955
- {
956
- "kind": "Content",
957
- "text": "T"
958
- },
959
- {
960
- "kind": "Content",
961
- "text": ";"
962
- }
963
- ],
964
- "isReadonly": false,
965
- "isOptional": false,
966
- "releaseTag": "Public",
967
- "name": "flatResponse",
968
- "propertyTypeTokenRange": {
969
- "startIndex": 1,
970
- "endIndex": 2
971
- }
972
- },
973
- {
974
- "kind": "PropertySignature",
975
- "canonicalReference": "@azure/core-lro!OperationResponse#rawResponse:member",
976
- "docComment": "/**\n * The raw response\n */\n",
977
- "excerptTokens": [
978
- {
979
- "kind": "Content",
980
- "text": "rawResponse: "
981
- },
982
- {
983
- "kind": "Reference",
984
- "text": "RawResponse",
985
- "canonicalReference": "@azure/core-lro!RawResponse:interface"
986
- },
987
- {
988
- "kind": "Content",
989
- "text": "<TRequest>"
990
- },
991
- {
992
- "kind": "Content",
993
- "text": ";"
994
- }
995
- ],
996
- "isReadonly": false,
997
- "isOptional": false,
998
- "releaseTag": "Public",
999
- "name": "rawResponse",
1000
- "propertyTypeTokenRange": {
1001
- "startIndex": 1,
1002
- "endIndex": 3
1003
- }
1004
- }
1005
- ],
1006
- "extendsTokenRanges": []
1007
- },
1008
- {
1009
- "kind": "Interface",
1010
- "canonicalReference": "@azure/core-lro!OperationState:interface",
1011
- "docComment": "/**\n * While the poller works as the local control mechanism to start triggering and wait for a long-running operation, OperationState documents the status of the remote long-running operation. It gets updated after each poll.\n */\n",
1012
- "excerptTokens": [
1013
- {
1014
- "kind": "Content",
1015
- "text": "export interface OperationState<TResult> "
1016
- }
1017
- ],
1018
- "fileUrlPath": "src/poller/models.ts",
1019
- "releaseTag": "Public",
1020
- "typeParameters": [
1021
- {
1022
- "typeParameterName": "TResult",
1023
- "constraintTokenRange": {
1024
- "startIndex": 0,
1025
- "endIndex": 0
1026
- },
1027
- "defaultTypeTokenRange": {
1028
- "startIndex": 0,
1029
- "endIndex": 0
1030
- }
1031
- }
1032
- ],
1033
- "name": "OperationState",
1034
- "preserveMemberOrder": false,
1035
- "members": [
1036
- {
1037
- "kind": "PropertySignature",
1038
- "canonicalReference": "@azure/core-lro!OperationState#error:member",
1039
- "docComment": "/**\n * Will exist if the operation encountered any error.\n */\n",
1040
- "excerptTokens": [
1041
- {
1042
- "kind": "Content",
1043
- "text": "error?: "
1044
- },
1045
- {
1046
- "kind": "Reference",
1047
- "text": "Error",
1048
- "canonicalReference": "!Error:interface"
1049
- },
1050
- {
1051
- "kind": "Content",
1052
- "text": ";"
1053
- }
1054
- ],
1055
- "isReadonly": false,
1056
- "isOptional": true,
1057
- "releaseTag": "Public",
1058
- "name": "error",
1059
- "propertyTypeTokenRange": {
1060
- "startIndex": 1,
1061
- "endIndex": 2
1062
- }
1063
- },
1064
- {
1065
- "kind": "PropertySignature",
1066
- "canonicalReference": "@azure/core-lro!OperationState#result:member",
1067
- "docComment": "/**\n * Will exist if the operation produced a result of the expected type.\n */\n",
1068
- "excerptTokens": [
1069
- {
1070
- "kind": "Content",
1071
- "text": "result?: "
1072
- },
1073
- {
1074
- "kind": "Content",
1075
- "text": "TResult"
1076
- },
1077
- {
1078
- "kind": "Content",
1079
- "text": ";"
1080
- }
1081
- ],
1082
- "isReadonly": false,
1083
- "isOptional": true,
1084
- "releaseTag": "Public",
1085
- "name": "result",
1086
- "propertyTypeTokenRange": {
1087
- "startIndex": 1,
1088
- "endIndex": 2
1089
- }
1090
- },
1091
- {
1092
- "kind": "PropertySignature",
1093
- "canonicalReference": "@azure/core-lro!OperationState#status:member",
1094
- "docComment": "/**\n * The current status of the operation.\n */\n",
1095
- "excerptTokens": [
1096
- {
1097
- "kind": "Content",
1098
- "text": "status: "
1099
- },
1100
- {
1101
- "kind": "Reference",
1102
- "text": "OperationStatus",
1103
- "canonicalReference": "@azure/core-lro!OperationStatus:type"
1104
- },
1105
- {
1106
- "kind": "Content",
1107
- "text": ";"
1108
- }
1109
- ],
1110
- "isReadonly": false,
1111
- "isOptional": false,
1112
- "releaseTag": "Public",
1113
- "name": "status",
1114
- "propertyTypeTokenRange": {
1115
- "startIndex": 1,
1116
- "endIndex": 2
1117
- }
1118
- }
1119
- ],
1120
- "extendsTokenRanges": []
1121
- },
1122
- {
1123
- "kind": "TypeAlias",
1124
- "canonicalReference": "@azure/core-lro!OperationStatus:type",
1125
- "docComment": "/**\n * The set of possible states an operation can be in at any given time.\n */\n",
1126
- "excerptTokens": [
1127
- {
1128
- "kind": "Content",
1129
- "text": "export type OperationStatus = "
1130
- },
1131
- {
1132
- "kind": "Content",
1133
- "text": "\"notStarted\" | \"running\" | \"succeeded\" | \"canceled\" | \"failed\""
1134
- },
1135
- {
1136
- "kind": "Content",
1137
- "text": ";"
1138
- }
1139
- ],
1140
- "fileUrlPath": "src/poller/models.ts",
1141
- "releaseTag": "Public",
1142
- "name": "OperationStatus",
1143
- "typeTokenRange": {
1144
- "startIndex": 1,
1145
- "endIndex": 2
1146
- }
1147
- },
1148
- {
1149
- "kind": "Interface",
1150
- "canonicalReference": "@azure/core-lro!PollerLike:interface",
1151
- "docComment": "/**\n * A simple poller interface.\n */\n",
1152
- "excerptTokens": [
1153
- {
1154
- "kind": "Content",
1155
- "text": "export interface PollerLike<TState extends "
1156
- },
1157
- {
1158
- "kind": "Reference",
1159
- "text": "OperationState",
1160
- "canonicalReference": "@azure/core-lro!OperationState:interface"
1161
- },
1162
- {
1163
- "kind": "Content",
1164
- "text": "<TResult>"
1165
- },
1166
- {
1167
- "kind": "Content",
1168
- "text": ", TResult> extends "
1169
- },
1170
- {
1171
- "kind": "Reference",
1172
- "text": "Promise",
1173
- "canonicalReference": "!Promise:interface"
1174
- },
1175
- {
1176
- "kind": "Content",
1177
- "text": "<TResult>"
1178
- },
1179
- {
1180
- "kind": "Content",
1181
- "text": " "
1182
- }
1183
- ],
1184
- "fileUrlPath": "src/poller/models.ts",
1185
- "releaseTag": "Public",
1186
- "typeParameters": [
1187
- {
1188
- "typeParameterName": "TState",
1189
- "constraintTokenRange": {
1190
- "startIndex": 1,
1191
- "endIndex": 3
1192
- },
1193
- "defaultTypeTokenRange": {
1194
- "startIndex": 0,
1195
- "endIndex": 0
1196
- }
1197
- },
1198
- {
1199
- "typeParameterName": "TResult",
1200
- "constraintTokenRange": {
1201
- "startIndex": 0,
1202
- "endIndex": 0
1203
- },
1204
- "defaultTypeTokenRange": {
1205
- "startIndex": 0,
1206
- "endIndex": 0
1207
- }
1208
- }
1209
- ],
1210
- "name": "PollerLike",
1211
- "preserveMemberOrder": false,
1212
- "members": [
1213
- {
1214
- "kind": "PropertySignature",
1215
- "canonicalReference": "@azure/core-lro!PollerLike#isDone:member",
1216
- "docComment": "/**\n * Returns true if the poller has finished polling.\n */\n",
1217
- "excerptTokens": [
1218
- {
1219
- "kind": "Content",
1220
- "text": "readonly isDone: "
1221
- },
1222
- {
1223
- "kind": "Content",
1224
- "text": "boolean"
1225
- },
1226
- {
1227
- "kind": "Content",
1228
- "text": ";"
1229
- }
1230
- ],
1231
- "isReadonly": true,
1232
- "isOptional": false,
1233
- "releaseTag": "Public",
1234
- "name": "isDone",
1235
- "propertyTypeTokenRange": {
1236
- "startIndex": 1,
1237
- "endIndex": 2
1238
- }
1239
- },
1240
- {
1241
- "kind": "PropertySignature",
1242
- "canonicalReference": "@azure/core-lro!PollerLike#isStopped:member",
1243
- "docComment": "/**\n * Returns true if the poller is stopped.\n */\n",
1244
- "excerptTokens": [
1245
- {
1246
- "kind": "Content",
1247
- "text": "readonly isStopped: "
1248
- },
1249
- {
1250
- "kind": "Content",
1251
- "text": "boolean"
1252
- },
1253
- {
1254
- "kind": "Content",
1255
- "text": ";"
1256
- }
1257
- ],
1258
- "isReadonly": true,
1259
- "isOptional": false,
1260
- "releaseTag": "Public",
1261
- "name": "isStopped",
1262
- "propertyTypeTokenRange": {
1263
- "startIndex": 1,
1264
- "endIndex": 2
1265
- }
1266
- },
1267
- {
1268
- "kind": "MethodSignature",
1269
- "canonicalReference": "@azure/core-lro!PollerLike#onProgress:member(1)",
1270
- "docComment": "/**\n * Invokes the provided callback after each polling is completed, sending the current state of the poller's operation.\n *\n * It returns a method that can be used to stop receiving updates on the given callback function.\n */\n",
1271
- "excerptTokens": [
1272
- {
1273
- "kind": "Content",
1274
- "text": "onProgress(callback: "
1275
- },
1276
- {
1277
- "kind": "Content",
1278
- "text": "(state: TState) => void"
1279
- },
1280
- {
1281
- "kind": "Content",
1282
- "text": "): "
1283
- },
1284
- {
1285
- "kind": "Reference",
1286
- "text": "CancelOnProgress",
1287
- "canonicalReference": "@azure/core-lro!CancelOnProgress:type"
1288
- },
1289
- {
1290
- "kind": "Content",
1291
- "text": ";"
1292
- }
1293
- ],
1294
- "isOptional": false,
1295
- "returnTypeTokenRange": {
1296
- "startIndex": 3,
1297
- "endIndex": 4
1298
- },
1299
- "releaseTag": "Public",
1300
- "overloadIndex": 1,
1301
- "parameters": [
1302
- {
1303
- "parameterName": "callback",
1304
- "parameterTypeTokenRange": {
1305
- "startIndex": 1,
1306
- "endIndex": 2
1307
- },
1308
- "isOptional": false
1309
- }
1310
- ],
1311
- "name": "onProgress"
1312
- },
1313
- {
1314
- "kind": "PropertySignature",
1315
- "canonicalReference": "@azure/core-lro!PollerLike#operationState:member",
1316
- "docComment": "/**\n * Returns the state of the operation.\n */\n",
1317
- "excerptTokens": [
1318
- {
1319
- "kind": "Content",
1320
- "text": "readonly operationState: "
1321
- },
1322
- {
1323
- "kind": "Content",
1324
- "text": "TState | undefined"
1325
- },
1326
- {
1327
- "kind": "Content",
1328
- "text": ";"
1329
- }
1330
- ],
1331
- "isReadonly": true,
1332
- "isOptional": false,
1333
- "releaseTag": "Public",
1334
- "name": "operationState",
1335
- "propertyTypeTokenRange": {
1336
- "startIndex": 1,
1337
- "endIndex": 2
1338
- }
1339
- },
1340
- {
1341
- "kind": "MethodSignature",
1342
- "canonicalReference": "@azure/core-lro!PollerLike#poll:member(1)",
1343
- "docComment": "/**\n * 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.\n */\n",
1344
- "excerptTokens": [
1345
- {
1346
- "kind": "Content",
1347
- "text": "poll(options?: "
1348
- },
1349
- {
1350
- "kind": "Content",
1351
- "text": "{\n abortSignal?: "
1352
- },
1353
- {
1354
- "kind": "Reference",
1355
- "text": "AbortSignalLike",
1356
- "canonicalReference": "@azure/abort-controller!AbortSignalLike:interface"
1357
- },
1358
- {
1359
- "kind": "Content",
1360
- "text": ";\n }"
1361
- },
1362
- {
1363
- "kind": "Content",
1364
- "text": "): "
1365
- },
1366
- {
1367
- "kind": "Reference",
1368
- "text": "Promise",
1369
- "canonicalReference": "!Promise:interface"
1370
- },
1371
- {
1372
- "kind": "Content",
1373
- "text": "<TState>"
1374
- },
1375
- {
1376
- "kind": "Content",
1377
- "text": ";"
1378
- }
1379
- ],
1380
- "isOptional": false,
1381
- "returnTypeTokenRange": {
1382
- "startIndex": 5,
1383
- "endIndex": 7
1384
- },
1385
- "releaseTag": "Public",
1386
- "overloadIndex": 1,
1387
- "parameters": [
1388
- {
1389
- "parameterName": "options",
1390
- "parameterTypeTokenRange": {
1391
- "startIndex": 1,
1392
- "endIndex": 4
1393
- },
1394
- "isOptional": true
1395
- }
1396
- ],
1397
- "name": "poll"
1398
- },
1399
- {
1400
- "kind": "MethodSignature",
1401
- "canonicalReference": "@azure/core-lro!PollerLike#pollUntilDone:member(1)",
1402
- "docComment": "/**\n * Returns a promise that will resolve once the underlying operation is completed.\n */\n",
1403
- "excerptTokens": [
1404
- {
1405
- "kind": "Content",
1406
- "text": "pollUntilDone(pollOptions?: "
1407
- },
1408
- {
1409
- "kind": "Content",
1410
- "text": "{\n abortSignal?: "
1411
- },
1412
- {
1413
- "kind": "Reference",
1414
- "text": "AbortSignalLike",
1415
- "canonicalReference": "@azure/abort-controller!AbortSignalLike:interface"
1416
- },
1417
- {
1418
- "kind": "Content",
1419
- "text": ";\n }"
1420
- },
1421
- {
1422
- "kind": "Content",
1423
- "text": "): "
1424
- },
1425
- {
1426
- "kind": "Reference",
1427
- "text": "Promise",
1428
- "canonicalReference": "!Promise:interface"
1429
- },
1430
- {
1431
- "kind": "Content",
1432
- "text": "<TResult>"
1433
- },
1434
- {
1435
- "kind": "Content",
1436
- "text": ";"
1437
- }
1438
- ],
1439
- "isOptional": false,
1440
- "returnTypeTokenRange": {
1441
- "startIndex": 5,
1442
- "endIndex": 7
1443
- },
1444
- "releaseTag": "Public",
1445
- "overloadIndex": 1,
1446
- "parameters": [
1447
- {
1448
- "parameterName": "pollOptions",
1449
- "parameterTypeTokenRange": {
1450
- "startIndex": 1,
1451
- "endIndex": 4
1452
- },
1453
- "isOptional": true
1454
- }
1455
- ],
1456
- "name": "pollUntilDone"
1457
- },
1458
- {
1459
- "kind": "PropertySignature",
1460
- "canonicalReference": "@azure/core-lro!PollerLike#result:member",
1461
- "docComment": "/**\n * 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.\n */\n",
1462
- "excerptTokens": [
1463
- {
1464
- "kind": "Content",
1465
- "text": "readonly result: "
1466
- },
1467
- {
1468
- "kind": "Content",
1469
- "text": "TResult | undefined"
1470
- },
1471
- {
1472
- "kind": "Content",
1473
- "text": ";"
1474
- }
1475
- ],
1476
- "isReadonly": true,
1477
- "isOptional": false,
1478
- "releaseTag": "Public",
1479
- "name": "result",
1480
- "propertyTypeTokenRange": {
1481
- "startIndex": 1,
1482
- "endIndex": 2
1483
- }
1484
- },
1485
- {
1486
- "kind": "MethodSignature",
1487
- "canonicalReference": "@azure/core-lro!PollerLike#serialize:member(1)",
1488
- "docComment": "/**\n * Returns a promise that could be used for serialized version of the poller's operation by invoking the operation's serialize method.\n */\n",
1489
- "excerptTokens": [
1490
- {
1491
- "kind": "Content",
1492
- "text": "serialize(): "
1493
- },
1494
- {
1495
- "kind": "Reference",
1496
- "text": "Promise",
1497
- "canonicalReference": "!Promise:interface"
1498
- },
1499
- {
1500
- "kind": "Content",
1501
- "text": "<string>"
1502
- },
1503
- {
1504
- "kind": "Content",
1505
- "text": ";"
1506
- }
1507
- ],
1508
- "isOptional": false,
1509
- "returnTypeTokenRange": {
1510
- "startIndex": 1,
1511
- "endIndex": 3
1512
- },
1513
- "releaseTag": "Public",
1514
- "overloadIndex": 1,
1515
- "parameters": [],
1516
- "name": "serialize"
1517
- },
1518
- {
1519
- "kind": "MethodSignature",
1520
- "canonicalReference": "@azure/core-lro!PollerLike#submitted:member(1)",
1521
- "docComment": "/**\n * Returns a promise that could be used to check if the poller has been submitted.\n */\n",
1522
- "excerptTokens": [
1523
- {
1524
- "kind": "Content",
1525
- "text": "submitted(): "
1526
- },
1527
- {
1528
- "kind": "Reference",
1529
- "text": "Promise",
1530
- "canonicalReference": "!Promise:interface"
1531
- },
1532
- {
1533
- "kind": "Content",
1534
- "text": "<void>"
1535
- },
1536
- {
1537
- "kind": "Content",
1538
- "text": ";"
1539
- }
1540
- ],
1541
- "isOptional": false,
1542
- "returnTypeTokenRange": {
1543
- "startIndex": 1,
1544
- "endIndex": 3
1545
- },
1546
- "releaseTag": "Public",
1547
- "overloadIndex": 1,
1548
- "parameters": [],
1549
- "name": "submitted"
1550
- }
1551
- ],
1552
- "extendsTokenRanges": [
1553
- {
1554
- "startIndex": 4,
1555
- "endIndex": 6
1556
- }
1557
- ]
1558
- },
1559
- {
1560
- "kind": "Interface",
1561
- "canonicalReference": "@azure/core-lro!RawRequest:interface",
1562
- "docComment": "/**\n * Simple type of the raw request.\n */\n",
1563
- "excerptTokens": [
1564
- {
1565
- "kind": "Content",
1566
- "text": "export interface RawRequest "
1567
- }
1568
- ],
1569
- "fileUrlPath": "src/http/models.ts",
1570
- "releaseTag": "Public",
1571
- "name": "RawRequest",
1572
- "preserveMemberOrder": false,
1573
- "members": [
1574
- {
1575
- "kind": "PropertySignature",
1576
- "canonicalReference": "@azure/core-lro!RawRequest#body:member",
1577
- "docComment": "/**\n * The request body\n */\n",
1578
- "excerptTokens": [
1579
- {
1580
- "kind": "Content",
1581
- "text": "body?: "
1582
- },
1583
- {
1584
- "kind": "Content",
1585
- "text": "unknown"
1586
- },
1587
- {
1588
- "kind": "Content",
1589
- "text": ";"
1590
- }
1591
- ],
1592
- "isReadonly": false,
1593
- "isOptional": true,
1594
- "releaseTag": "Public",
1595
- "name": "body",
1596
- "propertyTypeTokenRange": {
1597
- "startIndex": 1,
1598
- "endIndex": 2
1599
- }
1600
- },
1601
- {
1602
- "kind": "PropertySignature",
1603
- "canonicalReference": "@azure/core-lro!RawRequest#method:member",
1604
- "docComment": "/**\n * The HTTP request method\n */\n",
1605
- "excerptTokens": [
1606
- {
1607
- "kind": "Content",
1608
- "text": "method: "
1609
- },
1610
- {
1611
- "kind": "Content",
1612
- "text": "string"
1613
- },
1614
- {
1615
- "kind": "Content",
1616
- "text": ";"
1617
- }
1618
- ],
1619
- "isReadonly": false,
1620
- "isOptional": false,
1621
- "releaseTag": "Public",
1622
- "name": "method",
1623
- "propertyTypeTokenRange": {
1624
- "startIndex": 1,
1625
- "endIndex": 2
1626
- }
1627
- },
1628
- {
1629
- "kind": "PropertySignature",
1630
- "canonicalReference": "@azure/core-lro!RawRequest#url:member",
1631
- "docComment": "/**\n * The request path\n */\n",
1632
- "excerptTokens": [
1633
- {
1634
- "kind": "Content",
1635
- "text": "url: "
1636
- },
1637
- {
1638
- "kind": "Content",
1639
- "text": "string"
1640
- },
1641
- {
1642
- "kind": "Content",
1643
- "text": ";"
1644
- }
1645
- ],
1646
- "isReadonly": false,
1647
- "isOptional": false,
1648
- "releaseTag": "Public",
1649
- "name": "url",
1650
- "propertyTypeTokenRange": {
1651
- "startIndex": 1,
1652
- "endIndex": 2
1653
- }
1654
- }
1655
- ],
1656
- "extendsTokenRanges": []
1657
- },
1658
- {
1659
- "kind": "Interface",
1660
- "canonicalReference": "@azure/core-lro!RawResponse:interface",
1661
- "docComment": "/**\n * Simple type of the raw response.\n */\n",
1662
- "excerptTokens": [
1663
- {
1664
- "kind": "Content",
1665
- "text": "export interface RawResponse<TRequest extends "
1666
- },
1667
- {
1668
- "kind": "Reference",
1669
- "text": "RawRequest",
1670
- "canonicalReference": "@azure/core-lro!RawRequest:interface"
1671
- },
1672
- {
1673
- "kind": "Content",
1674
- "text": " = "
1675
- },
1676
- {
1677
- "kind": "Reference",
1678
- "text": "RawRequest",
1679
- "canonicalReference": "@azure/core-lro!RawRequest:interface"
1680
- },
1681
- {
1682
- "kind": "Content",
1683
- "text": "> "
1684
- }
1685
- ],
1686
- "fileUrlPath": "src/http/models.ts",
1687
- "releaseTag": "Public",
1688
- "typeParameters": [
1689
- {
1690
- "typeParameterName": "TRequest",
1691
- "constraintTokenRange": {
1692
- "startIndex": 1,
1693
- "endIndex": 2
1694
- },
1695
- "defaultTypeTokenRange": {
1696
- "startIndex": 3,
1697
- "endIndex": 4
1698
- }
1699
- }
1700
- ],
1701
- "name": "RawResponse",
1702
- "preserveMemberOrder": false,
1703
- "members": [
1704
- {
1705
- "kind": "PropertySignature",
1706
- "canonicalReference": "@azure/core-lro!RawResponse#body:member",
1707
- "docComment": "/**\n * The parsed response body\n */\n",
1708
- "excerptTokens": [
1709
- {
1710
- "kind": "Content",
1711
- "text": "body?: "
1712
- },
1713
- {
1714
- "kind": "Content",
1715
- "text": "unknown"
1716
- },
1717
- {
1718
- "kind": "Content",
1719
- "text": ";"
1720
- }
1721
- ],
1722
- "isReadonly": false,
1723
- "isOptional": true,
1724
- "releaseTag": "Public",
1725
- "name": "body",
1726
- "propertyTypeTokenRange": {
1727
- "startIndex": 1,
1728
- "endIndex": 2
1729
- }
1730
- },
1731
- {
1732
- "kind": "PropertySignature",
1733
- "canonicalReference": "@azure/core-lro!RawResponse#headers:member",
1734
- "docComment": "/**\n * A HttpHeaders collection in the response represented as a simple JSON object where all header names have been normalized to be lower-case.\n */\n",
1735
- "excerptTokens": [
1736
- {
1737
- "kind": "Content",
1738
- "text": "headers: "
1739
- },
1740
- {
1741
- "kind": "Content",
1742
- "text": "{\n [headerName: string]: string;\n }"
1743
- },
1744
- {
1745
- "kind": "Content",
1746
- "text": ";"
1747
- }
1748
- ],
1749
- "isReadonly": false,
1750
- "isOptional": false,
1751
- "releaseTag": "Public",
1752
- "name": "headers",
1753
- "propertyTypeTokenRange": {
1754
- "startIndex": 1,
1755
- "endIndex": 2
1756
- }
1757
- },
1758
- {
1759
- "kind": "PropertySignature",
1760
- "canonicalReference": "@azure/core-lro!RawResponse#request:member",
1761
- "docComment": "/**\n * The raw request that was sent to the server\n */\n",
1762
- "excerptTokens": [
1763
- {
1764
- "kind": "Content",
1765
- "text": "request: "
1766
- },
1767
- {
1768
- "kind": "Content",
1769
- "text": "TRequest"
1770
- },
1771
- {
1772
- "kind": "Content",
1773
- "text": ";"
1774
- }
1775
- ],
1776
- "isReadonly": false,
1777
- "isOptional": false,
1778
- "releaseTag": "Public",
1779
- "name": "request",
1780
- "propertyTypeTokenRange": {
1781
- "startIndex": 1,
1782
- "endIndex": 2
1783
- }
1784
- },
1785
- {
1786
- "kind": "PropertySignature",
1787
- "canonicalReference": "@azure/core-lro!RawResponse#statusCode:member",
1788
- "docComment": "/**\n * The HTTP status code\n */\n",
1789
- "excerptTokens": [
1790
- {
1791
- "kind": "Content",
1792
- "text": "statusCode: "
1793
- },
1794
- {
1795
- "kind": "Content",
1796
- "text": "number"
1797
- },
1798
- {
1799
- "kind": "Content",
1800
- "text": ";"
1801
- }
1802
- ],
1803
- "isReadonly": false,
1804
- "isOptional": false,
1805
- "releaseTag": "Public",
1806
- "name": "statusCode",
1807
- "propertyTypeTokenRange": {
1808
- "startIndex": 1,
1809
- "endIndex": 2
1810
- }
1811
- }
1812
- ],
1813
- "extendsTokenRanges": []
1814
- },
1815
- {
1816
- "kind": "TypeAlias",
1817
- "canonicalReference": "@azure/core-lro!ResourceLocationConfig:type",
1818
- "docComment": "/**\n * The potential location of the result of the LRO if specified by the LRO extension in the swagger.\n */\n",
1819
- "excerptTokens": [
1820
- {
1821
- "kind": "Content",
1822
- "text": "export type ResourceLocationConfig = "
1823
- },
1824
- {
1825
- "kind": "Content",
1826
- "text": "\"azure-async-operation\" | \"location\" | \"original-uri\""
1827
- },
1828
- {
1829
- "kind": "Content",
1830
- "text": ";"
1831
- }
1832
- ],
1833
- "fileUrlPath": "src/http/models.ts",
1834
- "releaseTag": "Public",
1835
- "name": "ResourceLocationConfig",
1836
- "typeTokenRange": {
1837
- "startIndex": 1,
1838
- "endIndex": 2
1839
- }
1840
- },
1841
- {
1842
- "kind": "TypeAlias",
1843
- "canonicalReference": "@azure/core-lro!RestorableOperationState:type",
1844
- "docComment": "/**\n * Type of a restorable long-running operation.\n */\n",
1845
- "excerptTokens": [
1846
- {
1847
- "kind": "Content",
1848
- "text": "export type RestorableOperationState<T> = "
1849
- },
1850
- {
1851
- "kind": "Content",
1852
- "text": "T & {\n config: "
1853
- },
1854
- {
1855
- "kind": "Reference",
1856
- "text": "OperationConfig",
1857
- "canonicalReference": "@azure/core-lro!OperationConfig:interface"
1858
- },
1859
- {
1860
- "kind": "Content",
1861
- "text": ";\n}"
1862
- },
1863
- {
1864
- "kind": "Content",
1865
- "text": ";"
1866
- }
1867
- ],
1868
- "fileUrlPath": "src/poller/models.ts",
1869
- "releaseTag": "Public",
1870
- "name": "RestorableOperationState",
1871
- "typeParameters": [
1872
- {
1873
- "typeParameterName": "T",
1874
- "constraintTokenRange": {
1875
- "startIndex": 0,
1876
- "endIndex": 0
1877
- },
1878
- "defaultTypeTokenRange": {
1879
- "startIndex": 0,
1880
- "endIndex": 0
1881
- }
1882
- }
1883
- ],
1884
- "typeTokenRange": {
1885
- "startIndex": 1,
1886
- "endIndex": 4
1887
- }
1888
- }
1889
- ]
1890
- }
1891
- ]
1892
- }