User:KockaAdmiralac/nodewikia

nodewikia is a bot framework made specifically for Wikia endpoints, allowing creation of multiple modules for controlling all aspects of a wiki.

Features

 * Extensibility. The framework may not contain easily objects for each useful Wikia endpoint, but due to it's modular nature it's very easy to write a new module that contains methods for more Wikia endpoints
 * Validation. The framework knows what's supposed to be passed to the API and should tell the user when they enter something unexpected. This can be useful for easier code debugging
 * Secure login. The framework does not insecurely log in through api.php. Instead, it uses a secure login method through the Helios service

Installation
The framework can be installed from npm: npm install nodewikia

Usage
Using nodewikia begins with initializing your client: After initializing the client on one of the two above ways, you can call methods of its modules. The Client instance contains 3 modules:
 * mediawiki — MediaWiki API-related methods
 * ajax — Endpoints that are still using the deprecated action=ajax method

Each of the modules has submodules and each of the submodules has methods, as described in the section below.
 * services — New, service-oriented endpoints

Contributing
The framework is in development and if you want to implement new modules you can contribute to its code by submitting a pull request.