Skip to content

Event object types required by new Evented#fire are not exported #6522

@bfrengley

Description

@bfrengley

mapbox-gl-js version: master (to be release 0.45.0)

With the changes in 87c6332 made as a part of #6218, Evented#fire (and by extension Map#fire) expects an Event object rather than a string, as previously. However, the Event and ErrorEvent types are not exposed to mapbox-gl-js consumers, while the Evented class is documented as part of the public API.

Calls to Map#fire can be made by creating an object in the shape of an Event object (e.g., map.fire({ type: 'move', originalEvent: e })), but with the lack of documentation of Event and ErrorEvent, this isn't obvious.

Is there intention to export and/or document these types?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions