Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 2.5 KB

README.md

File metadata and controls

62 lines (38 loc) · 2.5 KB

License: MIT Contributor Covenant JavaScript Style Guide Node.js CI Coverage Status

@juanelas/base64

Base64 for both node.js and browser javascript. It supports URL-safe encoding and enabling/disabling padding. Buffers can be implementedd using ArrayBuffer, any TypedArray, or Buffer.

Usage

@juanelas/base64 can be imported to your project with npm:

npm install @juanelas/base64

Then either require (Node.js CJS):

const base64 = require('@juanelas/base64')

or import (JavaScript ES module):

import * as base64 from '@juanelas/base64'

The appropriate version for browser or node is automatically exported. Types for TypeScript users are also provided.

You can also download the IIFE bundle, the ESM bundle or the UMD bundle and manually add it to your project, or, if you have already installed @juanelas/base64 in your project, just get the bundles from node_modules/@juanelas/base64/dist/bundles/.

An example of usage could be:

import * as base64 from '@juanelas/base64'

const buf = new Uint8Array([254, 1, 128, 255])
const base64str = base64.encode(buf, true, false) // URL-safe base64 with no padding

console.log(base64str) // Outputs: '_gGA_w'

const buf2 = base64.decode(base64str) // URL-safe encoding and padding are automatically detected

console.log(buf2.toString()) // Outputs: '254,1,128,255'

const text = 'fooba'
const base64str2 = base64.encode(text) // Standard base64 with padding

console.log(base64str2) // Outputs: 'Zm9vYmE='

const text2 = base64.decode(base64str2, true) // Output to unicode string instead of Uint8Array

console.log(text2) // Outputs: 'fooba'

API reference documentation

Check the API