Skip to content

Add missing debug JSDoc annotations to ServerEngine constructor #142

@xmclark

Description

@xmclark

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}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions