# discord-osiris

> Judges suspicious Discord links

Latest version **2.0.2** (published 2022-07-18) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2022-07-18 |
| First published | 2022-07-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | unai01 |

## Links

- npm: https://www.npmjs.com/package/discord-osiris
- Repository: https://github.com/owlnai/discord-osiris
- Homepage: https://github.com/owlnai/discord-osiris#readme
- Issues: https://github.com/owlnai/discord-osiris/issues
- npm.io page: https://npm.io/package/discord-osiris

## Recent versions

- 2.0.2 (latest) — 2022-07-18
- 2.0.0 — 2022-07-18
- 1.0.2 — 2022-07-16

## README

# Osiris ⚖️
> NOTE: THIS IS STILL A **WORK IN PROGRESS**
Judges dangerous Discord links
## Features
- Fully-typed with TypeScript ✨
- Promise-based RegEx matching 📐
- Can detect multiple links 🔄️
- Optimized for speed (~3ms per string) 🚀
## Usage
```JavaScript
import { checkString, regexes } from 'discord-osiris'

const susMessage = "Hello don't click on this link, it's dangerous! https://dlscord-egfits.com/fromsteamnitro"

checkString(susMessage, regexes).then(console.log) // true
```

### Extend patterns
The second parameter of checkString (`patterns`) accepts an array of either RegExp or strings. You can pass your own array and/or extend the current configuration.

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