close
Skip to main content
Home
Browse packagesDocs
ImageSign In with GitHubImageSign In with GitLab

@std/encoding@1.0.10
Built and signed on GitHub Actions

latest
denoland/std
Works with
This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
•JSR Score100%•
Downloads23,474/wk
•
Publisheda year ago (1.0.10)

Utilities for encoding and decoding common formats like hex, base64, and varint

Functions

f
decodeAscii85(
ascii85: string,
options?: DecodeAscii85Options
): Uint8Array_

Decodes a ascii85-encoded string.

f
decodeBase32(b32: string): Uint8Array_

Decodes a base32-encoded string.

f
decodeBase58(b58: string): Uint8Array_

Decodes a base58-encoded string.

f
decodeBase64(b64: string): Uint8Array_

Decodes a base64-encoded string.

f
decodeBase64Url(b64url: string): Uint8Array_

Decodes a given base64url-encoded string.

f
decodeHex(src: string): Uint8Array_

Decodes the given hex-encoded string. If the input is malformed, an error is thrown.

f
decodeVarint(
buf: Uint8Array,
offset?: number
): [bigint, number]

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

f
decodeVarint32(
buf: Uint8Array,
offset?: number
): [number, number]

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.

f
encodeAscii85(
data: ArrayBuffer | Uint8Array | string,
options?: EncodeAscii85Options
): string

Converts data into an ascii85-encoded string.

f
encodeBase32(data: ArrayBuffer | Uint8Array | string): string

Converts data into a base32-encoded string.

f
encodeBase58(data: ArrayBuffer | Uint8Array | string): string

Converts data into a base58-encoded string.

f
encodeBase64(data: ArrayBuffer | Uint8Array | string): string

Converts data into a base64-encoded string.

f
encodeBase64Url(data: ArrayBuffer | Uint8Array | string): string

Convert data into a base64url-encoded string.

f
encodeHex(src: string | Uint8Array | ArrayBuffer): string

Converts data into a hex-encoded string.

f
encodeVarint(
num: bigint | number,
buf?: Uint8Array,
offset?: number
): [Uint8Array_, number]

Takes unsigned number num and converts it into a Varint encoded Uint8Array, returning a tuple consisting of a Uint8Array slice of the encoded Varint, and an offset where the Varint encoded bytes end within the Uint8Array.

Interfaces

I
EncodeAscii85Options

Options for encodeAscii85.

  • delimiter: boolean

    Whether to use a delimiter (if supported).

  • standard: Ascii85Standard

    Character set and delimiter (if supported and used).

Type Aliases

T
Ascii85Standard = "Adobe" | "btoa" | "RFC 1924" | "Z85"

Supported ascii85 standards for EncodeAscii85Options and DecodeAscii85Options.

T
DecodeAscii85Options = Omit<EncodeAscii85Options, "delimiter">

Options for decodeAscii85.

Variables

v
MaxUint64: 18446744073709551615

The maximum value of an unsigned 64-bit integer. Equivalent to 2n**64n - 1n

v
MaxVarintLen32: 5

The maximum length, in bytes, of a Varint encoded 32-bit integer.

v
MaxVarintLen64: 10

The maximum length, in bytes, of a Varint encoded 64-bit integer.

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@std/encoding

Import symbol

import * as mod from "@std/encoding";
or

Import directly with a jsr specifier

import * as mod from "jsr:@std/encoding";