Skip to content

Wrapper for managing the kyouko.se api in simple and sane

License

Notifications You must be signed in to change notification settings

tentaclenotsoft/node-kyouko

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kyouko

Wrapper for managing the kyouko.se api in simple and sane

NPM Version NPM Bundle Size Dependencies License

Installation

# with npm
$ npm install kyouko

# or with Yarn
$ yarn add kyouko

Documentation

Kyouko(token)

new Kyouko(token)
  • token - The your api key to perform operations on the service

upload(path)

Upload file

  • path - Relative or absolute file path

Returns:    Promise<Object>

delete(id)

Delete file

  • id - File identification number

Returns:    Promise<Object>

files()

Gets all your files sent

Returns:    Promise<Object>

me()

Details about user

Returns:    Promise<Object>

createAlbum(name)

Create a new album

  • name - Name for the album

Returns:    Promise<Object>

deleteAlbum(id)

Delete a exists album

  • id - Album identification number

Returns:    Promise<Object>

albums()

Get information from all your albums

Returns:    Promise<Object>

addFileAlbum(albumID, fileID)

Add a file to an album

  • albumID - Album identification number
  • fileID - File identification number

Returns:    Promise<Object>

removeFileAlbum(albumID, fileID)

Remove a file from an album

  • albumID - Album identification number
  • fileID - File identification number

Returns:    Promise<Object>

About

Wrapper for managing the kyouko.se api in simple and sane

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published