SOT Buffer Module

library to handle base64 encryption, which allows to encode, decode and know if a value is encoded.

Quick Start

Installation

In sot_pages repo

npm run package-setup install @sot/buffer <Page-Path>

Regular repo

npm install @sot/buffer

Importing

ES Modules

import { isEncoded, encode, decode } from '@sot/buffer/dist/js';

NOTE: This type of import will enable SOT_Pages WP to perform tree shaking, effectively eliminating any unused code.

Included Directly

If you want to use the library on a page that doesn't have a build environment, you can directly copy the index.js in the dist folder (you can change the name to sot-buffer.min.js) file into the vendors folder on the page to use and import it in the HTML as:

<script src="js/vendors/sot-buffer.min.js"></script>

Usage

Please refer to the documentation page for the Buffer on Backstage to see how to use the library or check the next examples:

• isEncoded: Returns true is the value is in Base64

isEncoded('dGVzdDEyMzQ='); // returns true

• encode: Encodes the value to Base64

encode('test1234'); // return 'dGVzdDEyMzQ='

• decode: Decodes the value from Base64

decode('dGVzdDEyMzQ='); // return 'test1234'

Contributing

To contribute, follow the instructions in the main sot_components readme at https://github.com/ltvco/sot_components.