gis-tools-ts - v0.6.0
    Preparing search index...

    Class MMapReader

    MMap Reader

    Reads data from a file implementing the Reader interface

    import { MMapReader } from 'gis-tools/mmap-ts';

    const reader = new MMapReader('./BETA2007.gsb');

    Implements

    Index

    Constructors

    • Parameters

      • file: string

        The path to the file

      Returns MMapReader

    Methods

    • Reads a 64-bit unsigned integer (biguint64) at the given byteOffset

      Parameters

      • byteOffset: number = ...

        The position in the file to read from

      • littleEndian: boolean = false

        Optional, specifies if the value is stored in little-endian format. Defaults to false (big-endian).

      Returns bigint

      The 64-bit unsigned integer as a bigint

    • Reads a 64-bit unsigned integer (biguint64) at the given byteOffset

      Parameters

      • byteOffset: number = ...

        The position in the file to read from

      • littleEndian: boolean = false

        Optional, specifies if the value is stored in little-endian format. Defaults to false (big-endian).

      Returns bigint

      The 64-bit unsigned integer as a bigint

    • Reads a 32-bit floating-point number (float32) at the given byteOffset

      Parameters

      • byteOffset: number = ...

        The position in the file to read from

      • littleEndian: boolean = false

        Optional, specifies if the value is stored in little-endian format. Defaults to false (big-endian).

      Returns number

      The 32-bit floating-point number as a number

    • Reads a 64-bit floating-point number (float64) at the given byteOffset

      Parameters

      • byteOffset: number = ...

        The position in the file to read from

      • littleEndian: boolean = false

        Optional, specifies if the value is stored in little-endian format. Defaults to false (big-endian).

      Returns number

      The 64-bit floating-point number as a number

    • Reads a signed 16-bit integer (int16) at the given byteOffset

      Parameters

      • byteOffset: number = ...

        The position in the file to read from

      • littleEndian: boolean = false

        Optional, specifies if the value is stored in little-endian format. Defaults to false (big-endian).

      Returns number

      The 16-bit signed integer value as a number

    • Reads a signed 32-bit integer (int32) at the given byteOffset

      Parameters

      • byteOffset: number = ...

        The position in the file to read from

      • littleEndian: boolean = false

        Optional, specifies if the value is stored in little-endian format. Defaults to false (big-endian).

      Returns number

      The 32-bit signed integer value as a number

    • Reads a signed byte (int8) at the given byteOffset

      Parameters

      • byteOffset: number = ...

        The position in the file to read from

      Returns number

      The byte value as a signed number

    • Reads a range from the buffer

      Parameters

      • offset: number

        the offset of the range

      • length: number

        the length of the range

      Returns Promise<Uint8Array<ArrayBufferLike>>

      • the ranged buffer
    • Reads an unsigned 16-bit integer (uint16) at the given byteOffset

      Parameters

      • byteOffset: number = ...

        The position in the file to read from

      • littleEndian: boolean = false

        Optional, specifies if the value is stored in little-endian format. Defaults to false (big-endian).

      Returns number

      The 16-bit unsigned integer value as a number

    • Reads an unsigned 32-bit integer (uint32) at the given byteOffset

      Parameters

      • byteOffset: number = ...

        The position in the file to read from

      • littleEndian: boolean = false

        Optional, specifies if the value is stored in little-endian format. Defaults to false (big-endian).

      Returns number

      The 32-bit unsigned integer value as a number

    • Reads a single byte at the given byteOffset

      Parameters

      • byteOffset: number = ...

        The position in the file to read from

      Returns number

      The byte value as a number

    • Reads a string from the buffer

      Parameters

      • byteOffset: number = ...

        Start of the string

      • byteLength: number = ...

        Length of the string

      Returns string

      • The string
    • Set the current position of the cursor

      Parameters

      • pos: number = 0

        where to adjust the current cursor

      Returns void

    • Fetch a slice at the current cursor position. The cursor is updated

      Parameters

      • size: number

        size of the slice

      Returns DataView

      • a DataView of the slice
    • Set the text decoder's encoding

      Parameters

      • encoding: string

        update the text decoder's encoding

      Returns void

    • Get a slice of the file data as DataView

      Parameters

      • begin: number = ...

        Beginning of the slice

      • end: number = ...

        End of the slice. If not provided, the end of the data is used

      Returns DataView

      • The data as a DataView
    • Returns number

      • the current position of the cursor