Skip to content

Commit a1c8ad0

Browse files
authoredSep 29, 2023
fix(types): fix AxiosHeaders types; (#5931)
1 parent 2ac731d commit a1c8ad0

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed
 

‎index.d.cts

+6-4
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ type MethodsHeaders = Partial<{
88

99
type AxiosHeaderMatcher = (this: AxiosHeaders, value: string, name: string, headers: RawAxiosHeaders) => boolean;
1010

11+
type AxiosHeaderParser = (this: AxiosHeaders, value: axios.AxiosHeaderValue, header: string) => any;
12+
1113
type CommonRequestHeadersList = 'Accept' | 'Content-Length' | 'User-Agent'| 'Content-Encoding' | 'Authorization';
1214

1315
type ContentType = axios.AxiosHeaderValue | 'text/html' | 'text/plain' | 'multipart/form-data' | 'application/json' | 'application/x-www-form-urlencoded' | 'application/octet-stream';
@@ -16,18 +18,18 @@ type CommonResponseHeadersList = 'Server' | 'Content-Type' | 'Content-Length' |
1618

1719
declare class AxiosHeaders {
1820
constructor(
19-
headers?: RawAxiosHeaders | AxiosHeaders
21+
headers?: RawAxiosHeaders | AxiosHeaders | string
2022
);
2123

2224
[key: string]: any;
2325

2426
set(headerName?: string, value?: axios.AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
25-
set(headers?: RawAxiosHeaders | AxiosHeaders, rewrite?: boolean): AxiosHeaders;
27+
set(headers?: RawAxiosHeaders | AxiosHeaders | string, rewrite?: boolean): AxiosHeaders;
2628

2729
get(headerName: string, parser: RegExp): RegExpExecArray | null;
28-
get(headerName: string, matcher?: true | AxiosHeaderMatcher): axios.AxiosHeaderValue;
30+
get(headerName: string, matcher?: true | AxiosHeaderParser): axios.AxiosHeaderValue;
2931

30-
has(header: string, matcher?: true | AxiosHeaderMatcher): boolean;
32+
has(header: string, matcher?: AxiosHeaderMatcher): boolean;
3133

3234
delete(header: string | string[], matcher?: AxiosHeaderMatcher): boolean;
3335

‎index.d.ts

+7-5
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,24 @@ type MethodsHeaders = Partial<{
99
[Key in Method as Lowercase<Key>]: AxiosHeaders;
1010
} & {common: AxiosHeaders}>;
1111

12-
type AxiosHeaderMatcher = (this: AxiosHeaders, value: string, name: string, headers: RawAxiosHeaders) => boolean;
12+
type AxiosHeaderMatcher = string | RegExp | ((this: AxiosHeaders, value: string, name: string) => boolean);
13+
14+
type AxiosHeaderParser = (this: AxiosHeaders, value: AxiosHeaderValue, header: string) => any;
1315

1416
export class AxiosHeaders {
1517
constructor(
16-
headers?: RawAxiosHeaders | AxiosHeaders
18+
headers?: RawAxiosHeaders | AxiosHeaders | string
1719
);
1820

1921
[key: string]: any;
2022

2123
set(headerName?: string, value?: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
22-
set(headers?: RawAxiosHeaders | AxiosHeaders, rewrite?: boolean): AxiosHeaders;
24+
set(headers?: RawAxiosHeaders | AxiosHeaders | string, rewrite?: boolean): AxiosHeaders;
2325

2426
get(headerName: string, parser: RegExp): RegExpExecArray | null;
25-
get(headerName: string, matcher?: true | AxiosHeaderMatcher): AxiosHeaderValue;
27+
get(headerName: string, matcher?: true | AxiosHeaderParser): AxiosHeaderValue;
2628

27-
has(header: string, matcher?: true | AxiosHeaderMatcher): boolean;
29+
has(header: string, matcher?: AxiosHeaderMatcher): boolean;
2830

2931
delete(header: string | string[], matcher?: AxiosHeaderMatcher): boolean;
3032

0 commit comments

Comments
 (0)
Please sign in to comment.