Twitch Comment Downloader

Fetch comments for a given twitch vod

• 🎉 First class Typescript support
• 🚅 Faster than similar libraries
• 🌈 Returns the full unopinionated result
• 1️⃣ Single dependency
• 👌 Simple API

Table of Contents

• Install
• Usage
• Example
• Run Tests
• Author
• Contributing
• Support

Install

yarn add twitch-comment-downloader

npm install twitch-comment-downloader

Usage

There are example implementations for both javascript and typescript in the top level examples directory.

import { TwitchCommentDownloader } from "../../src/index";

const vodId = "524487996";

const clientId = "kimne78kx3ncx6brgo4mv6wki5h1ko";

const main = async (): Promise<void> => {

    // Instantiate twitch comment downloader
    const twitchCommentDownloader = new TwitchCommentDownloader(clientId);
    // Get all comments for a given vod id
    const comments = await twitchCommentDownloader.getComments(vodId);

    // Do something with the results
    for (const comment of comments) {
        const timestamp = new Date(comment.created_at).toISOString();
        const commenter = comment.commenter.display_name;
        const message = comment.message.body;
        console.log(`[${timestamp}] @${commenter} - ${message}`);
    }

    console.log(`Done fetching ${comments.length} comments from vod id: ${vodId}`);
};

main().catch((err) => console.error(err));

Example

More examples can be found in the examples directory.

➜ yarn example
$ ts-node example/index.ts

[2019-12-21T16:40:32.516Z] @cwestlove - Pog
[2019-12-21T16:41:18.824Z] @Nathz - HeyGuys
[2019-12-21T16:41:22.869Z] @RakinWar - Me
[2019-12-21T16:41:23.580Z] @huskaa - DADDY
[2019-12-21T16:41:25.185Z] @SBT_NoSKiLLZ - !sens
[2019-12-21T16:41:25.321Z] @Nightbot - 400 dpi - 0.092 X&Y // ADS: 0.50 // Scoped: 0.50
[2019-12-21T16:41:26.429Z] @caffeinne - !sens
[2019-12-21T16:41:27.063Z] @cwestlove - it was none of you
.
.
.
[2019-12-21T19:44:22.544Z] @purg3001 - hi
[2019-12-21T19:44:22.732Z] @cwestlove - <3

Done fetching 1456 comments from vod id: 524487996

Run tests

yarn test

Author

👤 Jarvis Prestidge [email protected]

• Site: https://jarvisprestidge.io
• Twitter: @jarvisprestidge
• Github: @jarvisprestidge
• LinkedIn: @jarvisprestidge

Contributing

Contributions, issues and feature requests are welcome!Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

This README was generated with ❤️ by readme-md-generator