Skip to main content
Module

std/encoding/varint.ts>decodeVarint32

The Deno Standard Library
Go to Latest
function decodeVarint32
import { decodeVarint32 } from "https://deno.land/std@0.223.0/encoding/varint.ts";

Given a buf, starting at offset (default: 0), begin decoding bytes as VarInt encoded bytes, for a maximum of 5 bytes (offset + 5). The returned tuple is of the decoded varint 32-bit number, and the new offset with which to continue decoding other data.

VarInts are not 32-bit by default so this should only be used in cases where the varint is assured to be 32-bits. If in doubt, use decode().

To know how many bytes the VarInt took to encode, simply negate offset from the returned new offset.

Examples

Example 1

import { decodeVarint32 } from "https://deno.land/std@0.223.0/encoding/varint.ts";

const buf = new Uint8Array([0x8E, 0x02]);
decodeVarint32(buf); // [ 300, 2 ];

Parameters

buf: Uint8Array

The buffer to decode from.

optional
offset = [UNSUPPORTED]

The offset to start decoding from.

Returns

[number, number]

A tuple of the decoded varint 32-bit number, and the new offset.