Skip to content

WKS-2732 - Added fire-and-forget type definitions for the Axios HTTP … #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
christophermiJfrog merged 1 commit into from
Sep 1, 2026
Merged

WKS-2732 - Added fire-and-forget type definitions for the Axios HTTP … #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 69 additions & 2 deletions api/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,71 @@
import { AxiosInstance } from "axios";
import { AxiosInstance, AxiosRequestConfig } from "axios";

export interface ExtendedAxios {
/**
* Triggers an HTTP GET request and does not wait for the response (fire-and-forget).
* Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
*/
getAndForget: <D = any, P = any>(
url: string,
config?: AxiosRequestConfig<D, P>
) => void;

/**
* Triggers an HTTP PUT request and does not wait for the response (fire-and-forget).
* Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
*/
putAndForget: <D = any, P = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D, P>
) => void;

/**
* Triggers an HTTP POST request and does not wait for the response (fire-and-forget).
* Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
*/
postAndForget: <D = any, P = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D, P>
) => void;

/**
* Triggers an HTTP DELETE request and does not wait for the response (fire-and-forget).
* Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
*/
deleteAndForget: <D = any, P = any>(
url: string,
config?: AxiosRequestConfig<D, P>
) => void;

/**
* Triggers an HTTP HEAD request and does not wait for the response (fire-and-forget).
* Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
*/
headAndForget: <D = any, P = any>(
url: string,
config?: AxiosRequestConfig<D, P>
) => void;

/**
* Triggers an HTTP PATCH request and does not wait for the response (fire-and-forget).
* Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
*/
patchAndForget: <D = any, P = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D, P>
) => void;

/**
* Triggers an HTTP REQUEST and does not wait for the response (fire-and-forget).
* Note: completion is not guaranteed. If the target server ties request processing to the client connection, it may abort the work when the client disconnects.
*/
requestAndForget: <D = any, P = any>(
config: AxiosRequestConfig<D, P>
) => void;
}

/**
* Response returned by JFrog platform API
Expand Down Expand Up @@ -81,7 +148,7 @@ export interface PlatformClients {
/**
* HTTP client (axios) to perform requests to the outside
*/
axios: Pick<AxiosInstance, 'get'|'put'|'post'|'delete'|'head'|'patch'|'request'>;
axios: Pick<AxiosInstance, 'get'|'put'|'post'|'delete'|'head'|'patch'|'request'> & ExtendedAxios;
}

export interface PlatformSecrets {
Expand Down