Class Parser

helper to read in Duplex stream

Hierarchy

Parser

Index

Constructors

Properties

ended lastMessage stream

Methods

end raw readAll readAscii readByteFlow readBytes readCode readError readLine readUntil readValue searchLine unexpected

Constructors

constructor

new Parser(stream: Duplex): Parser
Parameters
- stream: Duplex
Returns Parser
- Defined in src/adb/parser.ts:13

Properties

`Private` ended

ended: boolean = false

lastMessage

lastMessage: string = ''

stream

stream: Duplex

Methods

end

end(): Promise<true>
read and drop all remaining data in stream

Returns

Returns Promise<true>
- Defined in src/adb/parser.ts:21

raw

raw(): Duplex
Returns
the internal Duplex

Returns Duplex
- Defined in src/adb/parser.ts:54

readAll

readAll(): Promise<Buffer>
Returns Promise<Buffer>
- Defined in src/adb/parser.ts:58

readAscii

readAscii(howMany: number): Promise<string>
Parameters
- howMany: number
Returns Promise<string>
- Defined in src/adb/parser.ts:94

readByteFlow

readByteFlow(howMany: number, targetStream: Duplex): Promise<void>
pipe howMany bytes to targetStream

Returns
Promise that resolves when all bytes are transferred
Parameters
- howMany: number
  
  bytes to transfer
- targetStream: Duplex
  
  destination stream
Returns Promise<void>
- Defined in src/adb/parser.ts:161

readBytes

readBytes(howMany: number): Promise<Buffer>
Parameters
- howMany: number
Returns Promise<Buffer>
- Defined in src/adb/parser.ts:114

readCode

readCode(...codes: string[]): Promise<string>
should read code or failed the correct fail exception will be thow in case of error.
Parameters
- Rest ...codes: string[]
  
  the expected 4 char code to read
Returns Promise<string>
- Defined in src/adb/parser.ts:104

readError

readError(): Promise<AdbError>
Returns Promise<AdbError>
- Defined in src/adb/parser.ts:222

readLine

readLine(encoding?: BufferEncoding): Promise<string>
read socket until \r\n

Returns
Parameters
- Optional encoding: BufferEncoding
Returns Promise<string>
- Defined in src/adb/parser.ts:286

readUntil

readUntil(code: number): Promise<Buffer>
read stream byte per byte until a delimiter is found

Returns
buffer wothout delimiter
Parameters
- code: number
  
  delimiter
Returns Promise<Buffer>
- Defined in src/adb/parser.ts:260

readValue

readValue(): Promise<Buffer>
Returns
read a 4-ASCII digits length-prefixed data block

Returns Promise<Buffer>
- Defined in src/adb/parser.ts:243
readValue(encoding: BufferEncoding): Promise<string>
Parameters
- encoding: BufferEncoding
Returns Promise<string>
- Defined in src/adb/parser.ts:244

searchLine

searchLine(re: RegExp): Promise<RegExpExecArray>
Parameters
- re: RegExp
Returns Promise<RegExpExecArray>
- Defined in src/adb/parser.ts:272

unexpected

unexpected(data: string, expected: string): AdbUnexpectedDataError
Parameters
- data: string
- expected: string
Returns AdbUnexpectedDataError
- Defined in src/adb/parser.ts:297

Generated using TypeDoc