Skip to content

Refine signedUrl response type #249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dobesv wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Refine signedUrl response type #249

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 13 additions & 15 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,20 @@ declare module 'react-s3-uploader' {

export interface S3Response {
signedUrl: string;
publicUrl: string;
filename: string;
fileKey: string;
headers?: Record<string, string> | null;
}

export interface ReactS3UploaderProps {
export interface ReactS3UploaderProps<R extends S3Response = S3Response> {
signingUrl?: string;
signingUrlMethod?: 'GET' | 'POST';
getSignedUrl?: (file: File, callback: (params: S3Response) => void) => void;
getSignedUrl?: (file: File, callback: (params: R) => void) => void;
accept?: string;
s3path?: string;
preprocess?: (file: File, next: (file: File) => void) => void;
onSignedUrl?: (response: S3Response) => void;
onSignedUrl?: (response: R) => void;
onProgress?: (percent: number, status: string, file: File) => void;
onError?: (message: string) => void;
onFinish?: (result: S3Response, file: File) => void;
onFinish?: (result: R, file: File) => void;
signingUrlHeaders?: {
additional: object;
};
Expand All @@ -35,16 +33,16 @@ declare module 'react-s3-uploader' {
[key: string]: any;
}

class ReactS3Uploader extends Component<ReactS3UploaderProps, unknown> { }
class ReactS3Uploader<R extends S3Response = S3Response> extends Component<ReactS3UploaderProps<R>, unknown> { }

export default ReactS3Uploader;
}

declare module 'react-s3-uploader/s3upload' {
import { ReactS3UploaderProps, S3Response } from 'react-s3-uploader';

export interface S3UploadOptions extends Pick<
ReactS3UploaderProps,
export interface S3UploadOptions<R extends S3Response = S3Response> extends Pick<
ReactS3UploaderProps<R>,
| 'contentDisposition'
| 'getSignedUrl'
| 'onProgress'
Expand All @@ -61,16 +59,16 @@ declare module 'react-s3-uploader/s3upload' {
| 'uploadRequestHeaders'> {
fileElement?: HTMLInputElement | null;
files?: HTMLInputElement['files'] | null;
onFinishS3Put?: ReactS3UploaderProps['onFinish'];
onFinishS3Put?: ReactS3UploaderProps<R>['onFinish'];
successResponses?: number[];
scrubFilename?: (filename: string) => string;
}

class S3Upload {
constructor(options: ReactS3UploaderProps);
class S3Upload<R extends S3Response = S3Response> {
constructor(options: ReactS3UploaderProps<R>);
abortUpload(): void;
uploadFile(file: File): Promise<S3Response>;
uploadToS3(file: File, signResult: S3Response): void;
uploadFile(file: File): Promise<R>;
uploadToS3(file: File, signResult: R): void;
}

export default S3Upload;
Expand Down