Add ': void' to non returning functions (error TS7014)

This commit is contained in:
Niklas Alt
2018-12-06 19:57:45 +01:00
parent e4e0e61731
commit 4bc9216e41
24 changed files with 34 additions and 34 deletions

View File

@@ -22,7 +22,7 @@ import {getHeight} from './extent.js';
* post requests or - in general - through XHR requests, where the src of the * post requests or - in general - through XHR requests, where the src of the
* image element would be set to a data URI when the content is loaded. * image element would be set to a data URI when the content is loaded.
* *
* @typedef {function(ImageWrapper, string)} LoadFunction * @typedef {function(ImageWrapper, string): void} LoadFunction
* @api * @api
*/ */

View File

@@ -11,7 +11,7 @@ import ImageState from './ImageState.js';
* If any error occurs during drawing, the "done" callback should be called with * If any error occurs during drawing, the "done" callback should be called with
* that error. * that error.
* *
* @typedef {function(function(Error=))} Loader * @typedef {function(function(Error=): void): void} Loader
*/ */

View File

@@ -336,7 +336,7 @@ class PluggableMap extends BaseObject {
this.renderer_ = this.createRenderer(); this.renderer_ = this.createRenderer();
/** /**
* @type {function(Event)|undefined} * @type {function(Event): void|undefined}
* @private * @private
*/ */
this.handleResize_; this.handleResize_;

View File

@@ -40,7 +40,7 @@ import EventType from './events/EventType.js';
* }); * });
* ``` * ```
* *
* @typedef {function(Tile, string)} LoadFunction * @typedef {function(Tile, string): void} LoadFunction
* @api * @api
*/ */

View File

@@ -38,7 +38,7 @@ class VectorImageTile extends Tile {
* @param {import("./proj/Projection.js").default} projection Projection. * @param {import("./proj/Projection.js").default} projection Projection.
* @param {typeof import("./VectorTile.js").default} tileClass Class to * @param {typeof import("./VectorTile.js").default} tileClass Class to
* instantiate for source tiles. * instantiate for source tiles.
* @param {function(this: import("./source/VectorTile.js").default, import("./events/Event.js").default)} handleTileChange * @param {function(this: import("./source/VectorTile.js").default, import("./events/Event.js").default): void} handleTileChange
* Function to call when a source tile's state changes. * Function to call when a source tile's state changes.
* @param {number} zoom Integer zoom to render the tile for. * @param {number} zoom Integer zoom to render the tile for.
*/ */

View File

@@ -399,7 +399,7 @@ class View extends BaseObject {
* calling `view.setCenter()`, `view.setResolution()`, or `view.setRotation()` * calling `view.setCenter()`, `view.setResolution()`, or `view.setRotation()`
* (or another method that calls one of these). * (or another method that calls one of these).
* *
* @param {...(AnimationOptions|function(boolean))} var_args Animation * @param {...(AnimationOptions|function(boolean): void)} var_args Animation
* options. Multiple animations can be run in series by passing multiple * options. Multiple animations can be run in series by passing multiple
* options objects. To run multiple animations in parallel, call the method * options objects. To run multiple animations in parallel, call the method
* multiple times. An optional callback can be provided as a final * multiple times. An optional callback can be provided as a final

View File

@@ -79,7 +79,7 @@ class Control extends BaseObject {
this.listenerKeys = []; this.listenerKeys = [];
/** /**
* @type {function(import("../MapEvent.js").default)} * @type {function(import("../MapEvent.js").default): void}
*/ */
this.render = options.render ? options.render : VOID; this.render = options.render ? options.render : VOID;

View File

@@ -17,7 +17,7 @@ import FormatType from './format/FormatType.js';
* The function is responsible for loading the features and adding them to the * The function is responsible for loading the features and adding them to the
* source. * source.
* @typedef {function(this:(import("./source/Vector").default|import("./VectorTile.js").default), import("./extent.js").Extent, number, * @typedef {function(this:(import("./source/Vector").default|import("./VectorTile.js").default), import("./extent.js").Extent, number,
* import("./proj/Projection.js").default)} FeatureLoader * import("./proj/Projection.js").default): void} FeatureLoader
* @api * @api
*/ */
@@ -38,10 +38,10 @@ import FormatType from './format/FormatType.js';
/** /**
* @param {string|FeatureUrlFunction} url Feature URL service. * @param {string|FeatureUrlFunction} url Feature URL service.
* @param {import("./format/Feature.js").default} format Feature format. * @param {import("./format/Feature.js").default} format Feature format.
* @param {function(this:import("./VectorTile.js").default, Array<import("./Feature.js").default>, import("./proj/Projection.js").default, import("./extent.js").Extent)|function(this:import("./source/Vector").default, Array<import("./Feature.js").default>)} success * @param {function(this:import("./VectorTile.js").default, Array<import("./Feature.js").default>, import("./proj/Projection.js").default, import("./extent.js").Extent): void|function(this:import("./source/Vector").default, Array<import("./Feature.js").default>): void} success
* Function called with the loaded features and optionally with the data * Function called with the loaded features and optionally with the data
* projection. Called with the vector tile or source as `this`. * projection. Called with the vector tile or source as `this`.
* @param {function(this:import("./VectorTile.js").default)|function(this:import("./source/Vector").default)} failure * @param {function(this:import("./VectorTile.js").default): void|function(this:import("./source/Vector").default): void} failure
* Function called when loading failed. Called with the vector tile or * Function called when loading failed. Called with the vector tile or
* source as `this`. * source as `this`.
* @return {FeatureLoader} The feature loader. * @return {FeatureLoader} The feature loader.

View File

@@ -132,7 +132,7 @@ class GPX extends XMLFeature {
this.dataProjection = getProjection('EPSG:4326'); this.dataProjection = getProjection('EPSG:4326');
/** /**
* @type {function(Feature, Node)|undefined} * @type {function(Feature, Node): void|undefined}
* @private * @private
*/ */
this.readExtensions_ = options.readExtensions; this.readExtensions_ = options.readExtensions;

View File

@@ -133,7 +133,7 @@ class DragBox extends PointerInteraction {
/** /**
* Function to execute just before `onboxend` is fired * Function to execute just before `onboxend` is fired
* @type {function(this:DragBox, import("../MapBrowserEvent.js").default)} * @type {function(this:DragBox, import("../MapBrowserEvent.js").default): void}
* @private * @private
*/ */
this.onBoxEnd_ = options.onBoxEnd ? options.onBoxEnd : VOID; this.onBoxEnd_ = options.onBoxEnd ? options.onBoxEnd : VOID;

View File

@@ -274,7 +274,7 @@ class Modify extends PointerInteraction {
/** /**
* @const * @const
* @private * @private
* @type {!Object<string, function(Feature, import("../geom/Geometry.js").default)>} * @type {!Object<string, function(Feature, import("../geom/Geometry.js").default): void>}
*/ */
this.SEGMENT_WRITERS_ = { this.SEGMENT_WRITERS_ = {
'Point': this.writePointGeometry_, 'Point': this.writePointGeometry_,

View File

@@ -181,7 +181,7 @@ class Snap extends PointerInteraction {
/** /**
* @const * @const
* @private * @private
* @type {Object<string, function(import("../Feature.js").default, import("../geom/Geometry.js").default)>} * @type {Object<string, function(import("../Feature.js").default, import("../geom/Geometry.js").default): void>}
*/ */
this.SEGMENT_WRITERS_ = { this.SEGMENT_WRITERS_ = {
'Point': this.writePointGeometry_, 'Point': this.writePointGeometry_,

View File

@@ -6,7 +6,7 @@ class EventSource {
/** /**
* @param {import("./PointerEventHandler.js").default} dispatcher Event handler. * @param {import("./PointerEventHandler.js").default} dispatcher Event handler.
* @param {!Object<string, function(Event)>} mapping Event mapping. * @param {!Object<string, function(Event): void>} mapping Event mapping.
*/ */
constructor(dispatcher, mapping) { constructor(dispatcher, mapping) {
@@ -18,7 +18,7 @@ class EventSource {
/** /**
* @private * @private
* @const * @const
* @type {!Object<string, function(Event)>} * @type {!Object<string, function(Event): void>}
*/ */
this.mapping_ = mapping; this.mapping_ = mapping;
} }

View File

@@ -105,7 +105,7 @@ class PointerEventHandler extends EventTarget {
this.pointerMap = {}; this.pointerMap = {};
/** /**
* @type {Object<string, function(Event)>} * @type {Object<string, function(Event): void>}
* @private * @private
*/ */
this.eventMap_ = {}; this.eventMap_ = {};

View File

@@ -247,7 +247,7 @@ class TouchSource extends EventSource {
/** /**
* @private * @private
* @param {TouchEvent} inEvent Touch event * @param {TouchEvent} inEvent Touch event
* @param {function(TouchEvent, PointerEvent)} inFunction In function. * @param {function(TouchEvent, PointerEvent): void} inFunction In function.
*/ */
processTouches_(inEvent, inFunction) { processTouches_(inEvent, inFunction) {
const touches = Array.prototype.slice.call(inEvent.changedTouches); const touches = Array.prototype.slice.call(inEvent.changedTouches);

View File

@@ -397,7 +397,7 @@ class CanvasBuilder extends VectorContext {
/** /**
* @param {import("../canvas.js").FillStrokeState} state State. * @param {import("../canvas.js").FillStrokeState} state State.
* @param {function(this:CanvasBuilder, import("../canvas.js").FillStrokeState)} applyStroke Apply stroke. * @param {function(this:CanvasBuilder, import("../canvas.js").FillStrokeState): void} applyStroke Apply stroke.
*/ */
updateStrokeStyle(state, applyStroke) { updateStrokeStyle(state, applyStroke) {
const strokeStyle = state.strokeStyle; const strokeStyle = state.strokeStyle;

View File

@@ -18,7 +18,7 @@ const SIMPLIFY_TOLERANCE = 0.5;
* @const * @const
* @type {Object<import("../geom/GeometryType.js").default, * @type {Object<import("../geom/GeometryType.js").default,
* function(import("../render/canvas/BuilderGroup.js").default, import("../geom/Geometry.js").default, * function(import("../render/canvas/BuilderGroup.js").default, import("../geom/Geometry.js").default,
* import("../style/Style.js").default, Object)>} * import("../style/Style.js").default, Object): void>}
*/ */
const GEOMETRY_RENDERERS = { const GEOMETRY_RENDERERS = {
'Point': renderPointGeometry, 'Point': renderPointGeometry,
@@ -91,7 +91,7 @@ function renderCircleGeometry(builderGroup, geometry, style, feature) {
* @param {import("../Feature.js").FeatureLike} feature Feature. * @param {import("../Feature.js").FeatureLike} feature Feature.
* @param {import("../style/Style.js").default} style Style. * @param {import("../style/Style.js").default} style Style.
* @param {number} squaredTolerance Squared tolerance. * @param {number} squaredTolerance Squared tolerance.
* @param {function(this: T, import("../events/Event.js").default)} listener Listener function. * @param {function(this: T, import("../events/Event.js").default): void} listener Listener function.
* @param {T} thisArg Value to use as `this` when executing `listener`. * @param {T} thisArg Value to use as `this` when executing `listener`.
* @return {boolean} `true` if style is loading. * @return {boolean} `true` if style is loading.
* @template T * @template T

View File

@@ -138,7 +138,7 @@ export class CustomTile extends Tile {
* Calls the callback (synchronously by default) with the available data * Calls the callback (synchronously by default) with the available data
* for given coordinate (or `null` if not yet loaded). * for given coordinate (or `null` if not yet loaded).
* @param {import("../coordinate.js").Coordinate} coordinate Coordinate. * @param {import("../coordinate.js").Coordinate} coordinate Coordinate.
* @param {function(this: T, *)} callback Callback. * @param {function(this: T, *): void} callback Callback.
* @param {T=} opt_this The object to use as `this` in the callback. * @param {T=} opt_this The object to use as `this` in the callback.
* @param {boolean=} opt_request If `true` the callback is always async. * @param {boolean=} opt_request If `true` the callback is always async.
* The tile data is requested if not yet loaded. * The tile data is requested if not yet loaded.
@@ -379,7 +379,7 @@ class UTFGrid extends TileSource {
* in case of an error). * in case of an error).
* @param {import("../coordinate.js").Coordinate} coordinate Coordinate. * @param {import("../coordinate.js").Coordinate} coordinate Coordinate.
* @param {number} resolution Resolution. * @param {number} resolution Resolution.
* @param {function(*)} callback Callback. * @param {function(*): void} callback Callback.
* @param {boolean=} opt_request If `true` the callback is always async. * @param {boolean=} opt_request If `true` the callback is always async.
* The tile data is requested if not yet loaded. * The tile data is requested if not yet loaded.
* @api * @api

View File

@@ -93,7 +93,7 @@ class Atlas {
* @param {string} id The identifier of the entry to add. * @param {string} id The identifier of the entry to add.
* @param {number} width The width. * @param {number} width The width.
* @param {number} height The height. * @param {number} height The height.
* @param {function(CanvasRenderingContext2D, number, number)} renderCallback * @param {function(CanvasRenderingContext2D, number, number): void} renderCallback
* Called to render the new image onto an atlas image. * Called to render the new image onto an atlas image.
* @param {Object=} opt_this Value to use as `this` when executing * @param {Object=} opt_this Value to use as `this` when executing
* `renderCallback`. * `renderCallback`.

View File

@@ -174,7 +174,7 @@ class AtlasManager {
* @param {string} id The identifier of the entry to add. * @param {string} id The identifier of the entry to add.
* @param {number} width The width. * @param {number} width The width.
* @param {number} height The height. * @param {number} height The height.
* @param {function(CanvasRenderingContext2D, number, number)} renderCallback * @param {function(CanvasRenderingContext2D, number, number): void} renderCallback
* Called to render the new image onto an atlas image. * Called to render the new image onto an atlas image.
* @param {function(CanvasRenderingContext2D, number, number)=} opt_renderHitCallback Called to render a hit-detection image onto a hit * @param {function(CanvasRenderingContext2D, number, number)=} opt_renderHitCallback Called to render a hit-detection image onto a hit
* detection atlas image. * detection atlas image.
@@ -213,7 +213,7 @@ class AtlasManager {
* @param {string} id The identifier of the entry to add. * @param {string} id The identifier of the entry to add.
* @param {number} width The width. * @param {number} width The width.
* @param {number} height The height. * @param {number} height The height.
* @param {function(CanvasRenderingContext2D, number, number)} renderCallback * @param {function(CanvasRenderingContext2D, number, number): void} renderCallback
* Called to render the new image onto an atlas image. * Called to render the new image onto an atlas image.
* @param {Object=} opt_this Value to use as `this` when executing * @param {Object=} opt_this Value to use as `this` when executing
* `renderCallback` and `renderHitCallback`. * `renderCallback` and `renderHitCallback`.

View File

@@ -233,7 +233,7 @@ class ImageStyle {
/** /**
* @abstract * @abstract
* @param {function(this: T, import("../events/Event.js").default)} listener Listener function. * @param {function(this: T, import("../events/Event.js").default): void} listener Listener function.
* @param {T} thisArg Value to use as `this` when executing `listener`. * @param {T} thisArg Value to use as `this` when executing `listener`.
* @return {import("../events.js").EventsKey|undefined} Listener key. * @return {import("../events.js").EventsKey|undefined} Listener key.
* @template T * @template T
@@ -252,7 +252,7 @@ class ImageStyle {
/** /**
* @abstract * @abstract
* @param {function(this: T, import("../events/Event.js").default)} listener Listener function. * @param {function(this: T, import("../events/Event.js").default): void} listener Listener function.
* @param {T} thisArg Value to use as `this` when executing `listener`. * @param {T} thisArg Value to use as `this` when executing `listener`.
* @template T * @template T
*/ */

View File

@@ -122,7 +122,7 @@ import Stroke from './Stroke.js';
* 1. The pixel coordinates of the geometry in GeoJSON notation. * 1. The pixel coordinates of the geometry in GeoJSON notation.
* 2. The {@link module:ol/render~State} of the layer renderer. * 2. The {@link module:ol/render~State} of the layer renderer.
* *
* @typedef {function((import("../coordinate.js").Coordinate|Array<import("../coordinate.js").Coordinate>|Array<Array<import("../coordinate.js").Coordinate>>),import("../render.js").State)} * @typedef {function((import("../coordinate.js").Coordinate|Array<import("../coordinate.js").Coordinate>|Array<Array<import("../coordinate.js").Coordinate>>),import("../render.js").State): void}
* RenderFunction * RenderFunction
*/ */

View File

@@ -189,7 +189,7 @@ class TileGrid {
* *
* @param {import("../extent.js").Extent} extent Extent. * @param {import("../extent.js").Extent} extent Extent.
* @param {number} zoom Integer zoom level. * @param {number} zoom Integer zoom level.
* @param {function(import("../tilecoord.js").TileCoord)} callback Function called with each tile coordinate. * @param {function(import("../tilecoord.js").TileCoord): void} callback Function called with each tile coordinate.
* @api * @api
*/ */
forEachTileCoord(extent, zoom, callback) { forEachTileCoord(extent, zoom, callback) {

View File

@@ -14,12 +14,12 @@ import {extend} from './array.js';
/** /**
* @typedef {function(Element, Array<*>)} Parser * @typedef {function(Element, Array<*>): void} Parser
*/ */
/** /**
* @typedef {function(Element, *, Array<*>)} Serializer * @typedef {function(Element, *, Array<*>): void} Serializer
*/ */
@@ -252,7 +252,7 @@ export function makeObjectPropertySetter(valueReader, opt_property, opt_this) {
* Create a serializer that appends nodes written by its `nodeWriter` to its * Create a serializer that appends nodes written by its `nodeWriter` to its
* designated parent. The parent is the `node` of the * designated parent. The parent is the `node` of the
* {@link module:ol/xml~NodeStackItem} at the top of the `objectStack`. * {@link module:ol/xml~NodeStackItem} at the top of the `objectStack`.
* @param {function(this: T, Node, V, Array<*>)} nodeWriter Node writer. * @param {function(this: T, Node, V, Array<*>): void} nodeWriter Node writer.
* @param {T=} opt_this The object to use as `this` in `nodeWriter`. * @param {T=} opt_this The object to use as `this` in `nodeWriter`.
* @return {Serializer} Serializer. * @return {Serializer} Serializer.
* @template T, V * @template T, V
@@ -274,7 +274,7 @@ export function makeChildAppender(nodeWriter, opt_this) {
* designed to serialize a single item. An example would be a LineString * designed to serialize a single item. An example would be a LineString
* geometry writer, which could be reused for writing MultiLineString * geometry writer, which could be reused for writing MultiLineString
* geometries. * geometries.
* @param {function(this: T, Element, V, Array<*>)} nodeWriter Node writer. * @param {function(this: T, Element, V, Array<*>): void} nodeWriter Node writer.
* @param {T=} opt_this The object to use as `this` in `nodeWriter`. * @param {T=} opt_this The object to use as `this` in `nodeWriter`.
* @return {Serializer} Serializer. * @return {Serializer} Serializer.
* @template T, V * @template T, V