# korean-syllable

> get a any string

Latest version **0.0.5** (published 2023-07-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install korean-syllable
pnpm add korean-syllable
yarn add korean-syllable
bun add korean-syllable
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2023-07-18 |
| First published | 2023-07-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jace |
| Maintainers | jacealan |

## Links

- npm: https://www.npmjs.com/package/korean-syllable
- npm.io page: https://npm.io/package/korean-syllable

## Recent versions

- 0.0.5 (latest) — 2023-07-18
- 0.0.4 — 2023-07-15
- 0.0.3 — 2023-07-15
- 0.0.2 — 2023-07-15
- 0.0.1 — 2023-07-15

## README

# Korean-Syllable: 한글 음절 생성기

## This module was moved [@jacepkg/korean](https://www.npmjs.com/package/@jacepkg/korean)

Korean-Syllable is the module that make any korean syllable.

- github: https://github.com/jacealan/korean-syllable
- npm: https://www.npmjs.com/package/korean-syllable

# Installation

```shell
npm install korea-syllable
```

# Usage

## Importing Korean-Syllable

```js
import { koreanSyllable } from "korean-syllable"
```

## Making any korean syllable(s)

### 1 syllable

```ts
const ex: string = koreanSyllable()
console.log(ex) // 촒
```

### more syllables

```ts
const length: number = 10
const ex: string = koreanSyllable(length)
console.log(ex) // 줩뇅쳱펻뻘껨즰쌍쉁뺼죓
```

`length` is the length of syllables

### with space

```ts
const length: number = 10
const withspace: boolean = true
const ex: string = koreanSyllable(length, withspace)
console.log(ex) // 둎찍굍 뺍푡롁 쯚럔
```

### parameters

- length, withspace가 없으면 한 음절 생성
- withspace가 없거나 false면 공백 없이 원하는 길이의 음절 생성

### at node console

```sh
$ node
Welcome to Node.js v16.13.1.
Type ".help" for more information.
> const { koreanSyllable } = require("korean-syllable")
undefined
> koreanSyllable()
'휒'
> koreanSyllable(30)
'잂쬦룁캩탧릝쾹뭧퍱툾뛺땃뙾묧밟궯턉짋깖눅튰뇎깦쳟퐢옭헠힜솾뱬'
> koreanSyllable(30, true)
'녂퀘궠뮇 톫륂쥢뉓뎋맘 쁗푋혌잞 셇뛅듵놸 튚쯯 횓왒캔롛깴'
>
```

## references

- https://github.com/pengooseDev/goose
- https://ko.wikipedia.org/wiki/%ED%95%9C%EA%B8%80_%EC%9D%8C%EC%A0%88
- https://jsikim1.tistory.com/161
- https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Global_Objects/Math/random

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