@basevich/catbox.moe v1.2.2
Installation
# with npm
$ npm install catbox.moe
# or with Yarn
$ yarn add catbox.moe
Documentation
Catbox(userHash)
new Catbox.Catbox(userHash)
userHash
- A string containing hash of the user to which the operations will be made, if undefined the operations will be done as anonymous
Methods
upload(urlOrPath)
Upload files
urlOrPath
- A URL or path to the file
Returns: Promise[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
delete(files)
Delete one or more files
files
- An array with the URL or short code of the files
Returns: Promise[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
getAlbum(short)
Get album information
short
- Album short URL or code
Returns: Promise[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
createAlbum(options)
Create a new album for your account or anonymously
options
- An object containing one or more of the following propertiestitle
- Name for the albumdescription
- Description for the albumfiles
- Short code or files URL to add to album
Returns: Promise[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
editAlbum(options)
Edit album info
options
- An object containing the following propertiesshort
- Album short code or URLtitle
- New name for the albumdescription
- New description for the albumfiles
- Short code or files URL to add to album
Returns: Promise[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
addFilesAlbum(options)
Add files to an album
options
- An object containing the following propertiesshort
- Album short code or URLfiles
- An array with the short code or URL of files
Returns: Promise[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
removeFilesAlbum(options)
Remove files from an album
options
- An object containing the following propertiesshort
- Album short code or URLfiles
- An array with the short code or URL of files
Returns: Promise[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
deleteAlbum(short)
Delete album
short
- Short code or album URL
Litterbox()
new Catbox.Litterbox()
Methods
upload(path, time)
Upload file that will be available temporarily
path
- Relative path of the file to be uploadedtime
- Duration in hours for file expiration, default is 1h. (Allowed values are1h
,12h
,24h
, and72h
)
Returns: Promise[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
1 year ago