Class TextSource

Hierarchy

DataType
- TextSource

Index

Constructors

Methods

Constructors

constructor

new TextSource(..._: unknown[]): TextSource
Default constructor for DataType.
Parameters
- ..._: unknown[]
Returns TextSource
Inherited from DataType.constructor
- Defined in node_modules/@serenityjs/binarystream/dist/index.d.ts:272

Methods

`Static`read

read(
stream: BinaryStream,
options: PacketDataTypeOptions<TextPacketType>,
): null | string
Read a value from the stream.
Parameters
- stream: BinaryStream
  The BinaryStream to read from.
- options: PacketDataTypeOptions<TextPacketType>
  Options for reading the data type, such as endianness.
Returns null | string
The value read from the stream.
Overrides DataType.read
- Defined in packages/protocol/src/proto/types/text-source.ts:7

`Static`write

write(
    stream: BinaryStream,
    value: string,
    options: PacketDataTypeOptions<TextPacketType>,
): void
Write a value to the stream.
Parameters
- stream: BinaryStream
  The BinaryStream to write to.
- value: string
  The value to write.
- options: PacketDataTypeOptions<TextPacketType>
  Options for writing the data type, such as endianness.
Returns void
Overrides DataType.write
- Defined in packages/protocol/src/proto/types/text-source.ts:19