Ascii

Defined in: astrobase/src/ascii/ascii.ts:20

Parses a NUL terminated ASCII string within binary.

Example

import { Ascii } from '@astrobase/sdk/ascii';

const bytes = [72, 101, 108, 108, 111, 0];
const offset = 0;

const ascii = new Ascii(bytes, offset);

console.log(ascii.value); // 'Hello'
console.log(ascii.encodingEnd); // 5

Constructors

Constructor

new Ascii(buffer, encodingStart): Ascii

Defined in: astrobase/src/ascii/ascii.ts:23

Parameters

buffer

The binary containing the ASCII string.

ArrayBufferLike | ArrayLike<number>

encodingStart

number = 0

The byte index where the ASCII string begins. Defaults to the start of the buffer.

Returns

Ascii

Properties

encodingStart

readonly encodingStart: number = 0

Defined in: astrobase/src/ascii/ascii.ts:27

The byte index where the ASCII string begins. Defaults to the start of the buffer.

Accessors

encodingEnd

Get Signature

get encodingEnd(): number

Defined in: astrobase/src/ascii/ascii.ts:37

The byte index of the NUL terminator byte.

Throws

RangeError if the end of the buffer was reached without finding the terminator.

Returns

number

---

value

Get Signature

get value(): string

Defined in: astrobase/src/ascii/ascii.ts:51

The ASCII encoded value as a string.

Throws

RangeError if the end of the buffer was reached without finding the terminator.

Returns

string