@kayahr/text-encoding/src/main/AbstractEncoder.ts

Text encoder and decoder

/*
 * Copyright (C) 2021 Klaus Reimer <k@ailis.de>
 * See LICENSE.md for licensing information.
 */

import { ByteBuffer } from "./ByteBuffer.js";
import { Encoder } from "./Encoder.js";

/**
 * Base class for encoders.
 */
export abstract class AbstractEncoder implements Encoder {
    /** @inheritDoc */
    public abstract encode(buffer: ByteBuffer): number | number[];

    /**
     * Fails the encoding by throwing an exception
     *
     * @param codePoint - The code point which could not be encoded.
     */
    protected fail(codePoint: number): never {
        throw TypeError(`The code point ${codePoint} could not be encoded`);
    }
}