# src-embeds

> An easy way to make embeds using discord.js

Latest version **1.0.3** (published 2021-07-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install src-embeds
pnpm add src-embeds
yarn add src-embeds
bun add src-embeds
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-07-12 |
| First published | 2021-07-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 15.x |
| Dependencies | 1 |
| Unpacked size | 3.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | madnessik |
| Keywords | discord.js, embed-maker, embeds, discord, embed, djs, src, src-embeds |

## Links

- npm: https://www.npmjs.com/package/src-embeds
- Repository: https://github.com/Madnesssik/src-embeds
- Homepage: https://github.com/Madnesssik/src-embeds#readme
- Issues: https://github.com/Madnesssik/src-embeds/issues
- npm.io page: https://npm.io/package/src-embeds

## Dependencies (1)

- [discord.js](https://npm.io/package/discord.js.md) ^12.5.3

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2021-07-12
- 1.0.2 — 2021-07-12
- 1.0.1 — 2021-07-12
- 1.0.0 — 2021-07-12

## README

<div align="center">
    <h1>src-embeds</h1>
    <p>
        <a href="https://www.npmjs.com/package/src-embeds"><img src="https://img.shields.io/npm/v/src-embeds?maxAge=3600" alt="NPM version" \></a>
        <a href="https://www.npmjs.com/package/src-embeds"><img src="https://img.shields.io/npm/dt/src-embeds?maxAge=3600" alt= "NPM download" \></a>
    </p>
    <p>
        <a href="https://www.npmjs.com/package/src-embeds"><img src="https://nodei.co/npm/src-embeds?downloads=true&stars=true" alt="NPM Banner" \></a>
    </p>
</div>

## 📂 | Installation
```sh
npm i src-embeds
```

## 📜 | Setup
```js
const Discord = require('discord.js');
const embeds = require('src-embeds');
```

## 📜 | Documentation
`embed(title, description, footer, color, timestamp);`
* `title` -> The title of the embed [String]()
* `description` -> The description of the embed [String]()
* `footer` -> The footer of the embed [String]()
* `color` -> The color of the embed [String]()
* `timestamp` -> The timestamp of the embed [Boolean]()

## ✍ | Example Usage

### Without Fields
```js
const Discord = require('discord.js');
const EmbedMaker = require('src-embeds');
const client = new Discord.Client();
client.embed = new EmbedMaker();

client.on('message', async message => {
    const myembed = new client.embed.make("This is my embed!", "This is my description!", "This is the footer", "#ffffff", true);
    message.channel.send({embed: myembed});
});
```

### With Fields
```js
const Discord = require('discord.js');
const EmbedMaker = require('src-embeds');
const client = new Discord.Client();
client.embed = new EmbedMaker();

client.on('message', async message => {
    const myembed = new client.embed.make("This is my embed!", "This is my description!", "This is the footer", "#ffffff", true).addField("This is the field name", "This is the field description", true);
    message.channel.send({embed: myembed});
});
```

## 👥 | Contact
<a href="https://discord.gg/5JtyYqW"><img src="https://discord.com/api/guilds/748098690874474567/widget.png?style=banner1"></a>

---
_Source: https://npm.io/package/src-embeds · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._