@robotlegsjs/pixi-signalmediator

v4.0.0

Published

2 years ago

TypeScript port of Robotlegs Extension SignalMediator

Downloads

0High
0Medium
0Low

tschenkel

endel

ronaldosetzer

TypeScript Robotlegs IoC Pixi

RobotlegsJS Pixi SignalMediator Extension

A port of Robotlegs SignalMediator Extension to TypeScript.

Originally published on RobotlegsJS-SignalMediator.

Installation

You can get the latest release and the type definitions using NPM:

npm install @robotlegsjs/pixi-signalmediator --save

Or using Yarn:

yarn add @robotlegsjs/pixi-signalmediator

From version 0.2.0 of this package, the PixiJS dependencies were moved to peerDependencies, allowing the final user to choose the desired version of the pixi.js library on each project.

For `pixi.js` version 6

The @robotlegsjs/pixi-signalmediator package version ^4.0.0 is compatible with versions >=6.0.0 <7 version range of pixi.js library.

You can setup your project for version 6 of pixi.js using:

npm install @robotlegsjs/pixi-signalmediator@^4.0.0 pixi.js@^6.0.0 --save

yarn add @robotlegsjs/pixi-signalmediator@^4.0.0 pixi.js@^6.0.0

For `pixi.js` version 5

The @robotlegsjs/pixi-signalmediator package versions ^2.0.0 and ^3.0.0 are compatible with versions >=5.0.0 <6 version range of pixi.js library.

Since version 5.0.0 of pixi.js, the eventemitter3 library was removed and is not necessary anymore.

You can setup your project for version 5 of pixi.js using:

npm install @robotlegsjs/pixi-signalmediator@^3.0.0 pixi.js@^5.0.0 reflect-metadata --save

yarn add @robotlegsjs/pixi-signalmediator@^3.0.0 pixi.js@^5.0.0 reflect-metadata

For `pixi.js` version 4

The @robotlegsjs/pixi-signalmediator package version ^1.0.0 is compatible with versions between the >=4.2.1 <5 version range of pixi.js library.

Since each version of pixi.js library defines which version of eventemitter3 library is being used, remember to also install the proper version of eventemitter3 in your project.

As example, when you would like to use the version 4.2.1 of pixi.js library, you can run:

npm install @robotlegsjs/pixi-signalmediator@^1.0.0 [email protected] eventemitter3@^2.0.0 reflect-metadata --save

yarn add @robotlegsjs/pixi-signalmediator@^1.0.0 [email protected] eventemitter3@^2.0.0 reflect-metadata

Then follow the installation instructions of RobotlegsJS library to complete the setup of your project.

Dependencies

Peer Dependencies

Usage

import { inject, injectable } from "@robotlegsjs/core";

import { SignalMediator } from "@robotlegsjs/pixi-signalmediator";

@injectable()
export class MyUserMediator extends SignalMediator<MyUserView> {

    @inject(UserLoggedInSignal) protected userLoggedInSignal: UserLoggedInSignal;
    @inject(UserLoggedOutSignal) protected userLoggedOutSignal: UserLoggedOutSignal;

    constructor() {
        super();
    }

    private onUserLoggedIn(): void {
        // user is logged in, do something...
    }

    private onUserLoggedOut(): void {
        // user is logged out, do something...
    }

    public initialize(): void {
        this.addToSignal(this.userLoggedInSignal, this.onUserLoggedIn.bind(this));
        this.addToSignal(this.userLoggedOutSignal, this.onUserLoggedOut.bind(this));
    }

    public destroy(): void {
        // clean up memory...
    }
}