0.15.5

[endel]

• #563 - Allow to specify types of client.userData and client.auth via Client<UserData, AuthData>
• Fixes #555 and #532 - Zombie Rooms with multiple servers w/ RedisDriver
• Prevent "trying to send data to inactive client" logs as they were not helpful.
• @colyseus/loadtest - add "disconnected" count below "connected" count.

Specifying types for client.userData and client.auth

You can now specify the types of client.userData and client.auth via Client<UserData, AuthData>:

import { ClientArray, Room } from "colyseus";

interface UserData {
  keyboard: {[key: string]: boolean};
}
interface AuthData {
  userId: number;
}

class MyRoom extends Room {
  clients: ClientArray<UserData, AuthData>

  onCreate() {
    this.onMessage("key", (client, key) => {
      // client.userData is now of type UserData
      client.userData.keyboard[key] = true;
    });
  }

  async onAuth(client, options) {
    // client.auth is now of type AuthData
    client.auth = await fetchUserFromDB(options);
    return client.auth.userId > 0;
  }
}

(If TypeScript complains on "Property 'clients' has no initializer and is not definitely assigned in the constructor", you can either declare clients!: ClientArray or set "strictPropertyInitialization":false on tsconfig (not recommended))

---

Updating your packages:

npm install --save @colyseus/core@latest
npm install --save @colyseus/ws-transport@latest
npm install --save @colyseus/redis-driver@latest
npm install --save-dev @colyseus/loadtest@latest

If you have these packages installed, you can also update them:

npm install --save @colyseus/uwebsockets-transport
npm install --save @colyseus/mongoose-driver

---

This discussion was created from the release 0.15.5.

[khoakomlem]

pecifying types for client.userData and client.auth

I'm using 0.15.7
For Room.onJoin or Room.onCreate, somehow the extract types code looks fine but it not works! Can you check it?

[endel]

Hi @khoakomlem 👋 which version of TypeScript are you using so I can check? Cheers

[khoakomlem]

Hi @khoakomlem 👋 which version of TypeScript are you using so I can check? Cheers

I'm using tsc 5.4.5

[endel]

Thank you for confirming @khoakomlem. I'm afraid this feature is not working as intended in any version of TypeScript. There is a proposal by @LelouBil to move UserData and AuthData as generic when extending the room, but the same problem of "implicit any" will occur when overriding the lifecycle functions (onJoin, onLeave). This only seems to be working during onMessage().

I may be wrong but I'm afraid it is not going to be possible to fix this without restructuring how to declare rooms entirely.

For now I'd suggest doing this, in order to reduce duplicating Client<X, Y> thorough the code:

import { Client as RawClient } from "@colyseus/core";
type Client = RawClient<UserData, AuthData>;

// ...

onJoin(client: Client) {}
onLeave(client: Client) {}

[khoakomlem]

But your code seems fine, do you have any idea on what might be causing the error?

[endel]

Unfortunately TypeScript does not infer the types from the overridden class function... This works on onMessage because we have a typed callback there, so it infers properly. It seems there has been discussions about this on TypeScript here microsoft/TypeScript#1373 and more recently here microsoft/TypeScript#23911