forked from Azure/azure-sdk-for-js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[core-lro] ensures types are included in package (Azure#5724)
- Loading branch information
1 parent
5297357
commit 84fd6d5
Showing
2 changed files
with
128 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
## API Report File for "@azure/core-lro" | ||
|
||
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). | ||
```ts | ||
|
||
import { AbortSignalLike } from '@azure/abort-controller'; | ||
|
||
// @public (undocumented) | ||
export type CancelOnProgress = () => void; | ||
|
||
// @public (undocumented) | ||
export abstract class Poller<TState, TResult> implements PollerLike<TState, TResult> { | ||
constructor(operation: PollOperation<TState, TResult>); | ||
// (undocumented) | ||
cancelOperation(options?: { | ||
abortSignal?: AbortSignal; | ||
}): Promise<void>; | ||
// (undocumented) | ||
protected abstract delay(): Promise<void>; | ||
// (undocumented) | ||
getOperationState(): PollOperationState<TResult>; | ||
// (undocumented) | ||
getResult(): TResult | undefined; | ||
// (undocumented) | ||
isDone(): boolean; | ||
// (undocumented) | ||
isStopped(): boolean; | ||
// (undocumented) | ||
onProgress(callback: (state: TState) => void): CancelOnProgress; | ||
// (undocumented) | ||
protected operation: PollOperation<TState, TResult>; | ||
// (undocumented) | ||
poll(options?: { | ||
abortSignal?: AbortSignal; | ||
}): Promise<void>; | ||
// (undocumented) | ||
pollUntilDone(): Promise<TResult>; | ||
// (undocumented) | ||
stopPolling(): void; | ||
// (undocumented) | ||
toString(): string; | ||
} | ||
|
||
// @public (undocumented) | ||
export class PollerCancelledError extends Error { | ||
constructor(message: string); | ||
} | ||
|
||
// @public (undocumented) | ||
export interface PollerLike<TState, TResult> { | ||
// (undocumented) | ||
cancelOperation(options?: { | ||
abortSignal?: AbortSignal; | ||
}): Promise<void>; | ||
// (undocumented) | ||
getOperationState(): PollOperationState<TResult>; | ||
// (undocumented) | ||
getResult(): TResult | undefined; | ||
// (undocumented) | ||
isDone(): boolean; | ||
// (undocumented) | ||
isStopped(): boolean; | ||
// (undocumented) | ||
onProgress(callback: (state: TState) => void): CancelOnProgress; | ||
// (undocumented) | ||
poll(options?: { | ||
abortSignal?: AbortSignal; | ||
}): Promise<void>; | ||
// (undocumented) | ||
pollUntilDone(): Promise<TResult>; | ||
// (undocumented) | ||
stopPolling(): void; | ||
// (undocumented) | ||
toString(): string; | ||
} | ||
|
||
// @public (undocumented) | ||
export class PollerStoppedError extends Error { | ||
constructor(message: string); | ||
} | ||
|
||
// @public (undocumented) | ||
export type PollOperation<TState, TResult> = PollOperationBase<TState, TResult> & { | ||
[prop: string]: any; | ||
}; | ||
|
||
// @public (undocumented) | ||
export interface PollOperationBase<TState, TResult> { | ||
// (undocumented) | ||
cancel(options?: { | ||
abortSignal?: AbortSignal; | ||
}): Promise<PollOperation<TState, TResult>>; | ||
// (undocumented) | ||
state: TState; | ||
// (undocumented) | ||
toString(): string; | ||
// (undocumented) | ||
update(options?: { | ||
abortSignal?: AbortSignalLike; | ||
fireProgress?: (state: TState) => void; | ||
}): Promise<PollOperation<TState, TResult>>; | ||
} | ||
|
||
// @public (undocumented) | ||
export interface PollOperationState<TResult> { | ||
// (undocumented) | ||
error?: Error; | ||
// (undocumented) | ||
isCancelled?: boolean; | ||
// (undocumented) | ||
isCompleted?: boolean; | ||
// (undocumented) | ||
isStarted?: boolean; | ||
// (undocumented) | ||
result?: TResult; | ||
} | ||
|
||
// @public (undocumented) | ||
export type PollProgressCallback<TState> = (state: TState) => void; | ||
|
||
|
||
// (No @packageDocumentation comment for this package) | ||
|
||
``` |