Skip to content

TypeScript definition for EventHandlersDataMap doesn't include error #203

Closed
@roncli

Description

@roncli

Description:

The TypeScript definition for EventHandlersDataMap does not include a key for error, resulting in Visual Studio Code showing an error on this statement:

obs.on("error", (err) => {
    console.log(err);
});

The error:

Argument of type '"error"' is not assignable to parameter of type '"ConnectionOpened" | "ConnectionClosed" | "AuthenticationSuccess" | "AuthenticationFailure" | "SwitchScenes" | "ScenesChanged" | "SceneCollectionChanged" | "SceneCollectionListChanged" | ... 43 more ... | "StudioModeSwitched"'.

I think that just adding error: Error; to EventHandlersDataMap in index.d.ts should resolve it, but am not familiar enough with TS to know if that actually is a valid solution.

Versions Used (if applicable):

  • obs-websocket-js version: v4.0.1
  • obs-websocket plugin version: n/a
  • obs-studio version: n/a
  • node version: v14.3.0

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