# @suolun/verification-code

> A description for the module

Latest version **1.0.6** (published 2019-11-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @suolun/verification-code
pnpm add @suolun/verification-code
yarn add @suolun/verification-code
bun add @suolun/verification-code
```

## 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 | 1.0.6 |
| Published | 2019-11-20 |
| First published | 2019-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 17.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | sauron |
| Maintainers | suolun |
| Keywords | verification, code |

## Links

- npm: https://www.npmjs.com/package/@suolun/verification-code
- Repository: https://github.com/ZoomKing/verification-code
- Homepage: https://github.com/ZoomKing/verification-code#readme
- Issues: https://github.com/ZoomKing/verification-code.git
- npm.io page: https://npm.io/package/@suolun/verification-code

## Dependencies (2)

- [node-sass](https://npm.io/package/node-sass.md) ^4.13.0
- [rollup-plugin-postcss](https://npm.io/package/rollup-plugin-postcss.md) ^2.0.3

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 1.0.6 (latest) — 2019-11-20
- 1.0.5 — 2019-11-01
- 1.0.4 — 2019-11-01
- 1.0.3 — 2019-11-01
- 1.0.2 — 2019-11-01
- 1.0.1 — 2019-11-01

## README

# @suolun/verification-code
[![NPM Version](http://img.shields.io/npm/v/@suolun/verification-code.svg?style=flat-square)](https://www.npmjs.com/package/@suolun/verification-code)
[![Download Month](http://img.shields.io/npm/dm/@suolun/verification-code.svg?style=flat-square)](https://www.npmjs.com/package/@suolun/verification-code)
![gzip with dependencies: kb](https://img.shields.io/badge/gzip--with--dependencies-kb-brightgreen.svg "gzip with dependencies: kb")
![typescript](https://img.shields.io/badge/typescript-supported-blue.svg "typescript")
![pkg.module](https://img.shields.io/badge/pkg.module-supported-blue.svg "pkg.module")

> `pkg.module supported`, which means that you can apply tree-shaking in you project

[中文文档](./README-CN.md)

A description for the module

## repository


## Demo


## Run Example
Your can see the usage by run the example of the module, here is the step:

1. Clone the library `git clone `
2. Go to the directory `cd your-module-directory`
3. Install npm dependencies `npm i`(use taobao registry: `npm i --registry=http://registry.npm.taobao.org`)
4. Open service `npm run dev`
5. See the example(usually is `http://127.0.0.1/examples/test.html`) in your browser

## Installation
```bash
npm i -S @suolun/verification-code
```

## Global name - The variable the module exported in `umd` bundle
`VerificationCode`

## Interface
See what method or params you can use in [index.d.ts](./index.d.ts)

## Usage
```js
import * as VerificationCode from '@suolun/verification-code'
```

Use in html, see what your can use in [CDN: unpkg](https://unpkg.com/@suolun/verification-code/lib/umd/)
```html
<-- use what you want -->
<script src="https://unpkg.com/@suolun/verification-code/lib/umd/<--module-->.js"></script>
```

## style
For building style, you may need to import the css or scss file:
```js
// scss
import '@suolun/verification-code/lib/css/index.scss'

// css
import '@suolun/verification-code/lib/css/index.css'
```
Or
```scss
// scss
@import '@suolun/verification-code/lib/css/index.scss'

// css
@import '@suolun/verification-code/lib/css/index.css'
```

Or, you can build your custom style by copying, editing and importing `@suolun/verification-code/lib/css/index.scss`

## QA

1. Error `Error: spawn node-sass ENOENT`

> You may need install node-sass globally, `npm i -g node-sass`

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