Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hywax/muuto
Word generator in ikea language
https://github.com/hywax/muuto
generator ikea language
Last synced: 3 days ago
JSON representation
Word generator in ikea language
- Host: GitHub
- URL: https://github.com/hywax/muuto
- Owner: hywax
- License: mit
- Created: 2023-11-16T17:05:27.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-13T19:02:54.000Z (7 months ago)
- Last Synced: 2024-04-14T09:45:30.287Z (7 months ago)
- Topics: generator, ikea, language
- Language: TypeScript
- Homepage: https://hywax.space/projects/muuto
- Size: 223 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://hywax.space/muuto)
# Muuto
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]
Word generator in ikea language.
## Installation
```bash
# Using pnpm
pnpm add muuto
# Using yarn
yarn add muuto
# Using npm
npm install muuto
```
## Usage
```ts
import muuto from 'muuto'
const name = muuto() // Vaöy
```
or use with params:
```ts
import muuto from 'muuto'
const name = muuto(7, 8) // Musvövmo
```
### API
**Signature:**
```ts
declare function mutto(min: number = 3, max: number = 9): string
```
**Params:**
| **Key** | **Type** | **Default** | **Description** |
|---------|----------|-------------|--------------------|
| `min` | `number` | 3 | Min length of word |
| `max` | `number` | 9 | Max length of word |
[npm-version-src]: https://img.shields.io/npm/v/muuto/latest.svg
[npm-version-href]: https://npmjs.com/package/muuto
[npm-downloads-src]: https://img.shields.io/npm/dt/muuto.svg
[npm-downloads-href]: https://npmjs.com/package/muuto
[github-actions-ci-src]: https://github.com/hywax/muuto/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/hywax/muuto/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/github/hywax/muuto.svg
[codecov-href]: https://codecov.io/gh/hywax/muuto
[license-src]: https://img.shields.io/npm/l/muuto.svg
[license-href]: https://npmjs.com/package/muuto