https://github.com/craftzdog/react-native-quick-base64

A fast base64 module for React Native
https://github.com/craftzdog/react-native-quick-base64

react-native

Last synced: 14 days ago
JSON representation

A fast base64 module for React Native

• Host: GitHub
• URL: https://github.com/craftzdog/react-native-quick-base64
• Owner: craftzdog
• License: mit
• Created: 2021-02-05T05:28:56.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-25T13:24:34.000Z (7 months ago)
• Last Synced: 2024-10-12T22:16:49.084Z (about 1 month ago)
• Topics: react-native
• Language: TypeScript
• Homepage:
• Size: 2.51 MB
• Stars: 362
• Watchers: 3
• Forks: 24
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - react-native-quick-base64

README

        
# react-native-quick-base64

A native implementation of Base64 in C++ for React Native.

~16x faster than [base64-js](https://github.com/beatgammit/base64-js) on an iPhone 15 Pro Max simulator.

Try the benchmarks under [example](./example).

| iPhone                                            | Android                                             |

| ------------------------------------------------- | --------------------------------------------------- |

| ![iPhone](./docs/iphone-15-pro-max-simulator.png) | ![Android](./docs/android-pixel-6-pro-emulator.png) |

## Installation

```sh

npm install react-native-quick-base64

```

## Usage

```js

import { btoa, atob } from 'react-native-quick-base64'

const base64 = btoa('foo')

const decoded = atob(base64)

```

## Methods

Compatible with [base64-js](https://github.com/beatgammit/base64-js).

#### `byteLength(b64: string): number`

Takes a base64 string and returns length of byte array.

#### `toByteArray(b64: string, removeLinebreaks: boolean = false): Uint8Array`

Takes a base64 string and returns a byte array. Optional `removeLinebreaks` removes all `\n` characters.

#### `fromByteArray(uint8: Uint8Array, urlSafe: boolean = false): string`

Takes a byte array and returns a base64 string. Optional `urlSafe` flag `true` will use [the URL-safe dictionary](https://github.com/craftzdog/react-native-quick-base64/blob/9d02dfd02599ca104d2ed6c1e2d938ddd9d6cd15/cpp/base64.h#L75).

#### `btoa(data: string): string`

Encodes a string in base64.

#### `atob(b64: string): string`

Decodes a base64 encoded string.

#### `shim()`

Adds `btoa` and `atob` functions to `global`.

#### `trimBase64Padding = (str: string): string`

Trims the `=` padding character(s) off of the end of a base64 encoded string. Also, for base64url encoded strings, it will trim off the trailing `.` character(s).

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

MIT by Takuya Matsuyama