PollerLike interface

패키지:

@azure/keyvault-keys

사용자가 작업해야 하는 최소 API만 노출하기 위한 폴러의 추상 표현입니다.

메서드

cancelOperation({ abortSignal?: AbortSignalLike })	기본 작업을 취소하려고 시도합니다.
getOperationState()	작업의 상태를 반환합니다. PollerLike에 정의된 TState는 Poller 구현에 정의된 TState의 하위 집합일 수 있습니다.
getResult()	폴러의 상태에 관계없이 연산의 결과 값을 반환합니다. 구현에 따라 정의되지 않았거나 최종 TResult 값의 불완전한 형식을 반환할 수 있습니다.
isDone()	폴러가 폴링을 완료하면 true를 반환합니다.
isStopped()	폴러가 중지되면 true를 반환합니다.
onProgress((state: TState) => void)	각 폴링이 완료된 후 제공된 콜백을 호출하여 폴러 작업의 현재 상태를 보냅니다. 지정된 콜백 함수에 대한 업데이트 수신을 중지하는 데 사용할 수 있는 메서드를 반환합니다.
poll({ abortSignal?: AbortSignalLike })	단일 폴링 요청이 완료되면 해결되는 프라미스를 반환합니다. 이 작업은 Poller 작업의 업데이트 메서드를 호출하여 수행합니다.
pollUntilDone({ abortSignal?: AbortSignalLike })	기본 작업이 완료되면 해결되는 프라미스를 반환합니다.
stopPolling()	폴러를 중지합니다. 이 후에는 수동 또는 자동화된 요청을 보낼 수 없습니다.
toString()	작업의 toString 메서드를 호출하여 폴러 작업의 직렬화된 버전을 반환합니다.

메서드 세부 정보

cancelOperation({ abortSignal?: AbortSignalLike })

경고

이 API는 이제 사용되지 않습니다.

cancelOperation has been deprecated because it was not implemented.

기본 작업을 취소하려고 시도합니다.

function cancelOperation(options?: { abortSignal?: AbortSignalLike }): Promise<void>

매개 변수

options

{ abortSignal?: AbortSignalLike }

반환

Promise<void>

getOperationState()

작업의 상태를 반환합니다. PollerLike에 정의된 TState는 Poller 구현에 정의된 TState의 하위 집합일 수 있습니다.

function getOperationState(): TState

반환

TState

getResult()

폴러의 상태에 관계없이 연산의 결과 값을 반환합니다. 구현에 따라 정의되지 않았거나 최종 TResult 값의 불완전한 형식을 반환할 수 있습니다.

function getResult(): undefined | TResult

반환

undefined | TResult

isDone()

폴러가 폴링을 완료하면 true를 반환합니다.

function isDone(): boolean

반환

boolean

isStopped()

폴러가 중지되면 true를 반환합니다.

function isStopped(): boolean

반환

boolean

onProgress((state: TState) => void)

각 폴링이 완료된 후 제공된 콜백을 호출하여 폴러 작업의 현재 상태를 보냅니다.

지정된 콜백 함수에 대한 업데이트 수신을 중지하는 데 사용할 수 있는 메서드를 반환합니다.

function onProgress(callback: (state: TState) => void): CancelOnProgress

매개 변수

callback

(state: TState) => void

반환

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

단일 폴링 요청이 완료되면 해결되는 프라미스를 반환합니다. 이 작업은 Poller 작업의 업데이트 메서드를 호출하여 수행합니다.

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<void>

매개 변수

options

{ abortSignal?: AbortSignalLike }

반환

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

기본 작업이 완료되면 해결되는 프라미스를 반환합니다.

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>

매개 변수

pollOptions

{ abortSignal?: AbortSignalLike }

반환

Promise<TResult>

stopPolling()

폴러를 중지합니다. 이 후에는 수동 또는 자동화된 요청을 보낼 수 없습니다.

function stopPolling()

toString()

작업의 toString 메서드를 호출하여 폴러 작업의 직렬화된 버전을 반환합니다.

function toString(): string

반환

string