# @irony0901/format

> format functions

Latest version **0.1.3** (published 2022-10-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @irony0901/format
pnpm add @irony0901/format
yarn add @irony0901/format
bun add @irony0901/format
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2022-10-07 |
| First published | 2022-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 85.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | irony19 |
| Maintainers | irony19 |
| Keywords | uniqueKey, uuid, digit, dataSize, hide, equals, compare, mask, tel format |

## Links

- npm: https://www.npmjs.com/package/@irony0901/format
- Repository: https://github.com/irony1090/irony-format
- Homepage: https://github.com/irony1090/irony-format#readme
- Issues: https://github.com/irony1090/irony-format/issues
- npm.io page: https://npm.io/package/@irony0901/format

## Dependencies (1)

- [uuid](https://npm.io/package/uuid.md) ^8.3.2

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.1.3 (latest) — 2022-10-07
- 0.1.2 — 2022-08-16
- 0.1.1 — 2022-08-16
- 0.1.0 — 2022-07-21
- 0.0.8-TEST — 2022-07-21
- 0.0.8 — 2022-07-20
- 0.0.7 — 2022-07-20
- 0.0.6 — 2022-07-20
- 0.0.5 — 2022-07-20
- 0.0.4 — 2022-07-20
- 0.0.3 — 2022-07-19
- 0.0.2 — 2022-07-19
- 0.0.1 — 2022-07-19

## README

## irony Format
---
### My collection of useful JavaScript utilities.
## Features
* Typescript
* Steady update

# Download
To install ironyFormat, use yarn
```
$ yarn add @irony0901/format
```
## Methods
* [createUuid](#createUuid)
* [numberTodataSize](#numberTodataSize)
* [hideText](#hideText)
* [equals](#equals)
* [parseTel](#parseTel) **deprecated**. (Use **[this](https://github.com/irony1090/dynamic-text-mask)** instead)

## createUuid
### createUuid( option: CreateUuidOption )
---
#### CreateUuidOption
- length: number   
  The number of letters of the output
- prefix?: string   
  The prefix of the output
- suffix?: string   
  The suffix of the output
---
**Examples**
``` javascript
import { createUuid } from '@irony0901/format';

const example_1 = createUuid({ length: 24 });
const example_2 = createUuid({ length: 24, prefix: 'PRODUCT-' });
const example_3 = createUuid({ length: 24, suffix: ':USER' });
const example_4 = createUuid({ length: 24, prefix: 'PRODUCT-', suffix: ':USER' });
const example_5 = createUuid({ length: 3, prefix: 'PRODUCT-' });
const example_6 = createUuid({ length: 3, suffix: ':USER' });

console.log( example_1 ) // '4b0ab5ca4c2940a08002ce3c' **length is 24**
console.log( example_2 ) // 'PRODUCT-02ebdf8ff8a54862' **length is 24**
console.log( example_3 ) // 'PRODUCT-643082bba30:USER' **length is 24**
console.log( example_4 ) // '3fa6219b5290474392b:USER' **length is 24**
console.log( example_5 ) // 'PRO' **length is 3**
console.log( example_6 ) // ':US' **length is 3**

```

## numberTodataSize
### numberTodataSize( size: number )
**Examples**
``` javascript
import { numberTodataSize } from '@irony0901/format';

const kbSize = 1024;
const mbSize = kbSize * 1024;
const gbSize = mbSize * 1024;
const tbSize = gbSize * 1024;
const pbSize = tbSize * 1024;
const exceed = pbSize * 1024;

console.log( numberTodataSize(kbSize) ) // '1.00 KB'
console.log( numberTodataSize(mbSize) ) // '1.00 MB'
console.log( numberTodataSize(gbSize) ) // '1.00 GB'
console.log( numberTodataSize(tbSize) ) // '1.00 TB'
console.log( numberTodataSize(pbSize) ) // '1.00 PB'
console.log( numberTodataSize(exceed) ) // '1024.00 PB'

```

## hideText
### hideText( option: HideTextOption )
---
#### HideTextOption
- text: string   
  Input string
- excludeLength: number   
  String numbers that will not be erased
- start?: 'left'|'right'   
  Starting cursor position.  
  default value 'left'
- hideChar?: string   
  Characters to replace
---
**Examples**
``` javascript
import { hideText } from '@irony0901/format';

const text = 'PRODUCT-02ebdf8ff8a54862'
console.log( hideText({ text, excludeLength: 8 }) )  // 'PRODUCT-________________'
console.log( hideText({ text, hideChar: '*', excludeLength: 8 }) ) // 'PRODUCT-****************'
console.log( hideText({ text, hideChar: '#', start: 'right', excludeLength: 8 }) ) // '################f8a54862'
```

## equals
### equals( a: any, b: any )
---
**Examples**
``` javascript
import { equals } from '@irony0901/format';

const objA = { id: 1, name: 'irony' }
const objB = { id: 1, name: 'irony' }
const objC = { name: 'irony', id: 1 }
const arrA = [ 1, 2, 3 ]
const arrB = [ 1, 2, 3 ]
const arrC = [ 3, 2, 1 ]

console.log( objA === objB ) // objA and objB is false
console.log( JSON.stringify(objA) === JSON.stringify(objB) ) // objA and objB is true
console.log( JSON.stringify(objA) === JSON.stringify(objC) ) // objA and objC is false
console.log( equals(objA, objC) ) // objA and objC is true
console.log( equals(arrA, arrB) ) // arrA and arrB is true
console.log( equals(arrA, arrC) ) // arrA and arrC is false
console.log( equals(1, 1) ) // is true
console.log( equals(1, '1') ) // is false

```

## parseTel
### Use [this](https://github.com/irony1090/dynamic-text-mask) instead


## License
[MIT](LICENSE)

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