Class Word

Hierarchy

Word

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Word(word: string, size?: undefined | number): Word

- Defined in src/transport/protocol/Word.ts:9
Parameters
- word: string
- Optional size: undefined | number
Returns Word

Properties

Readonly size

size: number

Readonly word

word: string

Static CONTENT_OFFSET

CONTENT_OFFSET: number = 4

Static SIZE_LEN

SIZE_LEN: number = 4

Static SIZE_OFFSET

SIZE_OFFSET: number = 0

Static TERMINATOR_LEN

TERMINATOR_LEN: number = 1

Methods

toBoolean

toBoolean(): boolean

- Defined in src/transport/protocol/Word.ts:27
retrieves the response as boolean

Returns boolean

toBuffer

toBuffer(): Buffer

- Defined in src/transport/protocol/Word.ts:32
returns a copy of the word as buffer

Returns Buffer

toNumber

toNumber(): number

- Defined in src/transport/protocol/Word.ts:22
retrieves the response as number

Returns number

toString

toString(): string

- Defined in src/transport/protocol/Word.ts:17
retrieves the response as string

Returns string

Static from

from(buffer: Buffer): Word

- Defined in src/transport/protocol/Word.ts:45
creates a new word based on the command

Parameters
- buffer: Buffer
Returns Word

Static getSize

getSize(word: string): number

- Defined in src/transport/protocol/Word.ts:40
gets the total size of the for this word

Parameters
- word: string
Returns number

Generated using TypeDoc