Class Optional

Hierarchy

DataType
- Optional

Index

Constructors

Methods

getType read write

Constructors

constructor

new Optional(..._arguments_: unknown[]): Optional
Creates a new data type.
Parameters
- ..._arguments_: unknown[]
Returns Optional
Inherited from DataType.constructor
- Defined in packages/raknet/dist/index.d.ts:14

Methods

`Static`getType

getType(value: unknown): undefined | ValidTypes
Parameters
- value: unknown
Returns undefined | ValidTypes
- Defined in packages/protocol/src/proto/types/optional.ts:85

`Static`read

read<T extends typeof DataType>(
    stream: BinaryStream,
    endian?: Endianness,
    parameter?: unknown,
    type?: T | ValidTypes,
): unknown
Reads the data type from a binary stream.
Type Parameters
- T extends typeof DataType
Parameters
- stream: BinaryStream
- Optionalendian: Endianness
- Optionalparameter: unknown
- Optionaltype: T | ValidTypes
Returns unknown
The data type.
Overrides DataType.read
- Defined in packages/protocol/src/proto/types/optional.ts:16

`Static`write

write<T extends typeof DataType>(
    stream: BinaryStream,
    value: unknown,
    endian?: Endianness,
    parameter?: unknown,
    type?: ValidTypes | T,
): void
Writes the data type to a binary stream.
Type Parameters
- T extends typeof DataType
Parameters
- stream: BinaryStream
- value: unknown
- Optionalendian: Endianness
- Optionalparameter: unknown
- Optionaltype: ValidTypes | T
Returns void
Overrides DataType.write
- Defined in packages/protocol/src/proto/types/optional.ts:50