exorift / syren

A suite to mock Discord interactions using Oceanic.JS

Syren

Syren is a small library to assist in testing expected interactions with the Discord API for things such as Discord bots or Discord bot frameworks

Example Test

import protoTest, { type TestFn } from 'ava'
import { spy, match } from 'sinon'
import { Client } from 'syren'
import { type TextChannel } from 'oceanic.js'

interface Context {
  client: Client
  channel: TextChannel
}

const test = protoTest as TestFn<Context>

test.before((t) => {
  t.context.client = new Client()
  t.context.channel = t.context.client.syren.createChannel()
})

test('ping command', async (t) => {
  const spy = spy(t.context.channel, 'createMessage')

  // register your ping command here
  // ...

  await t.context.client.syren.sendMessage({
    content: '!ping'
  })

  spy.calledWith(match({ content: 'Pong!' }))
})

NOTE: Syren is in a very early stage of development with limited capability. To add functionality, feel free to create a PR