{"id":22828698,"url":"https://github.com/busterc/x-base-32","last_synced_at":"2025-03-31T01:18:00.985Z","repository":{"id":57400713,"uuid":"124107599","full_name":"busterc/x-base-32","owner":"busterc","description":":symbols: base32 encoding and decoding that optimizes byte size based on input characters and supports unicode.","archived":false,"fork":false,"pushed_at":"2018-08-25T22:00:18.000Z","size":89,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-06T06:34:33.504Z","etag":null,"topics":["base32","base32hex","character-encoding","crockford-base32","encode","encoder","encoder-decoder","encoding","encoding-convertors","encoding-library","encodings","unicode-converter"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/busterc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-06T16:39:15.000Z","updated_at":"2023-09-08T17:37:34.000Z","dependencies_parsed_at":"2022-09-05T03:01:31.208Z","dependency_job_id":null,"html_url":"https://github.com/busterc/x-base-32","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/busterc%2Fx-base-32","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/busterc%2Fx-base-32/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/busterc%2Fx-base-32/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/busterc%2Fx-base-32/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/busterc","download_url":"https://codeload.github.com/busterc/x-base-32/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246399803,"owners_count":20770909,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["base32","base32hex","character-encoding","crockford-base32","encode","encoder","encoder-decoder","encoding","encoding-convertors","encoding-library","encodings","unicode-converter"],"created_at":"2024-12-12T19:11:40.384Z","updated_at":"2025-03-31T01:18:00.953Z","avatar_url":"https://github.com/busterc.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# x-base-32 [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]\n\n\u003e base32 encoding and decoding that optimizes byte size based on input characters and supports unicode.\n\n* [Online Demo](https://rawgit.com/busterc/x-base-32/master/demo.html)\n\n## Installation\n\n```sh\n$ npm install --save x-base-32\n```\n\n## Usage\n\n```js\nconst xBase32 = require('x-base-32');\n\nxBase32.decode(xBase32.encode('🦁🐯🐻'));\n// =\u003e 🦁🐯🐻\n\nxBase32.encode('Lions and tigers and bears!');\n// =\u003e 89hmpyvkk41gpws10ehmpesbjecg62vk441h6arbjecgg7\nxBase32.encode('אריות ונמרים ודובים!');\n// =\u003e bq8bt5v6xbfa0gbndw2xxf8qcvq842xbekqavmdv6xt116\nxBase32.encode('الأسود والنمور والدببة!');\n// =\u003e brkwh64f37j8rqg86932fj4s3che933210s4c9y8k2zh8rmca844b\nxBase32.encode('獅子，老虎和熊！');\n// =\u003e ged2npm7z1j0031jeaj6732qz047\nxBase32.encode('Львы и тигры и медведи!');\n// =\u003e bgdrk46a4p10gw0848a3h1kh08jr423g10gy8dc6j351ngt8e0445\nxBase32.encode('ライオンとトラとクマ！');\n// =\u003e g63mk191gn8rf6c3863431t9gd0rayc6yzw0gs\nxBase32.encode('🦁🐯🐻');\n// =\u003e gv0zdv0er7qe2zp1xvgxg3\n\n// Ignores invalid symbols during decoding\nxBase32.decode('gv0z-dv0e-r7qe-2zp1-xvgx-g3');\n// =\u003e 🦁🐯🐻\n```\n\n## Scheme Requirements\n\n* Humans can accurately transmit the symbols to other humans using a telephone.\n  * Only use numeric and lowercase alpha characters: `[0-9]`, `[a-h]`, `j`, `k`, `m`, `n`, `[p-t]`, `[v-z]`\n  * Re-map certain error-prone characters when they are provided for decoding:\n    ```\n    i -\u003e 1\n    I -\u003e 1\n    l -\u003e 1\n    L -\u003e 1\n    o -\u003e 0\n    O -\u003e 0\n    ```\n  * Ignore all other characters providing during decoding\n* [URI :: Path](https://tools.ietf.org/html/rfc3986#section-3.3) safe\n* Case Insensitive File System safe\n* Support the full 21-bit Unicode character set\n* Append a check digit for validating data integrity\n\n## TODO\n\n* [] Accept a `Buffer`\n* [x] Provide a [demo page](https://rawgit.com/busterc/x-base-32/master/demo.html)\n\n## License\n\nISC © [Buster Collings](https://about.me/buster)\n\n[npm-image]: https://badge.fury.io/js/x-base-32.svg\n[npm-url]: https://npmjs.org/package/x-base-32\n[travis-image]: https://travis-ci.org/busterc/x-base-32.svg?branch=master\n[travis-url]: https://travis-ci.org/busterc/x-base-32\n[daviddm-image]: https://david-dm.org/busterc/x-base-32.svg?theme=shields.io\n[daviddm-url]: https://david-dm.org/busterc/x-base-32\n[coveralls-image]: https://coveralls.io/repos/busterc/x-base-32/badge.svg\n[coveralls-url]: https://coveralls.io/r/busterc/x-base-32\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbusterc%2Fx-base-32","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbusterc%2Fx-base-32","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbusterc%2Fx-base-32/lists"}