# z-convertx

> Library to perform conversions

Latest version **1.0.3** (published 2021-02-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install z-convertx
pnpm add z-convertx
yarn add z-convertx
bun add z-convertx
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-02-25 |
| First published | 2021-02-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 27.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Zul |
| Maintainers | rootzul |
| Keywords | converter, bits, bytes, ascii |

## Links

- npm: https://www.npmjs.com/package/z-convertx
- Repository: https://github.com/LuizHenriqueKS/z-convertx
- Homepage: https://github.com/LuizHenriqueKS/z-convertx#readme
- Issues: https://github.com/LuizHenriqueKS/z-convertx/issues
- npm.io page: https://npm.io/package/z-convertx

## Recent versions

- 1.0.3 (latest) — 2021-02-25
- 1.0.2 — 2021-02-15
- 1.0.1 — 2021-02-15
- 1.0.0 — 2021-02-15

## README

# z-convertx
Library to perform conversions

# Installation

```
npm i z-convertx
```

# Usage

## Javascript

```javascript
const convertx = require('z-convertx');
```

## Typescript

```typescript
import convertx from 'z-convertx';
```

# Summary 

[append](#append)
[appendStart](#appendStart)
[appendEnd](#appendEnd)
[convertTextToBits](#convertTextToBits)
[convertTextToBitsArray](#convertTextToBitsArray)
[convertTextToBitsMatrix](#convertTextToBitsMatrix)
[convertBitsMatrixToText](#convertBitsMatrixToText)
[convertBitsArrayToText](#convertBitsArrayToText)
[convertBitsToText](#convertBitsToText)
[convertNumberToBits](#convertNumberToBits)
[convertNumberToBitsArray](#convertNumberToBitsArray)
[convertNumberToBytesArray](#convertNumberToBytesArray)

# append

```typescript
function append(options: Options): string
```

Options:
```typescript
interface Options {
  text: string,
  pattern: string,
  maxLength: number,
  direction: Direction
}
```

# appendStart

```typescript
function appendStart(options: Options): string
```

Options:
```typescript
interface Options {
  pattern: string,
  text: string,
  maxLength: number
}
```

# appendEnd

```typescript
function appendEnd(options: Options): string
```

Options:
```typescript
interface Options {
  pattern: string;
  text: string;
  maxLength: number;
}
```

# convertTextToBits

```typescript
function convertTextToBits(text: string, options: Options = {}): string[]
```

Options:
```typescript
interface Options {
  bitsByChar?: number;
  maxLength?: number;
}
```

# convertTextToBitsArray

```typescript
function convertTextToBitsArray(text: string, options: Options = {}): string[]
```

Options:
```typescript
interface Options {
  bitsByChar?: number;
  maxLength?: number;
}
```

# convertTextToBitsMatrix

```typescript
function convertTextToBitsMatrix(text: string, options: Options = {}): number[][]
```

Options:
```typescript
interface Options {
  bitsByChar?: number;
  maxLength?: number;
}
```

# convertBitsMatrixToText

```typescript
function convertBitsMatrixToText(bits: number[][]): string
```

# convertBitsArrayToText

```typescript
function convertBitsArrayToText(bits: number[], bitsByChar: number): string
```

# convertBitsToText

```typescript
function convertBitsToText(bits: string[]): string
```

# convertNumberToBits

```typescript
function convertNumberToBits(num: number, options: Options = {}): string
```

Options:
```typescript
interface Options {
  maxLength?: number;
}
```

# convertNumberToBitsArray

```typescript
function convertNumberToBitsArray(num: number, options: Options = {}): number[]
```

Options:
```typescript
interface Options {
  maxLength?: number;
}
```

# convertNumberToBytesArray

```typescript
function convertNumberToBytesArray(num: number, options?: Options): number[]
```

Options:
```typescript
interface Options {
  maxLength?: number;
}
```

# convertNumberToBytesArray

```typescript
function convertBytesArrayToNumber(bytesArray: number[]): number
```

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