FilesExpand file tree

 master

/

request.d.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

120 lines (103 loc) · 3.56 KB

 master

/

request.d.ts

Top

File metadata and controls

• Code
• Blame

120 lines (103 loc) · 3.56 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

import { File, HttpRequestOptions, ImageSource } from '@nativescript/core';

import * as Https from './request.common';

export interface HttpsSSLPinningOptions {

host: string;

certificate: string;

allowInvalidCertificates?: boolean;

validatesDomainName?: boolean;

commonName?: string;

}

export interface CacheOptions {

diskLocation: string;

diskSize: number;

memorySize?: number;

forceCache?: boolean;

}

export interface HttpsFormDataParam {

data: any;

parameterName: string;

fileName?: string;

contentType?: string;

}

export interface HttpsRequestObject {

[key: string]: string | number | boolean | HttpsRequestObject | any[] | HttpsFormDataParam;

}

export interface Headers {

[k: string]: string;

}

export type CachePolicy = 'noCache' | 'onlyCache' | 'ignoreCache';

export interface HttpsRequestOptions extends HttpRequestOptions {

url: string;

tag?: string; // optional request tag to allow to cancel it

method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD';

headers?: Headers;

params?: HttpsRequestObject;

body?: HttpsRequestObject | HttpsFormDataParam[];

/**

* content can be used to pass native custom okhttp3.RequestBody

*/

content?: string | any;

/**

* Default 10 (seconds).

*/

timeout?: number;

/**

* On Android large responses may crash the app (fi. https://httpbin.org/bytes/10000).

* By setting this to true and when not using useLegacy, we allow large responses on the main thread (which this plugin currently does).

* Note that once set to true, this policy remains active until the app is killed.

*/

allowLargeResponse?: boolean;

/**

* iOS for now

*/

onProgress?: (current: number, total: number) => void;

cachePolicy?: CachePolicy;

/**

* default to true. Android and iOS only store cookies in memory! it will be cleared after an app restart

*/

cookiesEnabled?: boolean;

}

export interface HttpsResponse<T = any> {

headers?: Headers;

statusCode?: number;

contentLength: number;

content?: T;

reason?: string;

description?: string;

url?: string;

failure?: any;

}

export interface HttpsRequest {

nativeRequest;

cancel();

run(success, failure);

}

export interface HttpsResponseLegacy<T = any> {

contentLength: number;

toArrayBuffer(): ArrayBuffer;

toArrayBufferAsync(): Promise<ArrayBuffer>;

toString(): string;

toStringAsync(): Promise<string>;

toJSON(): T;

toJSONAsync(): Promise<T>;

toImage(): Promise<ImageSource>;

// toImageAsync(): Promise<ImageSource>;

toFile(destinationFilePath: string): Promise<File>;

// toFileAsync(destinationFilePath: string): Promise<File>;

}

export function enableSSLPinning(options: HttpsSSLPinningOptions);

export function disableSSLPinning();

// export declare function request<T = any>(options: HttpsRequestOptions): Promise<HttpsResponse<HttpsResponseLegacy<T>>>;

export declare function request<T = any, U extends boolean = true>(

options: HttpsRequestOptions,

useLegacy?: U

): U extends true ? Promise<HttpsResponse<HttpsResponseLegacy<T>>> : Promise<HttpsResponse<T>>;

export function setCache(options?: CacheOptions);

export function clearCache();

export function createRequest(opts: HttpsRequestOptions): HttpsRequest;

export function cancelRequest(tag: string);

export function cancelAllRequests();

export function clearCookies();

export function addNetworkInterceptor(interceptor);

export function getClient(opts: Partial<HttpsRequestOptions>);

export * from './request.common';