# whattodraw

> Random drawing suggestion

Latest version **1.1.0** (published 2021-09-29) · ISC license · 0 weekly downloads

## Install

```sh
npm install whattodraw
pnpm add whattodraw
yarn add whattodraw
bun add whattodraw
```

Provides the command `whattodraw`.

## 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.1.0 |
| Published | 2021-09-29 |
| First published | 2021-09-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 36 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ilya Soloveychik |
| Maintainers | thesiv95 |
| Keywords | draw, random, generator |

## Links

- npm: https://www.npmjs.com/package/whattodraw
- Repository: https://github.com/thesiv95/whattodraw
- Issues: https://github.com/thesiv95/whattodraw/issues
- npm.io page: https://npm.io/package/whattodraw

## Recent versions

- 1.1.0 (latest) — 2021-09-29
- 1.0.0 — 2021-09-29

## README

# What to draw

## Meta information
* This is the random description generator inspired by https://whattodraw.virink.com
* Can be used as a real draw suggestion or as a fake string generator
* All suggestion rights belong to https://whattodraw.virink.com creators
* *Warning*: some suggestions could be **NSFW**. Author is **not responsible** for this!

## Type
CommonJS module for better compatibility

# How to use
* Import whattodraw module:
```javascript
const whatToDraw = require('whattodraw'); // CommonJS syntax
// or
import whatToDraw from 'whattodraw'; // ES6 module syntax
```

* Call `whatToDraw()` instance:
```javascript
whatToDraw();
```
* This function accept one optional parameter - items (how many suggestions should be returned), e.g.:
```javascript
whatToDraw(5); // ['suggestion1', ..., 'suggestion5']
```
* Parameter could not be NaN type or less than 1

# Author
(c) Ilya Soloveychik, 2021

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