# verify-discord

> A package used to verify actions of users

Latest version **1.0.0-beta.1** (published 2023-07-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install verify-discord
pnpm add verify-discord
yarn add verify-discord
bun add verify-discord
```

## 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.0-beta.1 |
| Published | 2023-07-16 |
| First published | 2023-07-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Sebastian Mostert |
| Maintainers | sebastian_mostert |
| Keywords | Discord.js, Verification, Discord Verification, Discord.JS V14 |

## Links

- npm: https://www.npmjs.com/package/verify-discord
- Repository: https://github.com/That-Half-Dead-Skeleton/discord-verification
- Homepage: https://github.com/That-Half-Dead-Skeleton/discord-verification#readme
- Issues: https://github.com/That-Half-Dead-Skeleton/discord-verification/issues
- npm.io page: https://npm.io/package/verify-discord

## Dependencies (1)

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

## Recent versions

- 1.0.0-beta.1 (latest) — 2023-07-16
- 1.0.0-beta.2 (beta) — 2023-07-24

## README

# Discord Verification

This package will help you create a simple verification system
## Usage & Examples
Here are some examples of the different functions.

The following functions are available:

1. Requiring the package
2. Starting the Verification process
3. The user entered a number
3. The user wants to retry
3. Verify the pin the user entered


### Requiring the package
```js
const Verification = require('discord-verification');

const verification = new Verification();
```

### Starting the verification process
The interaction provided **must** be a [Discord.JS ButtonInteraction!](https://discord.js.org/#/docs/main/stable/class/ButtonInteraction)

The interaction provided **must** be a [Discord.JS User!](https://discord.js.org/#/docs/main/stable/class/User)
```js
// Only needed if you want every user to have a different pin
// If you leave the function blank, a random pin will be made
await verification.verificationNewPin(NEW_PIN); 
await verification.verificationStart({ interaction, user })

```

### The user entered a number
The interaction provided **must** be a [Discord.JS ButtonInteraction!](https://discord.js.org/#/docs/main/stable/class/ButtonInteraction)
```js
await verification.verificationAddNumber({ interaction, number: THE_NUMBER_THE_USER_ENTERED})
```

### The user wants to retry
The interaction provided **must** be a [Discord.JS ButtonInteraction!](https://discord.js.org/#/docs/main/stable/class/ButtonInteraction)

The interaction provided **must** be a [Discord.JS User!](https://discord.js.org/#/docs/main/stable/class/User)
```js
await verification.verificationRetry({ interaction, user })
```

### Verify the pin the user entered
The interaction provided **must** be a [Discord.JS ButtonInteraction!](https://discord.js.org/#/docs/main/stable/class/ButtonInteraction)

The role provided **must** be a [Discord.JS Role!](https://discord.js.org/#/docs/main/stable/class/Role)
```js
await verification.verificationCheck({ interaction, role })
```

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