Method constructor

modules/esm/_encoding/encoding.js:38–79

* @param {string} encoding The encoding to decode into * @param {object} [options] Decoding options * @param {boolean=} options.fatal Whether to throw or substitute when invalid characters are encountered * @param {boolean=} options.ignoreBOM Whether to ignore the byte order for UTF-8

(encoding = 'utf-8', options = {})

     * @param {boolean=} options.ignoreBOM Whether to ignore the byte order for UTF-8 arrays
     */
    constructor(encoding = 'utf-8', options = {}) {
        const {fatal = false, ignoreBOM = false} = options;

        const encodingDefinition = getEncodingFromLabel(`${encoding}`);

        if (!encodingDefinition)
            throw new RangeError(`Invalid encoding label: '${encoding}'`);

        if (encodingDefinition.label === 'replacement') {
            throw new RangeError(
                `Unsupported replacement encoding: '${encoding}'`
            );
        }

        Object.defineProperty(this, '_internalEncoding', {
            value: encodingDefinition.internalLabel,
            enumerable: false,
            writable: false,
            configurable: false,
        });

        Object.defineProperty(this, 'encoding', {
            value: encodingDefinition.label,
            enumerable: true,
            writable: false,
            configurable: false,
        });

        Object.defineProperty(this, 'ignoreBOM', {
            value: Boolean(ignoreBOM),
            enumerable: true,
            writable: false,
            configurable: false,
        });

        Object.defineProperty(this, 'fatal', {
            value: Boolean(fatal),
            enumerable: true,
            writable: false,
            configurable: false,
        });
    }

    /**
     * @param {unknown} bytes a typed array of bytes to decode