Installation

npm install --save @types/react-native-aws3

Summary

This package contains type definitions for react-native-aws3 (https://github.com/benjreinhart/react-native-aws3#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-native-aws3.

index.d.ts

1export interface File {
2    /**
3     * File system URI, can be assets library path or file:// path
4     */
5    uri: string;
6
7    /**
8     * The name of the file, will be stored as such in S3
9     */
10    name: string;
11
12    /**
13     * The mime type, also used for Content-Type parameter in the S3 post policy
14     */
15    type: string;
16}
17
18export interface Options {
19    /**
20     * The Access Control List of this object
21     * @default "public-read"
22     */
23    acl?: string | undefined;
24
25    /**
26     * Prefix, or path to the file on S3, i.e. uploads/ (note the trailing slash)
27     */
28    keyPrefix?: string | undefined;
29
30    /**
31     * Your S3 bucket
32     */
33    bucket: string;
34
35    /**
36     * The region of your S3 bucket
37     */
38    region: string;
39
40    /**
41     * Your S3 AWSAccessKeyId
42     */
43    accessKey: string;
44
45    /**
46     * Your S3 AWSSecretKey
47     */
48    secretKey: string;
49
50    /**
51     * HTTP response status if successful
52     * @default 201
53     */
54    successActionStatus?: number | undefined;
55
56    /**
57     * AWS S3 url
58     * @default "s3.amazonaws.com"
59     */
60    awsUrl?: string | undefined;
61
62    /**
63     * Devices time offset from world clock in milliseconds
64     * @default 0
65     */
66    timeDelta?: number | undefined;
67}
68
69export interface Progress {
70    /**
71     * amount uploaded
72     */
73    loaded: number;
74
75    /**
76     * total amount to upload
77     */
78    total: number;
79
80    /**
81     * number between 0 and 1 representing the percent completed
82     */
83    percent: number;
84}
85
86export interface Request {
87    _xhr: XMLHttpRequest;
88    _formData: FormData;
89    _promise: Promise<Response>;
90
91    header(key: string, value: string): this;
92    set(key: string, value: string | Blob): this;
93    send(): this;
94    abort(): this;
95    progress(callback: (progress: Progress) => any): this;
96    then(...args: Parameters<this["_promise"]["then"]>): this;
97    catch(...args: Parameters<this["_promise"]["catch"]>): this;
98}
99
100export interface Response {
101    status: number;
102    text: string;
103    headers: { [K: string]: string };
104}
105
106export namespace RNS3 {
107    function put(file: File, options: Options): Request;
108}
109

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: none

Credits

These definitions were written by Shirsh Zibbu.