Encoding APIs

These functions are related to encoding data

encode(data) -> string

Base64 encode raw bytes. The encoding is not URL safe

Param	Type	Description
data	Uint8Array	The raw bytes to encode

decode(b64) -> Uint8Array | EncodingError

Decode a valid RFC4648 Base64 encoded string

Param	Type	Description
b64	string	A base64 encoded string

encodeBytes(data) -> Uint8Array

Convert provided string to raw bytes

Param	Type	Description
data	string	String to convert to bytes

extractUtf8String(data) -> string

Extract a UTF8 string from provided bytes

Param	Type	Description
data	Uint8Array	Raw bytes to extract UTF8 string from

extractUtf16String(data) -> string

Extract a UTF16 string from provided bytes

Param	Type	Description
data	Uint8Array	Raw bytes to extract UTF16 string from

bytesToHexString(data) -> string

Convert bytes to Hex string

Param	Type	Description
data	Uint8Array	Raw bytes to convert to hex

readXml(path) -> Record<string, unknown> | EncodingError

Read a XML file into a JSON object. Supports either UTF8 or UTF16 encoded XML files

Param	Type	Description
path	string	Path to XML file to read

generateUuid() -> string

Generates a UUID v4 hyphenated string

formatGuid(format, data) -> string

Format provided bytes into a GUID hyphenated string based on provided Endianness. Must provide exactly 16 bytes. Windows is commonly Little Endian. macOS is commonly Big Endian

Param	Type	Description
format	Endian	Endianness type LE or BE
data	Uint8Array	Raw bytes to format to GUID

parseProtobufBytes(raw_bytes) -> Record<string, unknown> | EncodingError

An experimental protobuf parser. Artemis will attempt to parse the provided protobuf bytes and return a JSON object. Binary protobuf data is a blackbox, it is typically not possible to perfectly parse protobuf data perfectly every time.

Artemis will return a JSON object if it can parse the entire data

See:

Param	Type	Description
raw_bytes	Uint8Array	Raw protobuf bytes

readCsv(path) -> Record<string, string>[] | EncodingError

Read a CSV file into a JSON object. The CSV file must have a header row.

Param	Type	Description
path	string	Path to CSV file to read
offset	number	Row to start reading at. Default is first non-header row
limit	number	How many rows to read. Default is 100

encode(data) -> string​

decode(b64) -> Uint8Array | EncodingError​

encodeBytes(data) -> Uint8Array​

extractUtf8String(data) -> string​

extractUtf16String(data) -> string​

bytesToHexString(data) -> string​

readXml(path) -> Record<string, unknown> | EncodingError​

generateUuid() -> string​

formatGuid(format, data) -> string​

parseProtobufBytes(raw_bytes) -> Record<string, unknown> | EncodingError​

readCsv(path) -> Record<string, string>[] | EncodingError​