Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing debug JSDoc annotations to ServerEngine constructor #142

Open
xmclark opened this issue Aug 8, 2021 · 0 comments
Open

Add missing debug JSDoc annotations to ServerEngine constructor #142

xmclark opened this issue Aug 8, 2021 · 0 comments

Comments

@xmclark
Copy link

xmclark commented Aug 8, 2021

As a user of this library, I use IDE type hints that leverage the JSDoc type annotations. The ServerEngine constructor takes an options that is missing the debug section. This should be added to the JSDoc annotations.

Sample code:

// Game Instances
const gameEngine = new Game({ traceLevel: Lib.Trace.TRACE_NONE });
const serverEngine = new ServerEngine(io,
    gameEngine,
    {
        debug: {}, // this section
        updateRate: 6
    });

// start the game
serverEngine.start();

Problem description:

Argument type {updateRate: number, debug: {}} is not assignable to parameter type {stepRate: Number, updateRate: Number, fullSyncRate: Number, tracesPath: String, countConnections: Boolean, updateOnObjectCreation: Boolean, timeoutInterval: Number}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant