Negligent Pachinko Machine

    discord-html-transcripts-ahmed
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.1 • Public • Published

    Discord.js HTML Transcripts

    Discord

    Discord HTML Transcripts is a node.js module to generate nice looking HTML transcripts. Processes discord markdown like bold, italics, strikethroughs, and more. Nicely formats attachments and embeds. Built in XSS protection, preventing users from inserting html tags.

    This module is designed to work with discord.js v13.

    HTML Template stolen from DiscordChatExporter.

    Example Output

    output

    Usage

    Example usage using the built in message fetcher.

    const discordTranscripts = require('discord-html-transcripts');
    
    const channel = message.channel; // or however you get your TextChannel
    
    // Must be awaited
    const attachment = await discordTranscripts.createTranscript(channel);
    
    channel.send({
        files: [attachment]
    });

    Or if you prefer, you can pass in your own messages.

    const discordTranscripts = require('discord-html-transcripts');
    
    const messages = someWayToGetMessages(); // Must be Collection<string, Message> or Message[]
    const channel  = someWayToGetChannel();  // Used for ticket name, guild icon, and guild name
    
    // You do not need to await this
    const attachment = discordTranscripts.generateFromMessages(messages, channel);
    
    channel.send({
        files: [attachment]
    });

    Configuration

    Both methods of generating a transcript allow for an option object as the last parameter.

    Built in Message Fetcher

    const attachment = await createTranscript(channel, {
        limit: -1, // Max amount of messages to fetch.
        returnBuffer: false, // Return a buffer instead of a MessageAttachment 
        fileName: 'transcript.html' // Only valid with returnBuffer false. Name of attachment. 
    });

    Providing your own messages

    const attachment = await generateFromMessages(messages, channel, {
        returnBuffer: false, // Return a buffer instead of a MessageAttachment 
        fileName: 'transcript.html' // Only valid with returnBuffer false. Name of attachment. 
    });

    Install

    npm i discord-html-transcripts-ahmed

    DownloadsWeekly Downloads

    30

    Version

    1.1.1

    License

    GNU GPLv3

    Unpacked Size

    73.5 kB

    Total Files

    11

    Last publish

    Collaborators

    • ahmed_mondo