About

Kient (Kick-Client) is a versatile TypeScript client designed to simplify interaction with Kick's API and WebSocket. With Kient, you can seamlessly integrate Kick's platform into your projects, making it easier than ever to leverage its capabilities.

Documentation

Learn how to use Kient and find detailed information on the website.

Installation and Example Usage

Install Kient with your preferred package manager.

$ pnpm add kient

Import Kient, create a new instance, and interact with API endpoints or listen to WebSocket events.

import { Events, Kient } from 'kient'

// Create a new client instance
const client = await Kient.create()

// Get a channel and listen to its chatroom
const channel = await client.api.channel.getChannel('channel_slug')
await client.ws.chatroom.listen(channel.data.chatroom.id)

// Handle incoming messages
client.on(Events.Chatroom.Message, (message) => {
  console.log(message.data)
})

License

Kient is licensed under the MIT License.