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

StyleImageInterface definition differs from the documented interface #9350

Closed
DiogoAndre opened this issue Feb 27, 2020 · 1 comment
Closed

Comments

@DiogoAndre
Copy link

mapbox-gl-js version: Master

The StyleImageInterface defined on style/style_image.js is different from the version documented on the same file. The return type for the render() function is implemented as void but documented as boolean, which looks like the correct return type.

export type StyleImageInterface = {
    width: number,
    height: number,
    data: Uint8Array | Uint8ClampedArray,
    render?: () => void,
    onAdd?: (map: Map, id: string) => void,
    onRemove?: () => void
};
 * @function
 * @memberof StyleImageInterface
 * @instance
 * @name render
 * @return {boolean} `true` if this method updated the image. `false` if the image was not changed.
@ryanhamley
Copy link
Contributor

Closed by #9604

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

No branches or pull requests

3 participants