Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Badges

Join our Discord MIT License View package on npm Star project on GitHub

Introduction

  • This package lets you get the game user database, providing you the user ID and their game score.

List of functions

- getAll()
- getUser(id)
- getCount()

Please note that the id is a Discord user snowflake.

Installation

Install the module with your terminal/console using:

npm i avoidapi

Defining the module in your code:

  • CommonJS:
    const avoid = require("avoidapi");
    
  • ES:
    import avoid from "avoidapi/index.mjs";
    

Examples

/**
 * Logs everything in the game database.
 */
console.log(avoid.getAll());
/**
 * Logs the user data in the game database.
 */
console.log(avoid.getUser(id));
/**
 * Logs the user count in the game database.
 */
console.log(avoid.getCount());

Links

NPM: https://www.npmjs.com/package/avoidapi
Discord: https://discord.gg/fxstudios

License

This project is licensed under MIT License.

Copyright (c) 2019 FX Studios

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A simple score API for the Discord game, Avoid.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages