Skip to content

proposal: improving typings of AxiosRequestTransformer #10744

@salisbury-espinosa

Description

@salisbury-espinosa

https://github.com/axios/axios/blob/main/index.d.cts#L391

current AxiosRequestTransformer:

interface AxiosRequestTransformer {
    (this: InternalAxiosRequestConfig, data: any, headers: AxiosRequestHeaders): any;
}

used in AxiosRequestConfig:

interface AxiosRequestConfig<D = any> {
    ....
    transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
   ....
    data?: D;

maybe it makes sense to improve this (remove any) =>

type ResultOfChainAxiosRequestTransformer = Stream | string | Buffer | ArrayBuffer;

interface FirstAndOnlyAxiosRequestTransformer<D> {
    (this: InternalAxiosRequestConfig, data: D, headers: AxiosRequestHeaders):  ResultOfChainAxiosRequestTransformer;
  }
  
  
  
interface FirstOfChainAxiosRequestTransformer<D> {
    (this: InternalAxiosRequestConfig, data: D, headers: AxiosRequestHeaders): D | ResultOfChainAxiosRequestTransformer;
  }
  
  
interface NotLastOfChainAxiosRequestTransformer<D> {
    (this: InternalAxiosRequestConfig, data: D | ResultOfChainAxiosRequestTransformer, headers: AxiosRequestHeaders): D | ResultOfChainAxiosRequestTransformer;
  }
  
interface LastOfChainAxiosRequestTransformer<D> {
    (this: InternalAxiosRequestConfig, data: D | ResultOfChainAxiosRequestTransformer, headers: AxiosRequestHeaders):  ResultOfChainAxiosRequestTransformer;
  }

+

interface AxiosRequestConfig<D = any> {
    ....
        transformRequest?: FirstAndOnlyAxiosRequestTransformer | [FirstOfChainAxiosRequestTransformer, ...NotLastOfChainAxiosRequestTransformer[], LastOfChainAxiosRequestTransformer];
   ....
    data?: D;

related comment: #10745 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions