clients/http/index
@prismatic-io/spectral › "clients/http/index"
Index
Interfaces
Type aliases
Functions
- buildRawRequestAction
- computeRetryDelay
- createClient
- handleErrors
- sendRawRequest
- toAuthorizationHeaders
- toAxiosRetryConfig
- toFormData
Type aliases
HttpClient
Ƭ HttpClient: AxiosInstance
Defined in packages/spectral/src/clients/http/index.ts:11
SendRawRequestValues
Ƭ SendRawRequestValues: ActionInputParameters‹typeof inputs›
Defined in packages/spectral/src/clients/http/index.ts:140
Functions
Const
buildRawRequestAction
▸ buildRawRequestAction(baseUrl
: string, label
: string, description
: string): ActionDefinition‹object, boolean, object›
Defined in packages/spectral/src/clients/http/index.ts:182
Parameters:
Name | Type | Default |
---|---|---|
baseUrl | string | - |
label | string | "Raw Request" |
description | string | "Issue a raw HTTP request" |
Returns: ActionDefinition‹object, boolean, object›
Const
computeRetryDelay
▸ computeRetryDelay(retryDelay
: RetryConfig["retryDelay"], useExponentialBackoff
: RetryConfig["useExponentialBackoff"]): IAxiosRetryConfig["retryDelay"]
Defined in packages/spectral/src/clients/http/index.ts:69
Parameters:
Name | Type |
---|---|
retryDelay | RetryConfig["retryDelay"] |
useExponentialBackoff | RetryConfig["useExponentialBackoff"] |
Returns: IAxiosRetryConfig["retryDelay"]
Const
createClient
▸ createClient(__namedParameters
: object): HttpClient
Defined in packages/spectral/src/clients/http/index.ts:91
Parameters:
▪ __namedParameters: object
Name | Type | Default |
---|---|---|
baseUrl | undefined | string | - |
debug | boolean | false |
headers | undefined | object | - |
params | undefined | object | - |
responseType | undefined | "text" | "arraybuffer" | "blob" | "document" | "json" | "stream" | - |
retryConfig | undefined | RetryConfig‹› | - |
timeout | undefined | number | - |
Returns: HttpClient
Const
handleErrors
▸ handleErrors(error
: unknown): unknown
Defined in packages/spectral/src/clients/http/index.ts:129
Parameters:
Name | Type |
---|---|
error | unknown |
Returns: unknown
Const
sendRawRequest
▸ sendRawRequest(baseUrl
: string, values
: SendRawRequestValues, authorizationHeaders
: Record‹string, string›): Promise‹AxiosResponse›
Defined in packages/spectral/src/clients/http/index.ts:142
Parameters:
Name | Type | Default |
---|---|---|
baseUrl | string | - |
values | SendRawRequestValues | - |
authorizationHeaders | Record‹string, string› | {} |
Returns: Promise‹AxiosResponse›
Const
toAuthorizationHeaders
▸ toAuthorizationHeaders(connection
: Connection): object
Defined in packages/spectral/src/clients/http/index.ts:13
Parameters:
Name | Type |
---|---|
connection | Connection |
Returns: object
- Authorization: string
Const
toAxiosRetryConfig
▸ toAxiosRetryConfig(__namedParameters
: object): IAxiosRetryConfig
Defined in packages/spectral/src/clients/http/index.ts:79
Parameters:
▪ __namedParameters: object
Name | Type |
---|---|
rest | rest |
retryAllErrors | undefined | false | true |
retryCondition | undefined | function |
retryDelay | undefined | number | function |
useExponentialBackoff | undefined | false | true |
Returns: IAxiosRetryConfig
Const
toFormData
▸ toFormData(formData
: KeyValuePair‹unknown›[], fileData
: KeyValuePair‹unknown›[], fileDataFileNames
: Record‹string, string›): FormData
Defined in packages/spectral/src/clients/http/index.ts:38
Parameters:
Name | Type | Default |
---|---|---|
formData | KeyValuePair‹unknown›[] | - |
fileData | KeyValuePair‹unknown›[] | - |
fileDataFileNames | Record‹string, string› | {} |
Returns: FormData