Back to Trilium

Interface AxiosStatic

docs/Script API/interfaces/Backend_Script_API._internal_.AxiosStatic.html

0.102.221.7 KB
Original Source

Interface AxiosStatic

interface AxiosStatic {
all: <T>(values: (T | Promise<T>)[]) => Promise<T[]>;
Axios: typeof Axios;
AxiosError: typeof AxiosError;
AxiosHeaders: typeof AxiosHeaders;
Cancel: CancelStatic;
CanceledError: typeof CanceledError;
CancelToken: CancelTokenStatic;
defaults: Omit<AxiosDefaults<any>, "headers"> & {
headers: HeadersDefaults & { [key: string]: AxiosHeaderValue };
};
formToJSON: (form: GenericFormData | GenericHTMLFormElement) => object;
getAdapter: (
adapters: undefined | AxiosAdapterConfig | AxiosAdapterConfig[],
) => AxiosAdapter;
HttpStatusCode: typeof HttpStatusCode;
interceptors: {
request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>;
response: AxiosInterceptorManager<AxiosResponse<any, any>>;
};
isAxiosError: <T = any, D = any>(
payload: any,
) => payload is AxiosError<T, D>;
isCancel: (value: any) => value is Cancel;
mergeConfig: <D = any>(
config1: AxiosRequestConfig<D>,
config2: AxiosRequestConfig<D>,
) => AxiosRequestConfig<D>;
spread: <T, R>(callback: (...args: T[]) => R) => (array: T[]) => R;
toFormData: (
sourceObj: object,
targetFormData?: GenericFormData,
options?: FormSerializerOptions,
) => GenericFormData;
VERSION: string;
create(config?: CreateAxiosDefaults<any>): AxiosInstance;
delete<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
config?: AxiosRequestConfig<D>,
): Promise<R>;
get<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
config?: AxiosRequestConfig<D>,
): Promise<R>;
getUri(config?: AxiosRequestConfig<any>): string;
head<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
config?: AxiosRequestConfig<D>,
): Promise<R>;
options<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
config?: AxiosRequestConfig<D>,
): Promise<R>;
patch<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D>,
): Promise<R>;
patchForm<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D>,
): Promise<R>;
post<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D>,
): Promise<R>;
postForm<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D>,
): Promise<R>;
put<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D>,
): Promise<R>;
putForm<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D>,
): Promise<R>;
request<T = any, R = AxiosResponse<T, any>, D = any>(
config: AxiosRequestConfig<D>,
): Promise<R>;
<T = any, R = AxiosResponse<T, any>, D = any>(
config: AxiosRequestConfig<D>,
): Promise<R>;
<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
config?: AxiosRequestConfig<D>,
): Promise<R>;
}

Hierarchy (View Summary)

AxiosStatic<T = any, R = AxiosResponse<T, any>, D = any>(
config: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

AxiosStatic<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
config?: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

Index

Properties

allAxiosAxiosErrorAxiosHeadersCancelCanceledErrorCancelTokendefaultsformToJSONgetAdapterHttpStatusCodeinterceptorsisAxiosErrorisCancelmergeConfigspreadtoFormDataVERSION

Methods

createdeletegetgetUriheadoptionspatchpatchFormpostpostFormputputFormrequest

Properties

all

all: <T>(values: (T | Promise<T>)[]) => Promise<T[]>

Axios

Axios: typeof Axios

AxiosError

AxiosError: typeof AxiosError

AxiosHeaders

AxiosHeaders: typeof AxiosHeaders

Cancel

Cancel: CancelStatic

CanceledError

CanceledError: typeof CanceledError

CancelToken

CancelToken: CancelTokenStatic

defaults

defaults: Omit<AxiosDefaults<any>, "headers"> & {
headers: HeadersDefaults & { [key: string]: AxiosHeaderValue };
}

formToJSON

formToJSON: (form: GenericFormData | GenericHTMLFormElement) => object

getAdapter

getAdapter: (
adapters: undefined | AxiosAdapterConfig | AxiosAdapterConfig[],
) => AxiosAdapter

HttpStatusCode

HttpStatusCode: typeof HttpStatusCode

interceptors

interceptors: {
request: AxiosInterceptorManager<InternalAxiosRequestConfig<any>>;
response: AxiosInterceptorManager<AxiosResponse<any, any>>;
}

isAxiosError

isAxiosError: <T = any, D = any>(payload: any) => payload is AxiosError<T, D>

isCancel

isCancel: (value: any) => value is Cancel

mergeConfig

mergeConfig: <D = any>(
config1: AxiosRequestConfig<D>,
config2: AxiosRequestConfig<D>,
) => AxiosRequestConfig<D>

spread

spread: <T, R>(callback: (...args: T[]) => R) => (array: T[]) => R

toFormData

toFormData: (
sourceObj: object,
targetFormData?: GenericFormData,
options?: FormSerializerOptions,
) => GenericFormData

ReadonlyVERSION

VERSION: string

Methods

create

create(config?: CreateAxiosDefaults<any>): AxiosInstance

Parameters

Returns AxiosInstance

delete

delete<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
config?: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

get

get<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
config?: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

getUri

getUri(config?: AxiosRequestConfig<any>): string

Parameters

Returns string

head<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
config?: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

options

options<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
config?: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

patch

patch<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

patchForm

patchForm<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

post

post<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

postForm

postForm<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

put

put<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

putForm

putForm<T = any, R = AxiosResponse<T, any>, D = any>(
url: string,
data?: D,
config?: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

request

request<T = any, R = AxiosResponse<T, any>, D = any>(
config: AxiosRequestConfig<D>,
): Promise<R>

Type Parameters

Parameters

Returns Promise<R>

Settings

Member Visibility

  • Protected
  • Inherited
  • External

ThemeOSLightDark

On This Page

Properties allAxiosAxiosErrorAxiosHeadersCancelCanceledErrorCancelTokendefaultsformToJSONgetAdapterHttpStatusCodeinterceptorsisAxiosErrorisCancelmergeConfigspreadtoFormDataVERSION Methods createdeletegetgetUriheadoptionspatchpatchFormpostpostFormputputFormrequest