/mod.ts | bencodex@0.2.2

import * as bencodex from "https://deno.land/x/bencodex@0.2.2/mod.ts";

This façade module exports the public API of this package.

Examples

Encoding a Bencodex list and decoding it back

const encoded = encode(new Map([["foo", 123n]]));
const decoded = decode(encoded);

c BencodexDictionary	A Dictionary implementation that complies with the Bencodex specification. Unlike Map, this implementation allows only keys of type Key and values of type Value, and in particular, it actually compares Uint8Array keys by their contents instead of their references.
c DecodingError	An exception that is thrown when an error occurs while decoding a Bencodex.
c RecordView	A view of a RecordValue that implements Dictionary. It is a handy way to construct a Dictionary using JavaScript's object literal syntax.

f areDictionariesEqual	Checks if the given Bencodex dictionaries have the same keys and the same associated values. In other words, this function checks if the given dictionaries are encoded in the same Bencodex data.
f areKeysEqual	Checks if the given keys have the same type and the same contents. In other words, this function checks if the given keys are encoded in the same Bencodex data.
f areValuesEqual	Checks if the given Bencodex values have the same type and the same contents. In other words, this function checks if the given values are encoded in the same Bencodex data.
f decode	Decodes a Bencodex value from the given buffer.
f decodeValue	Decodes a Bencodex value from the given buffer.
f encode	Encodes a Bencodex value and returns the encoded bytes.
f encodeInto	Encodes a value into the given buffer.
f estimateSize	Estimates the byte size of the given value in Bencodex.
f isDictionary	Checks if the given value is a Bencodex dictionary.
f isKey	Checks if the given value can be used as a key in a Bencodex dictionary.
f isRecordValue	A type guard predicate that checks if the given value is a RecordValue.

I DecodingOptions	Options for decoding a Bencodex value.
I Dictionary	Represents a Bencodex dictionary. It basically behaves like a read-only `Map<Key, Value>`, but it is not necessarily a `Map` instance.
I EncodingOptions	Options for encode function.
I NonAllocEncodingOptions	Options for encodeInto and encodeKeyInto functions.
I RecordValue	A record object that represents a Bencodex dictionary.

T DecodingErrorKind	Represents an error that can occur while decoding a Bencodex value.
T DecodingState	Represents the end-state of decoding.
T Key	Represents a value which can be used as a key in a Bencodex dictionary. It is either a string ("text" in Bencodex) or a `Unit8Array` instance ("binary" in Bencodex).
T Value	Represents a value which can be encoded in Bencodex. Each data type in Bencodex has its corresponding type in JavaScript: