Interface ReactUploadsAdapter<Registry>

React adapter bound to one typed Beignet upload client.

interface ReactUploadsAdapter<Registry extends UploadClientRegistry> {
    useUpload<Name extends string>(
        uploadName: Name,
        options?: ReactUploadHookOptions<UploadByName<Registry, Name>>,
    ): ReactUploadController<UploadByName<Registry, Name>>;
    useUploadMany<Name extends string>(
        uploadName: Name,
        options?: ReactUploadHookOptions<UploadByName<Registry, Name>>,
    ): ReactUploadManyController<UploadByName<Registry, Name>>;
}

Type Parameters

Registry extends UploadClientRegistry

Index

Methods

useUpload useUploadMany

Methods

useUpload

useUpload<Name extends string>(
uploadName: Name,
options?: ReactUploadHookOptions<UploadByName<Registry, Name>>,
): ReactUploadController<UploadByName<Registry, Name>>
Track state for one upload workflow.
Type Parameters
- Name extends string
Parameters
- uploadName: Name
- Optionaloptions: ReactUploadHookOptions<UploadByName<Registry, Name>>
Returns ReactUploadController<UploadByName<Registry, Name>>
- Defined in index.ts:245

useUploadMany

useUploadMany<Name extends string>(
uploadName: Name,
options?: ReactUploadHookOptions<UploadByName<Registry, Name>>,
): ReactUploadManyController<UploadByName<Registry, Name>>
Track state for one many-file upload workflow.
Type Parameters
- Name extends string
Parameters
- uploadName: Name
- Optionaloptions: ReactUploadHookOptions<UploadByName<Registry, Name>>
Returns ReactUploadManyController<UploadByName<Registry, Name>>
- Defined in index.ts:252