Neurophysiologically Pseudoscientific Manatee
Have ideas to improve npm?Join in the discussion! »

amino
TypeScript icon, indicating that this package has built-in type declarations

3.0.5 • Public • Published

Amino

Discord Banner 2

Discord Shield Size Downloads


An API wrapper around the Amino app.

Features

Chat:

  • Message Events
  • Join / Leave Events
  • Sending text-messages
  • Sending image-messages
  • Thread & DM support

Utility:

  • Thread Searching
  • Community Searching

Classes & Documentation:

Examples:

Search for a community's id

import * as Amino from "amino";

// Uses default 'g' community if none is specified
const client = new Amino.Client();

client.login("myEmail@gmail.com", "myAccountsPassword")
.then(async () => {
    const overwatchAmino = await client.searchCommunities("overwatch")[0]
    console.log(overwatchAmino.ndcId); // Pull the community ID
})

Start a chatbot on a community:

import * as Amino from "amino";

// Furry Amino's ID (235196899)
const client = new Amino.Client("235196899")

client.login("myEmail@gmail.com", "myAccountsPassword")
.then(() => {
    // Start the websocket listener
    // This is optional if you don't want to use chat features.
    client.listen()
})

client.on("message", async (message) => {
    if (message.content == "!ping") {
        await message.reply(`${message.author.nickname}, Pong!`)
    }
})

Contribution & Requests

Requests

Enjoying the library? Good! Have something you want to see in it? Awesome! Please make a new issue in the github repository, and I'll get to it promptly!

There's still a lot of things I need to add, so if something's important to you, I'll put it at the top of my amino to-do list!

I need help!

Okay, join my discord and I can help you with any issue. The discord is at the top of the ReadMe.

Contribution Guidelines

  • All pull requests must provide valid reason for the change / implementation
  • All CORE CHANGES require an issue made before the PR will be looked at
  • All PR's must follow the general structure of this code base.
  • New structures must be defined similarely to how they are in the ./src/structs directory, with the typings below the class.
  • If you have any questions, feel free to make an issue and i'll answer asap!

If you enjoy my projects and have a few dollars to spare, buy me a coffee!
Buy Me A Coffee

Keywords

none

Install

npm i amino

DownloadsWeekly Downloads

237

Version

3.0.5

License

ISC

Unpacked Size

67.9 kB

Total Files

64

Last publish

Collaborators

  • avatar