discord-together/types/index.d.ts

Play games or watch YouTube videos together on Discord! More than 22 games available!

import { Client } from 'discord.js';

declare class DiscordTogether<T extends {
    [x: string]: string;
}> {
    /**
     * Create a new YoutubeTogether
     * @param {Client} client Discord.Client
     * @param {T} applications
     * @example
     * const Discord = require('discord.js');
     * const client = new Discord.Client();
     * const { DiscordTogether } = require('discord-together');
     *
     * client.discordTogether = new DiscordTogether(client);
     *
     * client.on('message', async message => {
     *      if (message.content === 'start') {
     *          client.discordTogether.createTogetherCode(message.member.voice.channelID, 'skeatchheads').then(async invite => {
     *              return message.channel.send(`${invite.code}`);
     *           });
     *      };
     * });
     *
     * client.login('your token');
     */
    constructor(client: Client, applications?: T);
    /**
     * Discord.Client
     */
    client: string;
    applications: {
        youtube: string;
        youtubedev: string;
        poker: string;
        betrayal: string;
        fishing: string;
        chess: string;
        chessdev: string;
        lettertile: string;
        wordsnack: string;
        doodlecrew: string;
        awkword: string;
        spellcast: string;
        checkers: string;
        puttparty: string;
        sketchheads: string;
        ocho: string;
        puttpartyqa: string;
        sketchyartist: string;
        land: string;
        meme: string;
        askaway: string;
        bobble: string;
    } & T;
    /**
     * Create a Youtube Together invite code (note: send the invite using markdown link)
     * @param {string} voiceChannelId
     * @param {keyof (defaultApplications & T)} option
     * @example
     * client.on('message', async message => {
     *      if (message.content === 'start') {
     *          client.discordTogether.createTogetherCode(message.member.voice.channelID, 'skeatchheads').then(async invite => {
     *              return message.channel.send(`${invite.code}`); // Click the blue link
     *           });
     *      };
     * });
     * @returns {Promise<{ code: string; }>}
     */
    createTogetherCode(voiceChannelId: string, option: keyof ({
        youtube: string;
        youtubedev: string;
        poker: string;
        betrayal: string;
        fishing: string;
        chess: string;
        chessdev: string;
        lettertile: string;
        wordsnack: string;
        doodlecrew: string;
        awkword: string;
        spellcast: string;
        checkers: string;
        puttparty: string;
        sketchheads: string;
        ocho: string;
        puttpartyqa: string;
        sketchyartist: string;
        land: string;
        meme: string;
        askaway: string;
        bobble: string;
    } & T)): Promise<{
        code: string;
    }>;
}