Skip to content

Commit

Permalink
Merge pull request #277 from ahocevar/fix-types
Browse files Browse the repository at this point in the history
Fix types and remove unnecessary async
  • Loading branch information
constantinius authored Jan 27, 2022
2 parents 116354d + cd19c12 commit f93870c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions src/geotiff.js
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ class GeoTIFFBase {
* image is called and the result returned.
* @see GeoTIFFImage.readRasters
* @param {import('./geotiffimage').ReadRasterOptions} [options={}] optional parameters
* @returns {Promise.<(TypedArray|TypedArray[])>} the decoded arrays as a promise
* @returns {Promise<(TypedArray|TypedArray[])>} the decoded arrays as a promise
*/
async readRasters(options = {}) {
const { window: imageWindow, width, height } = options;
Expand Down Expand Up @@ -326,7 +326,7 @@ class GeoTIFF extends GeoTIFFBase {
* this function must be called with caution (e.g only using the IFD offsets from
* the headers or other IFDs).
* @param {number} offset the offset to parse the IFD at
* @returns {ImageFileDirectory} the parsed IFD
* @returns {Promise<ImageFileDirectory>} the parsed IFD
*/
async parseFileDirectoryAt(offset) {
const entrySize = this.bigTiff ? 20 : 12;
Expand Down Expand Up @@ -455,7 +455,7 @@ class GeoTIFF extends GeoTIFFBase {
/**
* Returns the count of the internal subfiles.
*
* @returns {number} the number of internal subfile images
* @returns {Promise<number>} the number of internal subfile images
*/
async getImageCount() {
let index = 0;
Expand All @@ -479,7 +479,7 @@ class GeoTIFF extends GeoTIFFBase {
/**
* Get the values of the COG ghost area as a parsed map.
* See https://gdal.org/drivers/raster/cog.html#header-ghost-area for reference
* @returns {Object} the parsed ghost area or null, if no such area was found
* @returns {Promise<Object>} the parsed ghost area or null, if no such area was found
*/
async getGhostValues() {
const offset = this.bigTiff ? 16 : 8;
Expand Down Expand Up @@ -600,7 +600,7 @@ class MultiGeoTIFF extends GeoTIFFBase {
* Get the n-th internal subfile of an image. By default, the first is returned.
*
* @param {number} [index=0] the index of the image to return.
* @returns {GeoTIFFImage} the image at the given index
* @returns {Promise<GeoTIFFImage>} the image at the given index
*/
async getImage(index = 0) {
await this.getImageCount();
Expand Down Expand Up @@ -629,7 +629,7 @@ class MultiGeoTIFF extends GeoTIFFBase {
/**
* Returns the count of the internal subfiles.
*
* @returns {number} the number of internal subfile images
* @returns {Promise<number>} the number of internal subfile images
*/
async getImageCount() {
if (this.imageCount !== null) {
Expand All @@ -652,7 +652,7 @@ export { MultiGeoTIFF };
* See {@link makeRemoteSource} for details.
* @param {AbortSignal} [signal] An AbortSignal that may be signalled if the request is
* to be aborted
* @returns {Promise.<GeoTIFF>} The resulting GeoTIFF file.
* @returns {Promise<GeoTIFF>} The resulting GeoTIFF file.
*/
export async function fromUrl(url, options = {}, signal) {
return GeoTIFF.fromSource(makeRemoteSource(url, options), signal);
Expand Down Expand Up @@ -680,7 +680,7 @@ export async function fromArrayBuffer(arrayBuffer, signal) {
* @param {string} path The file path to read from.
* @param {AbortSignal} [signal] An AbortSignal that may be signalled if the request is
* to be aborted
* @returns {Promise.<GeoTIFF>} The resulting GeoTIFF file.
* @returns {Promise<GeoTIFF>} The resulting GeoTIFF file.
*/
export async function fromFile(path, signal) {
return GeoTIFF.fromSource(makeFileSource(path), signal);
Expand Down Expand Up @@ -725,7 +725,7 @@ export async function fromUrls(mainUrl, overviewUrls = [], options = {}, signal)
* @param {(Array)} array of pixel values
* @returns {metadata} metadata
*/
export async function writeArrayBuffer(values, metadata) {
export function writeArrayBuffer(values, metadata) {
return writeGeotiff(values, metadata);
}

Expand Down
2 changes: 1 addition & 1 deletion src/pool.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class Pool {
/**
* Decode the given block of bytes with the set compression method.
* @param {ArrayBuffer} buffer the array buffer of bytes to decode.
* @returns {Promise.<ArrayBuffer>} the decoded result as a `Promise`
* @returns {Promise<ArrayBuffer>} the decoded result as a `Promise`
*/
async decode(fileDirectory, buffer) {
if (this._awaitingDecoder) {
Expand Down

0 comments on commit f93870c

Please sign in to comment.