Highly efficient isomorphic implementation of Base64 string encoding and decoding. With the support of Unicode, and non-blocking execution via WebWorker. This library has 100% tests coverage, including speed tests.
- 100% tests coverage;
- Isomorphic, same API for Server and Browser;
- Blazing fast, see speed tests;
- Non-blocking browser experience, via WebWorkers;
- No external dependencies;
- Can replace default Meteor’s
base64package.
meteor add ostrio:base64import { Base64 } from 'meteor/ostrio:base64';Native code is disabled by default for Browser. Native code represented as atob, btoa (with extension to support Unicode) in a browser, and Buffer at NodeJS.
Although native code is 10x times faster, its support is enabled only on Server, as natively base64 encoding supports only ASCII symbols in a Browser. To enable native code – pass { useNative: true } in constructor:
import { Base64 } from 'meteor/ostrio:base64';
const nativeB64 = new Base64({ useNative: true });WebWorker is disabled by default, enable it with passing { allowWebWorker: true } in new Base64() constructor. Once enabled it will be used for all encode/decode calls with the callback. WebWorker is used only if supported by a browser, otherwise, it will fall-back to the main thread. In the real-world application WebWorker, usage will gain you extra FPS, and UI will act more smoothly.
base64Instance.encode(plainString [, callback]);import { Base64 } from 'meteor/ostrio:base64';
const base64 = new Base64();
base64.encode('My Plain String'); // Returns 'TXkgUGxhaW4gU3RyaW5n'
// Async, non-blocking via WebWorker (if supported) at browser:
base64.encode('My Plain String', (error, b64) => {
// b64 === 'TXkgUGxhaW4gU3RyaW5n'
});base64Instance.decode(base64EncodedString [, callback]);import { Base64 } from 'meteor/ostrio:base64';
const base64 = new Base64();
base64.decode('TXkgUGxhaW4gU3RyaW5n'); // Returns 'My Plain String'
// Async, non-blocking via WebWorker (if supported) at browser:
base64.decode('TXkgUGxhaW4gU3RyaW5n', (error, str) => {
// str === 'My Plain String'
});import { Base64 } from 'meteor/ostrio:base64';
new Base64({ allowWebWorker, useNative, supportNonASCII, ejsonCompatible });opts.allowWebWorker{Boolean} – Default:false. Use WebWorker in a Browser if available;opts.useNative{Boolean} – Default in Browser:false; Default on Server:true. Use nativeatob,btoaandBuffer.from, when available;opts.supportNonASCII{Boolean} – Default:true. Decreases speed, but gives support for whole utf-8 table;opts.ejsonCompatible{Boolean} – Default:false. Compatible mode with EJSON “binary” format,.encode()method will result as Uint8Array whenejsonCompatibleistrue.
import { Base64 } from 'meteor/ostrio:base64';
// Native with WebWorker
const nativeB64 = new Base64({ allowWebWorker: true, useNative: true });
// Native without WebWorker
const mtNativeB64 = new Base64({ allowWebWorker: false, useNative: true });
// Use main thread, no WebWorker
const mtB64 = new Base64({ allowWebWorker: false });- Download
base64-replacementpackage and place intometeor-app/packagesdirectory, that’s it. Runmeteor updateto make sure new package is applied; - In case of version incompatibility, change
base64-replacementversion, to the latest available on the mainstream channel; - For more info see
base64-replacementpackage
- Clone this package
- In Terminal (Console) go to directory where package is cloned
- Then run:
# Default
meteor test-packages ./
# With custom port
meteor test-packages ./ --port 8888Tests include synchronous, asynchronous and speed tests for Browser and NodeJS, for cases with/out the Native code and/or WebWorker usage.
- Become a patron — support my open source contributions with monthly donation
- Use ostr.io — Monitoring, Analytics, WebSec, Web-CRON and Pre-rendering for a website
https://github.com/veliovgroup/meteor-base64
