Feature: hopp-cli in TypeScript (#2074)
Co-authored-by: Andrew Bastin <andrewbastin.k@gmail.com> Co-authored-by: liyasthomas <liyascthomas@gmail.com> Co-authored-by: Gita Alekhya Paul <gitaalekhyapaul@gmail.com>
This commit is contained in:
36
packages/hoppscotch-cli/src/interfaces/request.ts
Normal file
36
packages/hoppscotch-cli/src/interfaces/request.ts
Normal file
@@ -0,0 +1,36 @@
|
||||
import { AxiosPromise, AxiosRequestConfig } from "axios";
|
||||
import { HoppRESTRequest } from "@hoppscotch/data";
|
||||
|
||||
/**
|
||||
* Provides definition to object returned by createRequest.
|
||||
* @property {function} request Axios request promise, executed to get axios
|
||||
* response promise.
|
||||
* @property {string} path Path of request within collection file.
|
||||
* @property {string} name Name of request within collection
|
||||
* @property {string} testScript Stringified hoppscotch testScript, used while
|
||||
* running testRunner.
|
||||
*/
|
||||
export interface RequestStack {
|
||||
request: () => AxiosPromise<any>;
|
||||
path: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Provides definition to axios request promise's request parameter.
|
||||
* @property {boolean} supported - Boolean check for supported or unsupported requests.
|
||||
*/
|
||||
export interface RequestConfig extends AxiosRequestConfig {
|
||||
supported: boolean;
|
||||
}
|
||||
|
||||
export interface EffectiveHoppRESTRequest extends HoppRESTRequest {
|
||||
/**
|
||||
* The effective final URL.
|
||||
*
|
||||
* This contains path, params and environment variables all applied to it
|
||||
*/
|
||||
effectiveFinalURL: string;
|
||||
effectiveFinalHeaders: { key: string; value: string; active: boolean }[];
|
||||
effectiveFinalParams: { key: string; value: string; active: boolean }[];
|
||||
effectiveFinalBody: FormData | string | null;
|
||||
}
|
||||
Reference in New Issue
Block a user