Options
All
  • Public
  • Public/Protected
  • All
Menu

@uploadcare/upload-client

Index

Type Aliases

AudioInfo: { bitrate: number | null; channels: string | null; codec: string | null; sampleRate: number | null }

Type declaration

  • bitrate: number | null
  • channels: string | null
  • codec: string | null
  • sampleRate: number | null
BaseOptions: { baseURL?: string; contentType?: string; fileName?: string; integration?: string; metadata?: Metadata; onProgress?: ProgressCallback; publicKey: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; secureExpire?: string; secureSignature?: string; signal?: AbortSignal; source?: string; store?: StoreValue; userAgent?: CustomUserAgent }

Type declaration

  • Optional baseURL?: string
  • Optional contentType?: string
  • Optional fileName?: string
  • Optional integration?: string
  • Optional metadata?: Metadata
  • Optional onProgress?: ProgressCallback
  • publicKey: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional secureExpire?: string
  • Optional secureSignature?: string
  • Optional signal?: AbortSignal
  • Optional source?: string
  • Optional store?: StoreValue
  • Optional userAgent?: CustomUserAgent
BaseResponse: { file: Uuid }

Type declaration

BrowserFile: Blob | File
ComputableProgressInfo: { isComputable: true; value: number }

Type declaration

  • isComputable: true
  • value: number
ContentInfo: { image?: ImageInfo; mime?: MimeInfo; video?: VideoInfo }

Type declaration

CustomUserAgent: string | CustomUserAgentFn
CustomUserAgentFn: ((options: CustomUserAgentOptions) => string)

Type declaration

CustomUserAgentOptions: { integration?: string; languageName: string; libraryName: string; libraryVersion: string; publicKey: string }

Type declaration

  • Optional integration?: string
  • languageName: string
  • libraryName: string
  • libraryVersion: string
  • publicKey: string
DirectOptions: { baseCDN?: string; baseURL?: string; contentType?: string; fileName?: string; integration?: string; metadata?: Metadata; onProgress?: ProgressCallback; publicKey: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; secureExpire?: string; secureSignature?: string; signal?: AbortSignal; source?: string; store?: StoreValue; userAgent?: CustomUserAgent }

Type declaration

  • Optional baseCDN?: string
  • Optional baseURL?: string
  • Optional contentType?: string
  • Optional fileName?: string
  • Optional integration?: string
  • Optional metadata?: Metadata
  • Optional onProgress?: ProgressCallback
  • publicKey: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional secureExpire?: string
  • Optional secureSignature?: string
  • Optional signal?: AbortSignal
  • Optional source?: string
  • Optional store?: StoreValue
  • Optional userAgent?: CustomUserAgent
ErrorRequestInfo: { data?: NodeFormData | FormData | SupportedFileInput; headers?: Headers; method?: string; query?: string; url: string }

Type declaration

  • Optional data?: NodeFormData | FormData | SupportedFileInput
  • Optional headers?: Headers
  • Optional method?: string
  • Optional query?: string
  • url: string
ErrorResponseInfo: { error?: { content: string; errorCode: string; statusCode: number } }

Type declaration

  • Optional error?: { content: string; errorCode: string; statusCode: number }
    • content: string
    • errorCode: string
    • statusCode: number
FileFromOptions: { baseCDN?: string; baseURL?: string; checkForUrlDuplicates?: boolean; contentType?: string; fileName?: string; integration?: string; maxConcurrentRequests?: number; metadata?: Metadata; multipartChunkSize?: number; multipartMinFileSize?: number; onProgress?: ProgressCallback; publicKey: string; pusherKey?: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; saveUrlForRecurrentUploads?: boolean; secureExpire?: string; secureSignature?: string; signal?: AbortSignal; source?: string; store?: StoreValue; userAgent?: CustomUserAgent }

Type declaration

  • Optional baseCDN?: string
  • Optional baseURL?: string
  • Optional checkForUrlDuplicates?: boolean
  • Optional contentType?: string
  • Optional fileName?: string
  • Optional integration?: string
  • Optional maxConcurrentRequests?: number
  • Optional metadata?: Metadata
  • Optional multipartChunkSize?: number
  • Optional multipartMinFileSize?: number
  • Optional onProgress?: ProgressCallback
  • publicKey: string
  • Optional pusherKey?: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional saveUrlForRecurrentUploads?: boolean
  • Optional secureExpire?: string
  • Optional secureSignature?: string
  • Optional signal?: AbortSignal
  • Optional source?: string
  • Optional store?: StoreValue
  • Optional userAgent?: CustomUserAgent
FileInfo: { contentInfo: ContentInfo | null; done: number; fileId: Uuid; filename: string; imageInfo: ImageInfo | null; isImage: boolean; isReady: string; isStored: boolean; metadata?: Metadata; mimeType: string; originalFilename: string; s3Bucket?: string; size: number; total: number; uuid: Uuid; videoInfo: VideoInfo | null }

Type declaration

  • contentInfo: ContentInfo | null
  • done: number
  • fileId: Uuid
  • filename: string
  • imageInfo: ImageInfo | null
  • isImage: boolean
  • isReady: string
  • isStored: boolean
  • Optional metadata?: Metadata
  • mimeType: string
  • originalFilename: string
  • Optional s3Bucket?: string
  • size: number
  • total: number
  • uuid: Uuid
  • videoInfo: VideoInfo | null
FileInfoResponse: { type: FileInfo } & FileInfo
FromUploadedOptions: { baseCDN?: string; baseURL?: string; fileName?: string; integration?: string; onProgress?: ProgressCallback; publicKey: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; signal?: AbortSignal; source?: string; userAgent?: CustomUserAgent }

Type declaration

  • Optional baseCDN?: string
  • Optional baseURL?: string
  • Optional fileName?: string
  • Optional integration?: string
  • Optional onProgress?: ProgressCallback
  • publicKey: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional signal?: AbortSignal
  • Optional source?: string
  • Optional userAgent?: CustomUserAgent
FromUrlOptions: { baseURL?: string; checkForUrlDuplicates?: boolean; fileName?: string; integration?: string; metadata?: Metadata; publicKey: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; saveUrlForRecurrentUploads?: boolean; secureExpire?: string; secureSignature?: string; signal?: AbortSignal; source?: string; store?: StoreValue; userAgent?: CustomUserAgent }

Type declaration

  • Optional baseURL?: string
  • Optional checkForUrlDuplicates?: boolean
  • Optional fileName?: string
  • Optional integration?: string
  • Optional metadata?: Metadata
  • publicKey: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional saveUrlForRecurrentUploads?: boolean
  • Optional secureExpire?: string
  • Optional secureSignature?: string
  • Optional signal?: AbortSignal
  • Optional source?: string
  • Optional store?: StoreValue
  • Optional userAgent?: CustomUserAgent
FromUrlResponse: FromUrlSuccessResponse
FromUrlStatusOptions: { baseURL?: string; integration?: string; publicKey?: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; signal?: AbortSignal; userAgent?: CustomUserAgent }

Type declaration

  • Optional baseURL?: string
  • Optional integration?: string
  • Optional publicKey?: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional signal?: AbortSignal
  • Optional userAgent?: CustomUserAgent
FromUrlSuccessResponse: FileInfoResponse | TokenResponse
GeoLocation: { latitude: number; longitude: number }

Type declaration

  • latitude: number
  • longitude: number
GetUserAgentOptions: { integration?: string; libraryName: string; libraryVersion: string; publicKey?: string; userAgent?: CustomUserAgent | null }

Type declaration

  • Optional integration?: string
  • libraryName: string
  • libraryVersion: string
  • Optional publicKey?: string
  • Optional userAgent?: CustomUserAgent | null
GroupFromOptions: { jsonpCallback?: string }

Type declaration

  • Optional jsonpCallback?: string
GroupId: string
GroupInfo: { cdnUrl: string; datetimeCreated: string; datetimeStored: string | null; files: FileInfo[]; filesCount: string; id: GroupId; url: string }

Type declaration

  • cdnUrl: string
  • datetimeCreated: string
  • datetimeStored: string | null
  • files: FileInfo[]
  • filesCount: string
  • id: GroupId
  • url: string
GroupInfoOptions: { baseURL?: string; integration?: string; publicKey: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; signal?: AbortSignal; source?: string; userAgent?: CustomUserAgent }

Type declaration

  • Optional baseURL?: string
  • Optional integration?: string
  • publicKey: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional signal?: AbortSignal
  • Optional source?: string
  • Optional userAgent?: CustomUserAgent
GroupOptions: { baseURL?: string; integration?: string; jsonpCallback?: string; publicKey: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; secureExpire?: string; secureSignature?: string; signal?: AbortSignal; source?: string; userAgent?: CustomUserAgent }

Type declaration

  • Optional baseURL?: string
  • Optional integration?: string
  • Optional jsonpCallback?: string
  • publicKey: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional secureExpire?: string
  • Optional secureSignature?: string
  • Optional signal?: AbortSignal
  • Optional source?: string
  • Optional userAgent?: CustomUserAgent
Headers: {}

Type declaration

  • [key: string]: string | string[] | undefined
ImageInfo: { colorMode: string; datetimeOriginal: string; dpi: { 0: number; 1: number } | null; format: string; geoLocation: GeoLocation | null; height: number; orientation: number | null; sequence: boolean | null; width: number }

Type declaration

  • colorMode: string
  • datetimeOriginal: string
  • dpi: { 0: number; 1: number } | null
  • format: string
  • geoLocation: GeoLocation | null
  • height: number
  • orientation: number | null
  • sequence: boolean | null
  • width: number
InfoOptions: { baseURL?: string; integration?: string; publicKey: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; signal?: AbortSignal; source?: string; userAgent?: CustomUserAgent }

Type declaration

  • Optional baseURL?: string
  • Optional integration?: string
  • publicKey: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional signal?: AbortSignal
  • Optional source?: string
  • Optional userAgent?: CustomUserAgent
Metadata: Record<string, string>
MimeInfo: { mime: string; subtype: string; type: string }

Type declaration

  • mime: string
  • subtype: string
  • type: string
MultipartCompleteOptions: { baseURL?: string; integration?: string; publicKey: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; signal?: AbortSignal; source?: string; userAgent?: CustomUserAgent }

Type declaration

  • Optional baseURL?: string
  • Optional integration?: string
  • publicKey: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional signal?: AbortSignal
  • Optional source?: string
  • Optional userAgent?: CustomUserAgent
MultipartOptions: { baseCDN?: string; baseURL?: string; contentType?: string; fileName?: string; fileSize?: number; integration?: string; maxConcurrentRequests?: number; metadata?: Metadata; multipartChunkSize?: number; onProgress?: ProgressCallback<ComputableProgressInfo>; publicKey: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; secureExpire?: string; secureSignature?: string; signal?: AbortSignal; source?: string; store?: StoreValue; userAgent?: CustomUserAgent }

Type declaration

  • Optional baseCDN?: string
  • Optional baseURL?: string
  • Optional contentType?: string
  • Optional fileName?: string
  • Optional fileSize?: number
  • Optional integration?: string
  • Optional maxConcurrentRequests?: number
  • Optional metadata?: Metadata
  • Optional multipartChunkSize?: number
  • Optional onProgress?: ProgressCallback<ComputableProgressInfo>
  • publicKey: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional secureExpire?: string
  • Optional secureSignature?: string
  • Optional signal?: AbortSignal
  • Optional source?: string
  • Optional store?: StoreValue
  • Optional userAgent?: CustomUserAgent
MultipartPart: string
MultipartStartOptions: { baseURL?: string; contentType?: string; fileName?: string; integration?: string; metadata?: Metadata; multipartChunkSize?: number; publicKey: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; secureExpire?: string; secureSignature?: string; signal?: AbortSignal; source?: string; store?: StoreValue; userAgent?: CustomUserAgent }

Type declaration

  • Optional baseURL?: string
  • Optional contentType?: string
  • Optional fileName?: string
  • Optional integration?: string
  • Optional metadata?: Metadata
  • Optional multipartChunkSize?: number
  • publicKey: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional secureExpire?: string
  • Optional secureSignature?: string
  • Optional signal?: AbortSignal
  • Optional source?: string
  • Optional store?: StoreValue
  • Optional userAgent?: CustomUserAgent
MultipartStartResponse: { parts: MultipartPart[]; uuid: Uuid }

Type declaration

MultipartUploadOptions: { contentType?: string; integration?: string; onProgress?: ProgressCallback<ComputableProgressInfo>; publicKey?: string; retryNetworkErrorMaxTimes?: number; retryThrottledRequestMaxTimes?: number; signal?: AbortSignal }

Type declaration

  • Optional contentType?: string
  • Optional integration?: string
  • Optional onProgress?: ProgressCallback<ComputableProgressInfo>
  • Optional publicKey?: string
  • Optional retryNetworkErrorMaxTimes?: number
  • Optional retryThrottledRequestMaxTimes?: number
  • Optional signal?: AbortSignal
MultipartUploadResponse: { code?: number }

Type declaration

  • Optional code?: number
NodeFile: Buffer
ProgressCallback<T>: ((arg: T) => void)

Type Parameters

Type declaration

    • (arg: T): void
    • Parameters

      • arg: T

      Returns void

ReactNativeAsset: { name?: string; type: string; uri: string }

Type declaration

  • Optional name?: string
  • type: string
  • uri: string
StatusErrorResponse: { error: string; errorCode: string; status: Error }

Type declaration

  • error: string
  • errorCode: string
  • status: Error
StatusProgressResponse: { done: number; size: number; status: Progress; total: number | "unknown" }

Type declaration

  • done: number
  • size: number
  • status: Progress
  • total: number | "unknown"
StatusSuccessResponse: { status: Success } & FileInfo
StatusUnknownResponse: { status: Unknown }

Type declaration

StatusWaitingResponse: { status: Waiting }

Type declaration

SupportedFileInput: BrowserFile | NodeFile | ReactNativeAsset
Token: string
TokenResponse: { token: string; type: Token }

Type declaration

UnknownProgressInfo: { isComputable: false }

Type declaration

  • isComputable: false
UploadFromUrlOptions: { baseCDN?: string; onProgress?: ProgressCallback; pusherKey?: string } & FromUrlOptions
Url: string
Uuid: string
VideoInfo: { audio: AudioInfo | null; bitrate: number; duration: number; format: string; video: { bitrate: number; codec: string; frameRate: number; height: number; width: number } }

Type declaration

  • audio: AudioInfo | null
  • bitrate: number
  • duration: number
  • format: string
  • video: { bitrate: number; codec: string; frameRate: number; height: number; width: number }
    • bitrate: number
    • codec: string
    • frameRate: number
    • height: number
    • width: number

Functions

  • Parameters

    Returns string

Generated using TypeDoc