mirror of
https://git.mirrors.martin98.com/https://github.com/actions/toolkit
synced 2025-08-22 19:29:07 +08:00
91b7bf978c
💡 See https://github.com/actions/toolkit/pull/1064 for a better diff! https://github.com/actions/toolkit contains a variety of packages used for building actions. https://github.com/actions/http-client is one such package, but lives outside of the toolkit. Moving it inside of the toolkit will improve discoverability and reduce the number of repos we have to keep track of for maintenance tasks (such as github/c2c-actions-service#2937). I checked with @bryanmacfarlane on the historical decision here. Apparently it was just inertia from before we released the toolkit as multiple packages. The benefits here are: - Have one fewer repo to keep track of - Signal that this is an HTTP client meant for building actions, not for general use. ## Notes - `@actions/http-client` will continue to be released as its own package. - Bumping the package version to **2.0.0**. Since we're compiling in strict mode now, there are some breaking changes to the exported types. This is an improvement because the null-unsafe version of`http-client` is currently breaking the safety of null-safe consumers. - I'm not updating the other packages to use the new version in this PR. I plan to do that in a follow-up. We'll hold off on publishing `http-client` v2 to NPM until that's done just in case other changes shake out of it.
92 lines
2.4 KiB
TypeScript
92 lines
2.4 KiB
TypeScript
import * as http from 'http'
|
|
import * as https from 'https'
|
|
import {HttpClientResponse} from './index'
|
|
|
|
export interface HttpClient {
|
|
options(
|
|
requestUrl: string,
|
|
additionalHeaders?: http.OutgoingHttpHeaders
|
|
): Promise<HttpClientResponse>
|
|
get(
|
|
requestUrl: string,
|
|
additionalHeaders?: http.OutgoingHttpHeaders
|
|
): Promise<HttpClientResponse>
|
|
del(
|
|
requestUrl: string,
|
|
additionalHeaders?: http.OutgoingHttpHeaders
|
|
): Promise<HttpClientResponse>
|
|
post(
|
|
requestUrl: string,
|
|
data: string,
|
|
additionalHeaders?: http.OutgoingHttpHeaders
|
|
): Promise<HttpClientResponse>
|
|
patch(
|
|
requestUrl: string,
|
|
data: string,
|
|
additionalHeaders?: http.OutgoingHttpHeaders
|
|
): Promise<HttpClientResponse>
|
|
put(
|
|
requestUrl: string,
|
|
data: string,
|
|
additionalHeaders?: http.OutgoingHttpHeaders
|
|
): Promise<HttpClientResponse>
|
|
sendStream(
|
|
verb: string,
|
|
requestUrl: string,
|
|
stream: NodeJS.ReadableStream,
|
|
additionalHeaders?: http.OutgoingHttpHeaders
|
|
): Promise<HttpClientResponse>
|
|
request(
|
|
verb: string,
|
|
requestUrl: string,
|
|
data: string | NodeJS.ReadableStream,
|
|
headers: http.OutgoingHttpHeaders
|
|
): Promise<HttpClientResponse>
|
|
requestRaw(
|
|
info: RequestInfo,
|
|
data: string | NodeJS.ReadableStream
|
|
): Promise<HttpClientResponse>
|
|
requestRawWithCallback(
|
|
info: RequestInfo,
|
|
data: string | NodeJS.ReadableStream,
|
|
onResult: (err?: Error, res?: HttpClientResponse) => void
|
|
): void
|
|
}
|
|
|
|
export interface RequestHandler {
|
|
prepareRequest(options: http.RequestOptions): void
|
|
canHandleAuthentication(response: HttpClientResponse): boolean
|
|
handleAuthentication(
|
|
httpClient: HttpClient,
|
|
requestInfo: RequestInfo,
|
|
data: string | NodeJS.ReadableStream | null
|
|
): Promise<HttpClientResponse>
|
|
}
|
|
|
|
export interface RequestInfo {
|
|
options: http.RequestOptions
|
|
parsedUrl: URL
|
|
httpModule: typeof http | typeof https
|
|
}
|
|
|
|
export interface RequestOptions {
|
|
headers?: http.OutgoingHttpHeaders
|
|
socketTimeout?: number
|
|
ignoreSslError?: boolean
|
|
allowRedirects?: boolean
|
|
allowRedirectDowngrade?: boolean
|
|
maxRedirects?: number
|
|
maxSockets?: number
|
|
keepAlive?: boolean
|
|
deserializeDates?: boolean
|
|
// Allows retries only on Read operations (since writes may not be idempotent)
|
|
allowRetries?: boolean
|
|
maxRetries?: number
|
|
}
|
|
|
|
export interface TypedResponse<T> {
|
|
statusCode: number
|
|
result: T | null
|
|
headers: http.IncomingHttpHeaders
|
|
}
|