Transformed types

Using the [ts.js codemod](https://gist.github.com/tschaub/1ea498c9d1e5268cf36d212b3949be4e):

    jscodeshift --transform ts.js src
This commit is contained in:
Tim Schaub
2018-09-05 08:05:29 -06:00
parent f2aaaa19e1
commit ccfacc5ee6
239 changed files with 3999 additions and 3999 deletions

View File

@@ -15,8 +15,8 @@ import Relationship from './extent/Relationship.js';
/**
* Build an extent that includes all given coordinates.
*
* @param {Array<module:ol/coordinate~Coordinate>} coordinates Coordinates.
* @return {module:ol/extent~Extent} Bounding extent.
* @param {Array<import("./coordinate.js").Coordinate>} coordinates Coordinates.
* @return {Extent} Bounding extent.
* @api
*/
export function boundingExtent(coordinates) {
@@ -31,9 +31,9 @@ export function boundingExtent(coordinates) {
/**
* @param {Array<number>} xs Xs.
* @param {Array<number>} ys Ys.
* @param {module:ol/extent~Extent=} opt_extent Destination extent.
* @param {Extent=} opt_extent Destination extent.
* @private
* @return {module:ol/extent~Extent} Extent.
* @return {Extent} Extent.
*/
function _boundingExtentXYs(xs, ys, opt_extent) {
const minX = Math.min.apply(null, xs);
@@ -46,10 +46,10 @@ function _boundingExtentXYs(xs, ys, opt_extent) {
/**
* Return extent increased by the provided value.
* @param {module:ol/extent~Extent} extent Extent.
* @param {Extent} extent Extent.
* @param {number} value The amount by which the extent should be buffered.
* @param {module:ol/extent~Extent=} opt_extent Extent.
* @return {module:ol/extent~Extent} Extent.
* @param {Extent=} opt_extent Extent.
* @return {Extent} Extent.
* @api
*/
export function buffer(extent, value, opt_extent) {
@@ -73,9 +73,9 @@ export function buffer(extent, value, opt_extent) {
/**
* Creates a clone of an extent.
*
* @param {module:ol/extent~Extent} extent Extent to clone.
* @param {module:ol/extent~Extent=} opt_extent Extent.
* @return {module:ol/extent~Extent} The clone.
* @param {Extent} extent Extent to clone.
* @param {Extent=} opt_extent Extent.
* @return {Extent} The clone.
*/
export function clone(extent, opt_extent) {
if (opt_extent) {
@@ -91,7 +91,7 @@ export function clone(extent, opt_extent) {
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {Extent} extent Extent.
* @param {number} x X.
* @param {number} y Y.
* @return {number} Closest squared distance.
@@ -119,8 +119,8 @@ export function closestSquaredDistanceXY(extent, x, y) {
/**
* Check if the passed coordinate is contained or on the edge of the extent.
*
* @param {module:ol/extent~Extent} extent Extent.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {Extent} extent Extent.
* @param {import("./coordinate.js").Coordinate} coordinate Coordinate.
* @return {boolean} The coordinate is contained in the extent.
* @api
*/
@@ -135,8 +135,8 @@ export function containsCoordinate(extent, coordinate) {
* An extent is deemed contained if it lies completely within the other extent,
* including if they share one or more edges.
*
* @param {module:ol/extent~Extent} extent1 Extent 1.
* @param {module:ol/extent~Extent} extent2 Extent 2.
* @param {Extent} extent1 Extent 1.
* @param {Extent} extent2 Extent 2.
* @return {boolean} The second extent is contained by or on the edge of the
* first.
* @api
@@ -150,7 +150,7 @@ export function containsExtent(extent1, extent2) {
/**
* Check if the passed coordinate is contained or on the edge of the extent.
*
* @param {module:ol/extent~Extent} extent Extent.
* @param {Extent} extent Extent.
* @param {number} x X coordinate.
* @param {number} y Y coordinate.
* @return {boolean} The x, y values are contained in the extent.
@@ -163,10 +163,10 @@ export function containsXY(extent, x, y) {
/**
* Get the relationship between a coordinate and extent.
* @param {module:ol/extent~Extent} extent The extent.
* @param {module:ol/coordinate~Coordinate} coordinate The coordinate.
* @return {module:ol/extent/Relationship} The relationship (bitwise compare with
* module:ol/extent/Relationship~Relationship).
* @param {Extent} extent The extent.
* @param {import("./coordinate.js").Coordinate} coordinate The coordinate.
* @return {import("./extent/Relationship.js").default} The relationship (bitwise compare with
* import("./extent/Relationship.js").Relationship).
*/
export function coordinateRelationship(extent, coordinate) {
const minX = extent[0];
@@ -195,7 +195,7 @@ export function coordinateRelationship(extent, coordinate) {
/**
* Create an empty extent.
* @return {module:ol/extent~Extent} Empty extent.
* @return {Extent} Empty extent.
* @api
*/
export function createEmpty() {
@@ -209,8 +209,8 @@ export function createEmpty() {
* @param {number} minY Minimum Y.
* @param {number} maxX Maximum X.
* @param {number} maxY Maximum Y.
* @param {module:ol/extent~Extent=} opt_extent Destination extent.
* @return {module:ol/extent~Extent} Extent.
* @param {Extent=} opt_extent Destination extent.
* @return {Extent} Extent.
*/
export function createOrUpdate(minX, minY, maxX, maxY, opt_extent) {
if (opt_extent) {
@@ -227,8 +227,8 @@ export function createOrUpdate(minX, minY, maxX, maxY, opt_extent) {
/**
* Create a new empty extent or make the provided one empty.
* @param {module:ol/extent~Extent=} opt_extent Extent.
* @return {module:ol/extent~Extent} Extent.
* @param {Extent=} opt_extent Extent.
* @return {Extent} Extent.
*/
export function createOrUpdateEmpty(opt_extent) {
return createOrUpdate(
@@ -237,9 +237,9 @@ export function createOrUpdateEmpty(opt_extent) {
/**
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {module:ol/extent~Extent=} opt_extent Extent.
* @return {module:ol/extent~Extent} Extent.
* @param {import("./coordinate.js").Coordinate} coordinate Coordinate.
* @param {Extent=} opt_extent Extent.
* @return {Extent} Extent.
*/
export function createOrUpdateFromCoordinate(coordinate, opt_extent) {
const x = coordinate[0];
@@ -249,9 +249,9 @@ export function createOrUpdateFromCoordinate(coordinate, opt_extent) {
/**
* @param {Array<module:ol/coordinate~Coordinate>} coordinates Coordinates.
* @param {module:ol/extent~Extent=} opt_extent Extent.
* @return {module:ol/extent~Extent} Extent.
* @param {Array<import("./coordinate.js").Coordinate>} coordinates Coordinates.
* @param {Extent=} opt_extent Extent.
* @return {Extent} Extent.
*/
export function createOrUpdateFromCoordinates(coordinates, opt_extent) {
const extent = createOrUpdateEmpty(opt_extent);
@@ -264,8 +264,8 @@ export function createOrUpdateFromCoordinates(coordinates, opt_extent) {
* @param {number} offset Offset.
* @param {number} end End.
* @param {number} stride Stride.
* @param {module:ol/extent~Extent=} opt_extent Extent.
* @return {module:ol/extent~Extent} Extent.
* @param {Extent=} opt_extent Extent.
* @return {Extent} Extent.
*/
export function createOrUpdateFromFlatCoordinates(flatCoordinates, offset, end, stride, opt_extent) {
const extent = createOrUpdateEmpty(opt_extent);
@@ -273,9 +273,9 @@ export function createOrUpdateFromFlatCoordinates(flatCoordinates, offset, end,
}
/**
* @param {Array<Array<module:ol/coordinate~Coordinate>>} rings Rings.
* @param {module:ol/extent~Extent=} opt_extent Extent.
* @return {module:ol/extent~Extent} Extent.
* @param {Array<Array<import("./coordinate.js").Coordinate>>} rings Rings.
* @param {Extent=} opt_extent Extent.
* @return {Extent} Extent.
*/
export function createOrUpdateFromRings(rings, opt_extent) {
const extent = createOrUpdateEmpty(opt_extent);
@@ -285,8 +285,8 @@ export function createOrUpdateFromRings(rings, opt_extent) {
/**
* Determine if two extents are equivalent.
* @param {module:ol/extent~Extent} extent1 Extent 1.
* @param {module:ol/extent~Extent} extent2 Extent 2.
* @param {Extent} extent1 Extent 1.
* @param {Extent} extent2 Extent 2.
* @return {boolean} The two extents are equivalent.
* @api
*/
@@ -298,9 +298,9 @@ export function equals(extent1, extent2) {
/**
* Modify an extent to include another extent.
* @param {module:ol/extent~Extent} extent1 The extent to be modified.
* @param {module:ol/extent~Extent} extent2 The extent that will be included in the first.
* @return {module:ol/extent~Extent} A reference to the first (extended) extent.
* @param {Extent} extent1 The extent to be modified.
* @param {Extent} extent2 The extent that will be included in the first.
* @return {Extent} A reference to the first (extended) extent.
* @api
*/
export function extend(extent1, extent2) {
@@ -321,8 +321,8 @@ export function extend(extent1, extent2) {
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {module:ol/coordinate~Coordinate} coordinate Coordinate.
* @param {Extent} extent Extent.
* @param {import("./coordinate.js").Coordinate} coordinate Coordinate.
*/
export function extendCoordinate(extent, coordinate) {
if (coordinate[0] < extent[0]) {
@@ -341,9 +341,9 @@ export function extendCoordinate(extent, coordinate) {
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {Array<module:ol/coordinate~Coordinate>} coordinates Coordinates.
* @return {module:ol/extent~Extent} Extent.
* @param {Extent} extent Extent.
* @param {Array<import("./coordinate.js").Coordinate>} coordinates Coordinates.
* @return {Extent} Extent.
*/
export function extendCoordinates(extent, coordinates) {
for (let i = 0, ii = coordinates.length; i < ii; ++i) {
@@ -354,12 +354,12 @@ export function extendCoordinates(extent, coordinates) {
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {Extent} extent Extent.
* @param {Array<number>} flatCoordinates Flat coordinates.
* @param {number} offset Offset.
* @param {number} end End.
* @param {number} stride Stride.
* @return {module:ol/extent~Extent} Extent.
* @return {Extent} Extent.
*/
export function extendFlatCoordinates(extent, flatCoordinates, offset, end, stride) {
for (; offset < end; offset += stride) {
@@ -370,9 +370,9 @@ export function extendFlatCoordinates(extent, flatCoordinates, offset, end, stri
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {Array<Array<module:ol/coordinate~Coordinate>>} rings Rings.
* @return {module:ol/extent~Extent} Extent.
* @param {Extent} extent Extent.
* @param {Array<Array<import("./coordinate.js").Coordinate>>} rings Rings.
* @return {Extent} Extent.
*/
export function extendRings(extent, rings) {
for (let i = 0, ii = rings.length; i < ii; ++i) {
@@ -383,7 +383,7 @@ export function extendRings(extent, rings) {
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {Extent} extent Extent.
* @param {number} x X.
* @param {number} y Y.
*/
@@ -399,8 +399,8 @@ export function extendXY(extent, x, y) {
* This function calls `callback` for each corner of the extent. If the
* callback returns a truthy value the function returns that value
* immediately. Otherwise the function returns `false`.
* @param {module:ol/extent~Extent} extent Extent.
* @param {function(this:T, module:ol/coordinate~Coordinate): S} callback Callback.
* @param {Extent} extent Extent.
* @param {function(this:T, import("./coordinate.js").Coordinate): S} callback Callback.
* @param {T=} opt_this Value to use as `this` when executing `callback`.
* @return {S|boolean} Value.
* @template S, T
@@ -429,7 +429,7 @@ export function forEachCorner(extent, callback, opt_this) {
/**
* Get the size of an extent.
* @param {module:ol/extent~Extent} extent Extent.
* @param {Extent} extent Extent.
* @return {number} Area.
* @api
*/
@@ -444,8 +444,8 @@ export function getArea(extent) {
/**
* Get the bottom left coordinate of an extent.
* @param {module:ol/extent~Extent} extent Extent.
* @return {module:ol/coordinate~Coordinate} Bottom left coordinate.
* @param {Extent} extent Extent.
* @return {import("./coordinate.js").Coordinate} Bottom left coordinate.
* @api
*/
export function getBottomLeft(extent) {
@@ -455,8 +455,8 @@ export function getBottomLeft(extent) {
/**
* Get the bottom right coordinate of an extent.
* @param {module:ol/extent~Extent} extent Extent.
* @return {module:ol/coordinate~Coordinate} Bottom right coordinate.
* @param {Extent} extent Extent.
* @return {import("./coordinate.js").Coordinate} Bottom right coordinate.
* @api
*/
export function getBottomRight(extent) {
@@ -466,8 +466,8 @@ export function getBottomRight(extent) {
/**
* Get the center coordinate of an extent.
* @param {module:ol/extent~Extent} extent Extent.
* @return {module:ol/coordinate~Coordinate} Center.
* @param {Extent} extent Extent.
* @return {import("./coordinate.js").Coordinate} Center.
* @api
*/
export function getCenter(extent) {
@@ -477,9 +477,9 @@ export function getCenter(extent) {
/**
* Get a corner coordinate of an extent.
* @param {module:ol/extent~Extent} extent Extent.
* @param {module:ol/extent/Corner} corner Corner.
* @return {module:ol/coordinate~Coordinate} Corner coordinate.
* @param {Extent} extent Extent.
* @param {import("./extent/Corner.js").default} corner Corner.
* @return {import("./coordinate.js").Coordinate} Corner coordinate.
*/
export function getCorner(extent, corner) {
let coordinate;
@@ -495,14 +495,14 @@ export function getCorner(extent, corner) {
assert(false, 13); // Invalid corner
}
return (
/** @type {!module:ol/coordinate~Coordinate} */ (coordinate)
/** @type {!import("./coordinate.js").Coordinate} */ (coordinate)
);
}
/**
* @param {module:ol/extent~Extent} extent1 Extent 1.
* @param {module:ol/extent~Extent} extent2 Extent 2.
* @param {Extent} extent1 Extent 1.
* @param {Extent} extent2 Extent 2.
* @return {number} Enlarged area.
*/
export function getEnlargedArea(extent1, extent2) {
@@ -515,12 +515,12 @@ export function getEnlargedArea(extent1, extent2) {
/**
* @param {module:ol/coordinate~Coordinate} center Center.
* @param {import("./coordinate.js").Coordinate} center Center.
* @param {number} resolution Resolution.
* @param {number} rotation Rotation.
* @param {module:ol/size~Size} size Size.
* @param {module:ol/extent~Extent=} opt_extent Destination extent.
* @return {module:ol/extent~Extent} Extent.
* @param {import("./size.js").Size} size Size.
* @param {Extent=} opt_extent Destination extent.
* @return {Extent} Extent.
*/
export function getForViewAndSize(center, resolution, rotation, size, opt_extent) {
const dx = resolution * size[0] / 2;
@@ -550,7 +550,7 @@ export function getForViewAndSize(center, resolution, rotation, size, opt_extent
/**
* Get the height of an extent.
* @param {module:ol/extent~Extent} extent Extent.
* @param {Extent} extent Extent.
* @return {number} Height.
* @api
*/
@@ -560,8 +560,8 @@ export function getHeight(extent) {
/**
* @param {module:ol/extent~Extent} extent1 Extent 1.
* @param {module:ol/extent~Extent} extent2 Extent 2.
* @param {Extent} extent1 Extent 1.
* @param {Extent} extent2 Extent 2.
* @return {number} Intersection area.
*/
export function getIntersectionArea(extent1, extent2) {
@@ -572,10 +572,10 @@ export function getIntersectionArea(extent1, extent2) {
/**
* Get the intersection of two extents.
* @param {module:ol/extent~Extent} extent1 Extent 1.
* @param {module:ol/extent~Extent} extent2 Extent 2.
* @param {module:ol/extent~Extent=} opt_extent Optional extent to populate with intersection.
* @return {module:ol/extent~Extent} Intersecting extent.
* @param {Extent} extent1 Extent 1.
* @param {Extent} extent2 Extent 2.
* @param {Extent=} opt_extent Optional extent to populate with intersection.
* @return {Extent} Intersecting extent.
* @api
*/
export function getIntersection(extent1, extent2, opt_extent) {
@@ -609,7 +609,7 @@ export function getIntersection(extent1, extent2, opt_extent) {
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {Extent} extent Extent.
* @return {number} Margin.
*/
export function getMargin(extent) {
@@ -619,8 +619,8 @@ export function getMargin(extent) {
/**
* Get the size (width, height) of an extent.
* @param {module:ol/extent~Extent} extent The extent.
* @return {module:ol/size~Size} The extent size.
* @param {Extent} extent The extent.
* @return {import("./size.js").Size} The extent size.
* @api
*/
export function getSize(extent) {
@@ -630,8 +630,8 @@ export function getSize(extent) {
/**
* Get the top left coordinate of an extent.
* @param {module:ol/extent~Extent} extent Extent.
* @return {module:ol/coordinate~Coordinate} Top left coordinate.
* @param {Extent} extent Extent.
* @return {import("./coordinate.js").Coordinate} Top left coordinate.
* @api
*/
export function getTopLeft(extent) {
@@ -641,8 +641,8 @@ export function getTopLeft(extent) {
/**
* Get the top right coordinate of an extent.
* @param {module:ol/extent~Extent} extent Extent.
* @return {module:ol/coordinate~Coordinate} Top right coordinate.
* @param {Extent} extent Extent.
* @return {import("./coordinate.js").Coordinate} Top right coordinate.
* @api
*/
export function getTopRight(extent) {
@@ -652,7 +652,7 @@ export function getTopRight(extent) {
/**
* Get the width of an extent.
* @param {module:ol/extent~Extent} extent Extent.
* @param {Extent} extent Extent.
* @return {number} Width.
* @api
*/
@@ -663,8 +663,8 @@ export function getWidth(extent) {
/**
* Determine if one extent intersects another.
* @param {module:ol/extent~Extent} extent1 Extent 1.
* @param {module:ol/extent~Extent} extent2 Extent.
* @param {Extent} extent1 Extent 1.
* @param {Extent} extent2 Extent.
* @return {boolean} The two extents intersect.
* @api
*/
@@ -678,7 +678,7 @@ export function intersects(extent1, extent2) {
/**
* Determine if an extent is empty.
* @param {module:ol/extent~Extent} extent Extent.
* @param {Extent} extent Extent.
* @return {boolean} Is empty.
* @api
*/
@@ -688,9 +688,9 @@ export function isEmpty(extent) {
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {module:ol/extent~Extent=} opt_extent Extent.
* @return {module:ol/extent~Extent} Extent.
* @param {Extent} extent Extent.
* @param {Extent=} opt_extent Extent.
* @return {Extent} Extent.
*/
export function returnOrUpdate(extent, opt_extent) {
if (opt_extent) {
@@ -706,7 +706,7 @@ export function returnOrUpdate(extent, opt_extent) {
/**
* @param {module:ol/extent~Extent} extent Extent.
* @param {Extent} extent Extent.
* @param {number} value Value.
*/
export function scaleFromCenter(extent, value) {
@@ -722,9 +722,9 @@ export function scaleFromCenter(extent, value) {
/**
* Determine if the segment between two coordinates intersects (crosses,
* touches, or is contained by) the provided extent.
* @param {module:ol/extent~Extent} extent The extent.
* @param {module:ol/coordinate~Coordinate} start Segment start coordinate.
* @param {module:ol/coordinate~Coordinate} end Segment end coordinate.
* @param {Extent} extent The extent.
* @param {import("./coordinate.js").Coordinate} start Segment start coordinate.
* @param {import("./coordinate.js").Coordinate} end Segment end coordinate.
* @return {boolean} The segment intersects the extent.
*/
export function intersectsSegment(extent, start, end) {
@@ -777,11 +777,11 @@ export function intersectsSegment(extent, start, end) {
/**
* Apply a transform function to the extent.
* @param {module:ol/extent~Extent} extent Extent.
* @param {module:ol/proj~TransformFunction} transformFn Transform function.
* @param {Extent} extent Extent.
* @param {import("./proj.js").TransformFunction} transformFn Transform function.
* Called with `[minX, minY, maxX, maxY]` extent coordinates.
* @param {module:ol/extent~Extent=} opt_extent Destination extent.
* @return {module:ol/extent~Extent} Extent.
* @param {Extent=} opt_extent Destination extent.
* @return {Extent} Extent.
* @api
*/
export function applyTransform(extent, transformFn, opt_extent) {