https://github.com/robojones/charcoder

Convert numbers into different numeral systems and back
https://github.com/robojones/charcoder

character converter nodejs number numeral-systems string

Last synced: 23 days ago
JSON representation

Convert numbers into different numeral systems and back

• Host: GitHub
• URL: https://github.com/robojones/charcoder
• Owner: robojones
• License: mit
• Created: 2017-02-20T17:30:02.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-04T16:25:19.000Z (about 7 years ago)
• Last Synced: 2024-10-10T16:09:23.878Z (27 days ago)
• Topics: character, converter, nodejs, number, numeral-systems, string
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/charcoder
• Size: 27.3 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# charcoder

Convert numbers into different numeral systems and back

[![Build Status](https://travis-ci.org/robojones/charcoder.svg?branch=master)](https://travis-ci.org/robojones/charcoder)

[![Test Coverage](https://codeclimate.com/github/robojones/charcoder/badges/coverage.svg)](https://codeclimate.com/github/robojones/charcoder/coverage)

[![bitHound Code](https://www.bithound.io/github/robojones/charcoder/badges/code.svg)](https://www.bithound.io/github/robojones/charcoder)

[![bitHound Overall Score](https://www.bithound.io/github/robojones/charcoder/badges/score.svg)](https://www.bithound.io/github/robojones/charcoder)

[![bitHound Dependencies](https://www.bithound.io/github/robojones/charcoder/badges/dependencies.svg)](https://www.bithound.io/github/robojones/charcoder/master/dependencies/npm)

[![bitHound Dev Dependencies](https://www.bithound.io/github/robojones/charcoder/badges/devDependencies.svg)](https://www.bithound.io/github/robojones/charcoder/master/dependencies/npm)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Installation

```bash

npm i charcoder --save

```

## Usage

### Hexadecimal (0-9, a-f)

```javascript

const Charcoder = require('charcoder')

const hex = new Charcoder()

hex.encode(100) // '64'

hex.decode('64') // 100

```

### Duosexagesimal (0-9, a-f, A-F)

```javascript

const {

  Charcoder,

  B62

} = require('charcoder')

const b62 = new Charcoder(B62)

b62.encode(100) // '1C'

b62.decode('1C') // 100

```

### Custom

You can use any characters to create your own numeral system. For example `-`, `+` and the word `hey`.

```javascript

const Charcoder = require('charcode')

const custom = new Charcoder('-' + '+' + 'hey')

custom.encode(100) // 'y--'

custom.decode('y--') // 100

```

## Class: Charcoder

```javascript

const Charcoder = require('charcoder')

// or

const { Charcoder } = require('charcoder')

```

### constructor(charset)

- __charset__ `` string that includes the characters of your numeral system. (default: Charcoder.HEX)

```javascript

a = new Charcoder('hi' + 'baz')

a.charset // 'hibaz'

```

__Warning:__ Make sure that each character appears only once!

### #encode(number)

- __number__ `` number to convert

__returns__ a string representing the number in the numeral system of the Charcoder.

### #decode(string)

- __string__ `` string to convert

__returns__ a number representing the value of the given string.

### .NUM

A string that includes the numbers from 0 to 10.

```javascript

Charcoder.NUM // "0123456789"

```

### .ABC

The whole alphabet in lowercase.

```javascript

Charcoder.ABC // "abcdefghijklmnopqrstuvwxyz"

```

### .HEX

All characters of the hexadecimal system (0-9, a-f).

```javascript

Charcoder.HEX // "0123456789abcdef"

```

### .B62

All characters of the duosexagesimal system (0-9, a-f, A-F). The system consists of 62 characters.

```javascript

Charcoder.B62 // "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"

```