@azure/core-util package
인터페이스
| AbortOptions |
중단 컨트롤러와 관련된 옵션입니다. |
| CreateAbortablePromiseOptions |
createAbortablePromise 함수에 대한 옵션입니다. |
| DelayOptions |
지연 메서드에 대한 지원 중단 기능에 대한 옵션 |
형식 별칭
| AbortablePromiseBuilder |
중단될 수 있는 프라미스를 반환하는 함수를 나타냅니다. |
| EncodingType |
지원되는 문자 인코딩 형식 |
| HttpMethods |
요청할 때 사용할 지원되는 HTTP 메서드입니다. |
| UnknownObject |
일반 JS 개체의 제네릭 셰이프입니다. |
함수
함수 세부 정보
calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })
지터와 함께 지수 지연을 사용하여 재시도 시도의 지연 간격을 계산합니다.
function calculateRetryDelay(retryAttempt: number, config: { maxRetryDelayInMs: number, retryDelayInMs: number }): { retryAfterInMs: number }매개 변수
- retryAttempt
-
number
현재 다시 시도 횟수입니다.
- config
-
{ maxRetryDelayInMs: number, retryDelayInMs: number }
지수 재시도 구성입니다.
반환
{ retryAfterInMs: number }
계산된 재시도 지연이 포함된 개체입니다.
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })
promise.race() 래퍼는 첫 번째 약속이 해결되는 즉시 나머지 약속을 중단합니다.
function cancelablePromiseRace<T>(abortablePromiseBuilders: AbortablePromiseBuilder<T[number]>[], options?: { abortSignal?: AbortSignalLike }): Promise<T[number]>매개 변수
- abortablePromiseBuilders
-
AbortablePromiseBuilder<T[number]>[]
- options
-
{ abortSignal?: AbortSignalLike }
반환
Promise<T[number]>
computeSha256Hash(string, "base64" | "hex")
SHA-256 해시를 생성합니다.
function computeSha256Hash(content: string, encoding: "base64" | "hex"): Promise<string>매개 변수
- content
-
string
해시에 포함할 데이터입니다.
- encoding
-
"base64" | "hex"
반환된 해시에 사용할 텍스트 인코딩입니다.
반환
Promise<string>
computeSha256Hmac(string, string, "base64" | "hex")
SHA-256 HMAC 서명을 생성합니다.
function computeSha256Hmac(key: string, stringToSign: string, encoding: "base64" | "hex"): Promise<string>매개 변수
- key
-
string
암호화 HMAC 해시를 생성하는 데 사용되는 base64 문자열로 표현되는 HMAC 키입니다.
- stringToSign
-
string
서명할 데이터입니다.
- encoding
-
"base64" | "hex"
반환된 HMAC 다이제스트에 사용할 텍스트 인코딩입니다.
반환
Promise<string>
createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)
중단 가능한 약속을 만듭니다.
function createAbortablePromise<T>(buildPromise: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, options?: CreateAbortablePromiseOptions): Promise<T>매개 변수
- buildPromise
-
(resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void
확인 및 거부 함수를 매개 변수로 사용하는 함수입니다.
- options
- CreateAbortablePromiseOptions
중단 가능한 약속에 대한 옵션입니다.
반환
Promise<T>
중단될 수 있는 약속입니다.
delay(number, DelayOptions)
timeInMs 밀리초 후에 약속을 확인하는 setTimeout에 대한 래퍼입니다.
function delay(timeInMs: number, options?: DelayOptions): Promise<void>매개 변수
- timeInMs
-
number
지연될 시간(밀리초)입니다.
- options
- DelayOptions
지연 옵션 - 현재 중단 옵션
반환
Promise<void>
TimeInMs 이후에 해결되는 Promise
getErrorMessage(unknown)
오류 개체로 생각되는 항목이 있으면 가능하면 메시지를 반환합니다. 메시지가 누락된 경우 입력의 문자열화된 버전을 반환합니다.
function getErrorMessage(e: unknown): string매개 변수
- e
-
unknown
try 블록에서 throw된 내용
반환
string
입력의 오류 메시지 또는 문자열
getRandomIntegerInclusive(number, number)
두 경계를 모두 포함하는 하한과 상한 사이의 임의 정수 값을 반환합니다. Math.random을 사용하며 안전하지 않습니다. 모든 종류의 보안 용도로 사용해야 하는 경우 더 나은 임의 소스를 찾습니다.
function getRandomIntegerInclusive(min: number, max: number): number매개 변수
- min
-
number
허용되는 가장 작은 정수 값입니다.
- max
-
number
허용되는 가장 큰 정수 값입니다.
반환
number
isDefined<T>(undefined | null | T)
정의되어 있는지 여부를 확인하는 도우미 TypeGuard입니다.
function isDefined<T>(thing: undefined | null | T): thing매개 변수
- thing
-
undefined | null | T
아무것도
반환
thing
isError(unknown)
오류 개체 셰이프에 대한 Typeguard(이름 및 메시지 포함)
function isError(e: unknown): e매개 변수
- e
-
unknown
캐치 절에 의해 잡힌 무언가.
반환
e
isObject(unknown)
입력이 제네릭 JS 개체인 경우를 결정하는 도우미입니다.
function isObject(input: unknown): input매개 변수
- input
-
unknown
반환
input
입력이 null, Array, RegExp 또는 Date가 아닌 개체 형식인 경우 true입니다.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])
입력이 지정된 속성을 가진 개체인지 확인하는 도우미 TypeGuard입니다.
function isObjectWithProperties<Thing, PropertyName>(thing: Thing, properties: PropertyName[]): thing매개 변수
- thing
-
Thing
아무것도.
- properties
-
PropertyName[]
개체에 표시되어야 하는 속성의 이름입니다.
반환
thing
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)
입력이 지정된 속성을 가진 개체인지 확인하는 도우미 TypeGuard입니다.
function objectHasProperty<Thing, PropertyName>(thing: Thing, property: PropertyName): thing매개 변수
- thing
-
Thing
모든 개체입니다.
- property
-
PropertyName
개체에 표시할 속성의 이름입니다.
반환
thing
randomUUID()
생성된 범용 고유 식별자
function randomUUID(): string반환
string
v4 UUID를 RFC4122.
stringToUint8Array(string, EncodingType)
문자열을 특정 문자로 인코딩된 바이트 배열로 변환하는 도우미입니다.
function stringToUint8Array(value: string, format: EncodingType): Uint8Array매개 변수
- value
-
string
변환할 문자열
- format
- EncodingType
값을 디코딩하는 데 사용하는 형식
반환
Uint8Array
uint8array
uint8ArrayToString(Uint8Array, EncodingType)
특정 문자 인코딩을 사용하여 바이트를 문자열로 변환하는 도우미
function uint8ArrayToString(bytes: Uint8Array, format: EncodingType): string매개 변수
- bytes
-
Uint8Array
uint8array 바이트
- format
- EncodingType
바이트를 인코딩하는 데 사용하는 형식
반환
string
인코딩된 문자열의 문자열