matrix-js-sdk/src/models/base-model.ts

Matrix Client-Server SDK for Javascript

/*
Copyright 2021 The Matrix.org Foundation C.I.C.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import { EventEmitter } from "events";

/**
 * Typed Event Emitter class which can act as a Base Model for all our model
 * and communication events.
 * This makes it much easier for us to distinguish between events, as we now need
 * to properly type this, so that our events are not stringly-based and prone
 * to silly typos.
 */
export abstract class BaseModel<Events extends string> extends EventEmitter {
    public on(event: Events, listener: (...args: any[]) => void): this {
        super.on(event, listener);
        return this;
    }

    public once(event: Events, listener: (...args: any[]) => void): this {
        super.once(event, listener);
        return this;
    }

    public off(event: Events, listener: (...args: any[]) => void): this {
        super.off(event, listener);
        return this;
    }

    public addListener(event: Events, listener: (...args: any[]) => void): this {
        super.addListener(event, listener);
        return this;
    }

    public removeListener(event: Events, listener: (...args: any[]) => void): this {
        super.removeListener(event, listener);
        return this;
    }
}