Module: core/upload
Type aliases
Dimensions
Ƭ Dimensions: Object
Type declaration
| Name | Type |
|---|---|
height | number |
width | number |
FileUpload
Ƭ FileUpload: Object
Type declaration
| Name | Type |
|---|---|
height | number |
size | number |
url | string |
width | number |
NativeFile
Ƭ NativeFile: Object
Type declaration
| Name | Type |
|---|---|
height | number |
uri | string |
width | number |
Functions
imageDimensions
▸ imageDimensions(file): Promise<Dimensions>
Loads an image to determine its dimensions
Parameters
| Name | Type |
|---|---|
file | File |
Returns
Promise<Dimensions>
the width and height of the image
large
▸ large(image): ImageData
Large thumbnail with cloudinary + cloudfront support
Parameters
| Name | Type |
|---|---|
image | Image |
Returns
resized
▸ resized(url, width?): string
Scaled down image URL
Parameters
| Name | Type | Default value |
|---|---|---|
url | string | undefined |
width | number | 600 |
Returns
string
small
▸ small(image): ImageData
Small thumbnail with cloudinary + cloudfront support
Parameters
| Name | Type |
|---|---|
image | Image |
Returns
thumbnail
▸ thumbnail(image, maxwidth?): ImageData
Returns a scaled down image, dimensions may be 0
Parameters
| Name | Type | Default value |
|---|---|---|
image | Image | ImageData | undefined |
maxwidth | number | 600 |
Returns
upload
▸ upload(api, auth, file, folder?): Promise<void>
Upload a file
Parameters
| Name | Type | Default value |
|---|---|---|
api | string | undefined |
auth | string | undefined |
file | File | undefined |
folder | string | '' |
Returns
Promise<void>
the URL and size of the uploaded file
uploadAxios
▸ uploadAxios(file, axios): Promise<any>
Upload a file using axios
Parameters
| Name | Type |
|---|---|
file | File |
axios | Axios |
Returns
Promise<any>
the URL and size of the uploaded file
useUpload
▸ useUpload(): (file: File, folder: string) => Promise<void>
Upload a file
Returns
fn
▸ (file, folder?): Promise<void>
Parameters
| Name | Type | Default value |
|---|---|---|
file | File | undefined |
folder | string | '' |
Returns
Promise<void>
useUploadNative
▸ useUploadNative(): (input: NativeFile, folder: string) => Promise<any>
Upload a file in React Native/Expo
Returns
fn
▸ (input, folder?): Promise<any>
Parameters
| Name | Type | Default value |
|---|---|---|
input | NativeFile | undefined |
folder | string | '' |
Returns
Promise<any>
useUploadWeb
▸ useUploadWeb(): (input: File | FileList, folder: string) => Promise<any>
Upload a file on Web
Returns
fn
▸ (input, folder?): Promise<any>
Parameters
| Name | Type | Default value |
|---|---|---|
input | File | FileList | undefined |
folder | string | '' |
Returns
Promise<any>