/mod.ts | cbor_redux@1.0.0

import * as cborRedux from "https://deno.land/x/cbor_redux@1.0.0/mod.ts";

Classes

c Sequence	Class for containing a CBOR Sequence; used for encoding and decoding.
c SimpleValue	Class for structuring a simple value. Unassigned or reserved simple values are emitted as an instance of this class during decoding. This allows an application to handle custom decoding in the `reviver` function of the decoder.
c TaggedValue	Class for structuring a tagged value. Tags which are not JavaScript typed arrays are emitted as an instance of this class during decoding. This allows an application to handle tagged values in the `reviver` function of the decoder. Values which are a valid CBOR type will be decoded and assigned to the `TaggedValue.value` property.

v CBOR	An intrinsic object that provides functions to convert JavaScript values to and from the Concise Binary Object Representation (CBOR) format.
v EMPTY_KEY	A symbol which is emitted by the `reviver` and `replacer` functions when a value is not associated with a key or CBOR label. In JSON, a value with no key simply emits an empty string; this would be indistinguishable from a valid CBOR data sequence. Using a symbol acheives emitting a comparable value without the value being a valid CBOR data type.
v OMIT_VALUE	A symbol which may be returned by the user in the encoder's `replacer` function to omit values. Just like detecting an empty key, using a symbol acheives emitting a comparable value without the value being a valid CBOR data type. Use this in a custom replacer function as the return value to indicate to the encoder that the value is to be skipped from arrays and dictionaries.

f binarify	Alias of `encode`. Converts a JavaScript value to a Concise Binary Object Representation (CBOR) buffer.
f decode	Converts a Concise Binary Object Representation (CBOR) buffer into an object.
f encode	Converts a JavaScript value to a Concise Binary Object Representation (CBOR) buffer.
f parse	Alias of `decode`. Converts a Concise Binary Object Representation (CBOR) buffer into an object.

I CBOROptions	Options for the decoder.
I CBORSequenceOptions	Narrow options for the decoder when using CBOR Sequences.

T CBORReplacer	A function to modify the behavior of the encoder; to omit values, return the `OMIT_VALUE` symbol.
T CBORReviver	A function to modify values which are encountered during decoding.
T DictionaryOption	Indicates that the decorder should use either Object or Map as the key/value dictionary.
T ModeOption	Indicates that the decoder should loosely accept all keys, striictly fail on duplicate keys, or strictly decode CBOR Sequences (RFC 8742).