// *****************************************************************************
// Copyright (C) 2019 Ericsson and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0.
//
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
// with the GNU Classpath Exception which is available at
// https://www.gnu.org/software/classpath/license.html.
//
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
// *****************************************************************************

import stream = require('stream');

/**
 * A Node stream like `/dev/null`.
 *
 * Writing goes to a black hole, reading returns `EOF`.
 */
export class DevNullStream extends stream.Duplex {

    constructor(options: {
        /**
         * Makes this stream call `destroy` on itself, emitting the `close` event.
         */
        autoDestroy?: boolean,
    } = {}) {
        super();
        if (options.autoDestroy) {
            this.destroy();
        }
    }

    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    override _write(chunk: any, encoding: string, callback: (err?: Error) => void): void {
        callback();
    }

    override _read(size: number): void {
        // eslint-disable-next-line no-null/no-null
        this.push(null);
    }
}
