Lightweight and simple module to catbox.moe api management










Using this tool, you agree to the Catbox Terms of Service/Privacy Policy available here

- Installation
- Documentation
- Catbox
- Litterbox

Installation

``bash


with npm

$ npm install catbox.moe

or with Yarn

$ yarn add catbox.moe
`

Documentation

$3

`js
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

$3

- upload
- delete
- getAlbum
- createAlbum
- editAlbum
- addFilesAlbum
- removeFilesAlbum

#### upload(urlOrPath)
Upload files

- urlOrPath - A URL or path to the file

>Returns:    Promise<string>

#### delete(files)
Delete one or more files

- files - An array with the URL or short code of the files

>Returns:    Promise<string>

#### getAlbum(short)
Get album information

- short - Album short URL or code

>Returns:    Promise<Object>

#### 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 - Short code or files URL to add to album

>Returns:    Promise<string>

#### editAlbum(options)
Edit album info

- options - An object containing the following properties
- short - Album short code or URL
- title - New name for the album
- description - New description for the album
- files - Short code or files URL to add to album

>Returns:    Promise<string>

#### addFilesAlbum(options)
Add files to an album

- options - An object containing the following properties
- short - Album short code or URL
- files - An array with the short code or URL of files

>Returns:    Promise<string>

#### removeFilesAlbum(options)
Remove files from an album

- options - An object containing the following properties
- short - Album short code or URL
- files - An array with the short code or URL of files

>Returns:    Promise<string>

#### deleteAlbum(short)
Delete album

- short - Short code or album URL

>Returns:    Promise<[void]()>

$3

`js
new Catbox.Litterbox()
`

$3

- upload

#### upload(path[, time])
Upload file that will be available temporarily

- path - Relative path of the file to be uploaded
- time - Duration in hours for file expiration, default is 1h. (Allowed values are 1h, 12h, 24h, and 72h`)

>Returns:    Promise<string>