Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 1.32 KB

README.md

File metadata and controls

25 lines (22 loc) · 1.32 KB

MangaScrap's API

All of MangaScrap passes through the methods that are in the api directory
Here you can use MangaScrap directly to ( example ) build your own GUI or your own instruction
Please note that these methods are called from the argument parser witch is at ./sources/instructions/Instructions_exec.rb ( you will have to add the call to your instruction there and follow the directions there )

There are 4 files containing the API :

  • mangas.rb
    Allows you to manipulate the mangas database ( add / update / download / ... )
    methods: add, update, download, data, clear, delete
  • oher.rb
    contains any part of the API that could not be sorted as they are too small to justify having a file of their own
    methods: html
  • ouput.rb
    Reading from the database
    methods: details, output, help and version
  • params
    Configuring MangaScrap using it's parameters
    methods: get_params_list, set_param, reset_params

Important :
To manipulate mangas, MangaScrap uses the Manga_Data class witch you can find here : ./sources/DB/Manga_data.rb.
The class works by giving to it's constructor the name and site or the link and the calling the resolve method witch will return true or false depending on if it could find / use the given information.