Class PluginOutput

PluginOutput is a view around some memory exposed by the plugin. Typically returned by plugin.call() or * | callContext.read(). It implements the read side of DataView along with methods for reading string and JSON data out of the backing buffer.

Hierarchy

  • DataView
    • PluginOutput

Properties

#bytes [toStringTag] buffer byteLength byteOffset #decoder

Methods

arrayBuffer bytes getBigInt64 getBigUint64 getFloat32 getFloat64 getInt16 getInt32 getInt8 getUint16 getUint32 getUint8 json setBigInt64 setBigUint64 setFloat32 setFloat64 setInt16 setInt32 setInt8 setUint16 setUint32 setUint8 text

Properties

Private #bytes

#bytes: null | Uint8Array = null

Readonly [toStringTag]

[toStringTag]: string

Readonly buffer

buffer: ArrayBuffer

Readonly byteLength

byteLength: number

Readonly byteOffset

byteOffset: number

Static Private #decoder

#decoder: TextDecoder = ...

Methods

arrayBuffer

bytes

getBigInt64

  • Gets the BigInt64 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

    Parameters

    • byteOffset: number

      The place in the buffer at which the value should be retrieved.

    • Optional littleEndian: boolean

      If false or undefined, a big-endian value should be read.

    Returns bigint

getBigUint64

  • Gets the BigUint64 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

    Parameters

    • byteOffset: number

      The place in the buffer at which the value should be retrieved.

    • Optional littleEndian: boolean

      If false or undefined, a big-endian value should be read.

    Returns bigint

getFloat32

  • Gets the Float32 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

    Parameters

    • byteOffset: number

      The place in the buffer at which the value should be retrieved.

    • Optional littleEndian: boolean

      If false or undefined, a big-endian value should be read.

    Returns number

getFloat64

  • Gets the Float64 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

    Parameters

    • byteOffset: number

      The place in the buffer at which the value should be retrieved.

    • Optional littleEndian: boolean

      If false or undefined, a big-endian value should be read.

    Returns number

getInt16

  • Gets the Int16 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

    Parameters

    • byteOffset: number

      The place in the buffer at which the value should be retrieved.

    • Optional littleEndian: boolean

      If false or undefined, a big-endian value should be read.

    Returns number

getInt32

  • Gets the Int32 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

    Parameters

    • byteOffset: number

      The place in the buffer at which the value should be retrieved.

    • Optional littleEndian: boolean

      If false or undefined, a big-endian value should be read.

    Returns number

getInt8

  • Gets the Int8 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

    Parameters

    • byteOffset: number

      The place in the buffer at which the value should be retrieved.

    Returns number

getUint16

  • Gets the Uint16 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

    Parameters

    • byteOffset: number

      The place in the buffer at which the value should be retrieved.

    • Optional littleEndian: boolean

      If false or undefined, a big-endian value should be read.

    Returns number

getUint32

  • Gets the Uint32 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

    Parameters

    • byteOffset: number

      The place in the buffer at which the value should be retrieved.

    • Optional littleEndian: boolean

      If false or undefined, a big-endian value should be read.

    Returns number

getUint8

  • Gets the Uint8 value at the specified byte offset from the start of the view. There is no alignment constraint; multi-byte values may be fetched from any offset.

    Parameters

    • byteOffset: number

      The place in the buffer at which the value should be retrieved.

    Returns number

json

setBigInt64

  • Parameters

    • _byteOffset: number
    • _value: bigint
    • Optional _littleEndian: boolean

    Returns void

setBigUint64

  • Parameters

    • _byteOffset: number
    • _value: bigint
    • Optional _littleEndian: boolean

    Returns void

setFloat32

  • Parameters

    • _byteOffset: number
    • _value: number
    • Optional _littleEndian: boolean

    Returns void

setFloat64

  • Parameters

    • _byteOffset: number
    • _value: number
    • Optional _littleEndian: boolean

    Returns void

setInt16

  • Parameters

    • _byteOffset: number
    • _value: number
    • Optional _littleEndian: boolean

    Returns void

setInt32

  • Parameters

    • _byteOffset: number
    • _value: number
    • Optional _littleEndian: boolean

    Returns void

setInt8

  • Parameters

    • _byteOffset: number
    • _value: number

    Returns void

setUint16

  • Parameters

    • _byteOffset: number
    • _value: number
    • Optional _littleEndian: boolean

    Returns void

setUint32

  • Parameters

    • _byteOffset: number
    • _value: number
    • Optional _littleEndian: boolean

    Returns void

setUint8

  • Parameters

    • _byteOffset: number
    • _value: number

    Returns void

text

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc