Need private packages and team management tools?Check out npm Teams »

catbox.moe

0.1.1 • Public • Published


Lightweight and simple module to catbox.moe api management

NPM Version NPM Bundle Size Dependencies License
Using this tool, you agree to the Catbox Terms of Service/Privacy Policy available here

Installation

# with npm 
$ npm install catbox.moe
 
# or with Yarn 
$ yarn add catbox.moe

Documentation

Constructor(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

upload(urlOrPath)

Upload files

  • urlOrPath - A url or path to the file to upload

Returns:    Promise<String> — The uploaded file url

delete(files)

Delete one or more files

  • files - An array with the name or url of the files to be deleted from the account

Returns:    Promise<Array> — All files deleted

getAlbum(short)

Get album information

  • short - Short code or url album to retrieve information

Returns:    Promise<Object> — Requested album info

createAlbum(options)

Create a new album for your account or anonymously

  • options - An object containing one or more of the following properties
    • title - Name for the album
    • description - Description for the album
    • files - Name or url of files to add to your album if you wish to add

Returns:    Promise<String> — The URL of the created album

editAlbum(options)

Edit album info

  • options - An object containing the following properties
    • short - Short code or url of album to be edited
    • title - New album title
    • description - New album description
    • files - Name or url of files to add to your album

Returns:    Promise<String> — The URL of the edited album

addFilesAlbum(options)

Add files to an album

  • options - An object containing the following properties
    • short - Album short code or url where files will be added
    • files - An array with the name or url of the files to add to the album

Returns:    Promise<String> — The URL of the album that was added to the files

removeFilesAlbum(options)

Remove one or more files from an album

  • options - An object containing the following properties
    • short - Album code or url from where files will be removed
    • files - An array with the name or url of the files to be removed from the album

Returns:    Promise<String> — The URL of the album from which the files were removed

deleteAlbum(short)

Delete album

  • short - Short code or url of album to be deleted

Returns:    Promise<String> — Success response

Install

npm i catbox.moe

DownloadsWeekly Downloads

0

Version

0.1.1

License

MIT

Unpacked Size

14.4 kB

Total Files

9

Last publish

Collaborators

  • avatar