docs(msgpack): complete documentation of the package (#4832)

msgpack/decode.ts

@@ -6,14 +6,19 @@ import type { ValueType } from "./encode.ts";
 /**
  * Decode a value from the MessagePack binary format.
  *
- * @example
+ * If the input is not in valid message pack format, an error will be thrown.
+ *
+ * @example Decode a value from the MessagePack binary format
  * ```ts
  * import { decode } from "@std/msgpack/decode";
  *
- * const encoded = Uint8Array.of(1, 2, 3)
+ * const encoded = new Uint8Array([1, 2, 3])
  *
  * console.log(decode(encoded))
  * ```
+ *
+ * @param uint8 Uint8Array containing the MessagePack binary data.
+ * @returns Decoded value from the MessagePack binary data.
  */
 export function decode(uint8: Uint8Array): ValueType {
   const pointer = { consumed: 0 };

msgpack/encode.ts

@@ -20,9 +20,6 @@ export type ValueType =
  * Value map that can be encoded to MessagePack.
  */
 export interface ValueMap {
-  /**
-   * Value types that can be encoded to MessagePack.
-   */
   [index: string | number]: ValueType;
 }
 
@@ -42,7 +39,7 @@ const encoder = new TextEncoder();
 /**
  * Encode a value to MessagePack binary format.
  *
- * @example
+ * @example Encode a value to MessagePack binary format
  * ```ts
  * import { encode } from "@std/msgpack/encode";
  *
@@ -56,6 +53,9 @@ const encoder = new TextEncoder();
  *
  * console.log(encode(obj))
  * ```
+ *
+ * @param object Value to encode to MessagePack binary format.
+ * @returns Encoded MessagePack binary data.
  */
 export function encode(object: ValueType): Uint8Array {
   const byteParts: Uint8Array[] = [];

msgpack/mod.ts

@@ -1,5 +1,47 @@
 // Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
 // This module is browser compatible.
 
+/**
+ * MessagePack is an efficient binary serialization format that is language
+ * agnostic. It is like JSON, but generally produces much smaller payloads.
+ * [Learn more about MessagePack](https://msgpack.org/).
+ *
+ * This module provides functions to encode and decode MessagePack.
+ *
+ * ```ts
+ * import { decode, encode } from "@std/msgpack";
+ * import { assertEquals } from "@std/assert"
+ *
+ * const obj = {
+ *   str: "deno",
+ *   arr: [1, 2, 3],
+ *   bool: true,
+ *   nil: null,
+ *   map: {
+ *     foo: "bar"
+ *   }
+ * };
+ *
+ * const encoded = encode(obj);
+ * console.log(encoded); // Uint8Array(42) [...]
+ *
+ * const decoded = decode(encoded);
+ * assertEquals(decoded, obj);
+ * ```
+ *
+ * MessagePack supports encoding and decoding the following types:
+ *
+ * - `number`
+ * - `bigint`
+ * - `string`
+ * - `boolean`
+ * - `null`
+ * - `Uint8Array`
+ * - arrays of values of these types
+ * - objects with string or number keys, and values of these types
+ *
+ * @module
+ */
+
 export * from "./decode.ts";
 export * from "./encode.ts";