Class FetchReader

Fetch Reader

Description

The browser reader that fetches data from a URL.

Usage

import { FetchReader } from 'gis-tools-ts';

const reader = new FetchReader('https://example.com/BETA2007.gsb', true);

const data = await reader.getRange(0, 100);

Implements

Reader

Index

Constructors

constructor

new FetchReader(path: string, rangeRequests: boolean): FetchReader
Parameters
- path: string
  the location of the PMTiles data
- rangeRequests: boolean
  FetchReader specific; enable range requests or use urlParam "bytes"
Returns FetchReader

Properties

path

path: string

the location of the PMTiles data

rangeRequests

rangeRequests: boolean

FetchReader specific; enable range requests or use urlParam "bytes"

Methods

getBigInt64

getBigInt64(_byteOffset?: number, _littleEndian?: boolean): bigint
Not applicable for FetchReader
Parameters
- Optional_byteOffset: number
  offset
- Optional_littleEndian: boolean
  le or be
Returns bigint
- 0
Implementation of Reader.getBigInt64

getBigUint64

getBigUint64(_byteOffset?: number, _littleEndian?: boolean): bigint
Not applicable for FetchReader
Parameters
- Optional_byteOffset: number
  offset
- Optional_littleEndian: boolean
  le or be
Returns bigint
- 0
Implementation of Reader.getBigUint64

getFloat32

getFloat32(_byteOffset?: number, _littleEndian?: boolean): number
Not applicable for FetchReader
Parameters
- Optional_byteOffset: number
  offset
- Optional_littleEndian: boolean
  le or be
Returns number
- 0
Implementation of Reader.getFloat32

getFloat64

getFloat64(_byteOffset?: number, _littleEndian?: boolean): number
Not applicable for FetchReader
Parameters
- Optional_byteOffset: number
  offset
- Optional_littleEndian: boolean
  le or be
Returns number
- 0
Implementation of Reader.getFloat64

getInt16

getInt16(_byteOffset?: number, _littleEndian?: boolean): number
Not applicable for FetchReader
Parameters
- Optional_byteOffset: number
  offset
- Optional_littleEndian: boolean
  le or be
Returns number
- 0
Implementation of Reader.getInt16

getInt32

getInt32(_byteOffset?: number, _littleEndian?: boolean): number
Not applicable for FetchReader
Parameters
- Optional_byteOffset: number
  offset
- Optional_littleEndian: boolean
  le or be
Returns number
- 0
Implementation of Reader.getInt32

getInt8

getInt8(_byteOffset?: number): number
Not applicable for FetchReader
Parameters
- Optional_byteOffset: number
  offset
Returns number
- 0
Implementation of Reader.getInt8

getRange

getRange(offset: number, length?: number): Promise<Uint8Array<ArrayBufferLike>>
Reads a range from the file
Parameters
- offset: number
  the offset of the range
- Optionallength: number
  the length of the range
Returns Promise<Uint8Array<ArrayBufferLike>>
- the ranged buffer
Implementation of Reader.getRange

getUint16

getUint16(_byteOffset?: number, _littleEndian?: boolean): number
Not applicable for FetchReader
Parameters
- Optional_byteOffset: number
  offset
- Optional_littleEndian: boolean
  le or be
Returns number
- 0
Implementation of Reader.getUint16

getUint32

getUint32(_byteOffset?: number, _littleEndian?: boolean): number
Not applicable for FetchReader
Parameters
- Optional_byteOffset: number
  offset
- Optional_littleEndian: boolean
  le or be
Returns number
- 0
Implementation of Reader.getUint32

getUint8

getUint8(_byteOffset?: number): number
Not applicable for FetchReader
Parameters
- Optional_byteOffset: number
  offset
Returns number
- 0
Implementation of Reader.getUint8

parseString

parseString(_byteOffset?: number, _byteLength?: number): string
Not applicable for FetchReader
Parameters
- Optional_byteOffset: number
  offset
- Optional_byteLength: number
  length
Returns string
- empty string
Implementation of Reader.parseString

seek

seek(pos?: number): void
Set the current position of the cursor
Parameters
- pos: number = 0
  where to adjust the current cursor
Returns void
Implementation of Reader.seek

seekSlice

seekSlice(_size: number): DataView
Fetch a slice at the current cursor position
Parameters
- _size: number
  size of the slice
Returns DataView
- empty DataView
Implementation of Reader.seekSlice

setStringEncoding

setStringEncoding(_encoding: string): void
Not applicable for FetchReader
Parameters
- _encoding: string
  does nothing
Returns void
Implementation of Reader.setStringEncoding

slice

slice(_begin?: number, _end?: number): DataView
Not applicable for FetchReader
Parameters
- Optional_begin: number
  beginning
- Optional_end: number
  end
Returns DataView
- empty DataView
Implementation of Reader.slice

tell

tell(): number
Returns number
- the current position of the cursor
Implementation of Reader.tell

Class FetchReader

Fetch Reader

Description

Usage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FetchReader

Properties

path

rangeRequests

Methods

getBigInt64

Parameters

Returns bigint

getBigUint64

Parameters

Returns bigint

getFloat32

Parameters

Returns number

getFloat64

Parameters

Returns number

getInt16

Parameters

Returns number

getInt32

Parameters

Returns number

getInt8

Parameters

Returns number

getRange

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

getUint16

Parameters

Returns number

getUint32

Parameters

Returns number

getUint8

Parameters

Returns number

parseString

Parameters

Returns string

seek

Parameters

Returns void

seekSlice

Parameters

Returns DataView

setStringEncoding

Parameters

Returns void

slice

Parameters

Returns DataView

tell

Returns number

Settings

On This Page