NPM
Taficloud-js-sdk is a simple library for uploading, downloading, and merging files using JavaScript. It supports authenticated requests with API keys and is designed to be easily integrated into web applications.
Features
- Upload files to a specified URL with optional folder support.
- Download files from a specified URL.
- Merge multiple files into a single file.
Installation
You can install the Taficloud library using npm:
If you want to install it as a development dependency:
Usage
Importing the Library
After installing the library, you can import it into your JavaScript/TypeScript project.
Initializing the Taficloud Class
You need to initialize the Taficloud
class with your API key. The API key will be used in the Authorization
header for authenticated requests.
Uploading a File
To upload a file, use the uploadFile
method. This method takes a file (as a File
or Blob
object), a fileName
, and a url
. Optionally, you can specify a folder
.
Downloading a File
To download a file from a URL, use the downloadFile
method. This method will initiate a file download.
Merging Files
You can merge multiple files into a single file using the mergeFiles
method. It takes an array of File
or Blob
objects and returns a merged file.
API Reference
Taficloud Class
constructor(apiKey: string)
Initializes the Taficloud
class with the provided API key.
apiKey
: The API key used for authorization in requests.
uploadFile(file: File | Blob, fileName: string, folder?: string): Promise<any>
Uploads a file to the specified URL.
file
: The file to be uploaded (as aFile
orBlob
object).fileName
: The name of the file.folder
(optional): The folder where the file should be uploaded.
Returns: A Promise
that resolves with the server’s response or rejects with an error.
downloadFile(url: string): Promise<File>
Downloads a file from the specified URL.
url
: The url of the file to download.
Returns: A Promise
that resolves with the downloaded file.
mergeFiles(files: (File | Blob)[], mergedFileName: string): Promise<File>
Merges multiple files into a single file.
files
: An array of files (File
orBlob
objects) to be merged.mergedFileName
: The name of the merged file.
Returns: A Promise
that resolves with the merged file.