Interface ReadOpts<F>

interface ReadOpts<F = FieldType> {
convert?(value: F, name: string, temp: boolean): unknown;
temp?: boolean;
}

Type Parameters

F = FieldType

Index

Properties

Methods

Properties

`Optional`temp

temp?: boolean

If true, write to temp instead of packet.

Methods

`Optional`convert

convert?(value: F, name: string, temp: boolean): unknown
If specified, run the results through the given function before storing.
Parameters
- value: F
  Original read value.
- name: string
  The field being stored to. May be ignored.
- temp: boolean
  Is the field being stored to in temp rather than packet?
Returns unknown
Converted value.
- Defined in packet.ts:37