Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cvyl/dishook

Simple Discord Webhook Wrapper written in TypeScript
https://github.com/cvyl/dishook

discord discord-api discord-api-wrapper discord-ts discord-typescript discord-webhook discord-webhook-api discord-webhooks

Last synced: 25 days ago
JSON representation

Simple Discord Webhook Wrapper written in TypeScript

Awesome Lists containing this project

README

        

# Welcome to @cvyl/dishook 👋
[![Version](https://img.shields.io/npm/v/@ly-nld/dishook.svg)](https://www.npmjs.com/package/@ly-nld/dishook)
[![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://lgbt.sh/dishook/)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/ly-nld/dishook/graphs/commit-activity)
[![License: MIT](https://img.shields.io/github/license/ly-nld/@ly-nld/dishook)](https://github.com/ly-nld/dishook/blob/master/LICENSE)

> Simple Discord Webhook Wrapper

### 🏠 [Homepage](https://github.com/cvyl/dishook)

## Install

```sh
npm install
```

## Run tests

```sh
npm run test
```

Example usage
```ts
import { Embed, Webhook } from '@ly-nld/dishook'

const hook = new Webhook('WEBHOOK_HERE')
const embed = new Embed()

embed
.setTitle('Hello, world!')
.setDescription('This is a description')
.setURL('https://google.com')
.setColor(0x00ff00)
.setFooter({
text: 'This is a footer',
icon_url: 'https://google.com',
})
.setTimestamp()
.addField({
name: 'Field 1',
value: 'Hello, world!',
inline: true,
})

hook.addEmbed(embed).send()

hook
.setTTS(true)
.setContent('Hello, world!')
.setUsername('Webhook')
.setAvatarUrl('https://google.com')
.send()
```
* Website: cvyl.me
* Github: [@cvyl](https://github.com/cvyl)
* Issues: [issues page](https://github.com/cvyl/dishook/issues).