ensure-string v1.2.0

ensure-string

If required, convert the input value to a string.

The input value may be a Buffer, ArrayBuffer, Int8Array.

By default the conversion will consider that the text encoding is utf-8. If the file contains an UTF-16 byte-order mark (BOM), this will be detected and default to utf-16le or utf-16be accordingly.

If the input value is a text, no change is done. The method returns the value without further processing.

Installation

$ npm i ensure-string

Usage

We have a text.txt file containing the string ABC.

import { ensureString } from '..';
import { readFileSync } from 'fs';
import { join } from 'path';
const blob = readFileSync(join(__dirname, 'test.txt')); // read the file as an ArrayBuffer
const text = ensureString(blob);
console.log(text); // the text is a string containing ÀBC`

API Documentation

License

MIT