Add since JSDoc descriptors

Author: mdingena

src/BinaryData.ts

@@ -26,6 +26,7 @@ const SIGNED_INTEGER_OFFSET = 2147483648;
  * Deals with data types as understood by _A Township Tale_ game servers.
  *
  * @see [Class: `BinaryData`](https://github.com/mdingena/att-string-transcoder/tree/main/docs/BinaryData.md)
+ * @since v3.0.0
  *
  * @example
  * import { BinaryData } from 'att-string-transcoder';
@@ -59,6 +60,7 @@ export class BinaryData {
    * types. You may optionally provide additional options in the second argument.
    *
    * @see [Class: `BinaryData`](https://github.com/mdingena/att-string-transcoder/tree/main/docs/BinaryData.md)
+   * @since v3.0.0
    *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
@@ -79,6 +81,8 @@ export class BinaryData {
   /**
    * Creates a BinaryData instance from the given boolean.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -93,6 +97,8 @@ export class BinaryData {
   /**
    * Creates a BinaryData instance from the given character.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -108,6 +114,8 @@ export class BinaryData {
   /**
    * Creates a BinaryData instance from the given floating point number.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -122,6 +130,8 @@ export class BinaryData {
   /**
    * Creates a BinaryData instance from the given number.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -136,6 +146,8 @@ export class BinaryData {
   /**
    * Creates a BinaryData instance from the given signed integer.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -158,6 +170,8 @@ export class BinaryData {
   /**
    * Creates a BinaryData instance from the given unsigned integer.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -172,6 +186,8 @@ export class BinaryData {
   /**
    * Creates a BinaryData instance from the given comma-separated array of unsigned integers.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -188,6 +204,8 @@ export class BinaryData {
   /**
    * Creates a BinaryData instance from the given unsigned long integer.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -203,6 +221,8 @@ export class BinaryData {
   /**
    * Creates a BinaryData instance from the given unsigned short integer.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -217,6 +237,8 @@ export class BinaryData {
   /**
    * Confirms whether `data` is a string of binary data, i.e. a string of zeroes and ones.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -239,6 +261,8 @@ export class BinaryData {
    * This is also a type assertion function, so if the passed `string` is asserted as a
    * `BinaryString`, it will be considered as such after calling this function.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -261,6 +285,8 @@ export class BinaryData {
   /**
    * Converts a JavaScript floating point number into an IEEE754 integer.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -287,6 +313,8 @@ export class BinaryData {
   /**
    * Returns the binary data as a `BinaryString`.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -302,6 +330,8 @@ export class BinaryData {
   /**
    * Returns the boolean represenation of the binary data.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -319,6 +349,8 @@ export class BinaryData {
   /**
    * Returns the character represenation of the binary data.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -336,6 +368,8 @@ export class BinaryData {
   /**
    * Returns the floating point number represenation of the binary data.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -355,6 +389,8 @@ export class BinaryData {
   /**
    * Returns the numeric represenation of the binary data.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -370,6 +406,8 @@ export class BinaryData {
   /**
    * Returns the signed integer representation of the binary data.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -390,6 +428,8 @@ export class BinaryData {
   /**
    * Returns the unsigned integer representation of the binary data.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -407,6 +447,8 @@ export class BinaryData {
   /**
    * Returns the binary data as a comma-separated array of unsigned integers.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -426,6 +468,8 @@ export class BinaryData {
   /**
    * Returns the unsigned long integer representation of the binary data.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -443,6 +487,8 @@ export class BinaryData {
   /**
    * Returns the unsigned short integer representation of the binary data.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *
@@ -460,6 +506,8 @@ export class BinaryData {
   /**
    * Converts an IEEE754 integer into a JavaScript floating point number.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryData } from 'att-string-transcoder';
    *

src/BinaryReader.ts

@@ -6,6 +6,7 @@ import { BinaryData, type BinaryDataOptions } from './BinaryData.js';
  * Handles the controlled consumption of binary data from ATT save strings.
  *
  * @see [Class: `BinaryReader`](https://github.com/mdingena/att-string-transcoder/tree/main/docs/BinaryReader.md)
+ * @since v3.0.0
  *
  * @example
  * import { BinaryReader } from 'att-string-transcoder';
@@ -24,6 +25,7 @@ export class BinaryReader {
    * Creates a reader to extract information from `data` using various read methods.
    *
    * @see [Class: `BinaryReader`](https://github.com/mdingena/att-string-transcoder/tree/main/docs/BinaryReader.md)
+   * @since v3.0.0
    *
    * @example
    * import { BinaryReader } from 'att-string-transcoder';
@@ -42,6 +44,8 @@ export class BinaryReader {
   /**
    * Reads the next `bitCount` bits from the binary string.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryReader } from 'att-string-transcoder';
    *
@@ -63,6 +67,8 @@ export class BinaryReader {
   /**
    * Reads the next bit from the binary string and returns `true` for `"1"` and `false` for `"0"`.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryReader } from 'att-string-transcoder';
    *
@@ -82,6 +88,8 @@ export class BinaryReader {
   /**
    * Reads the next 8 bits from the binary string and returns the reconstructed string character.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryReader } from 'att-string-transcoder';
    *
@@ -105,6 +113,8 @@ export class BinaryReader {
   /**
    * Reads the next 32 bits from the binary string and returns the reconstructed floating point number.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryReader } from 'att-string-transcoder';
    *
@@ -122,6 +132,8 @@ export class BinaryReader {
   /**
    * Reads the next 32 bits from the binary string and returns the reconstructed signed integer.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryReader } from 'att-string-transcoder';
    *
@@ -140,6 +152,8 @@ export class BinaryReader {
    * Reads the next 16 bits from the binary string, then reads the number of bits as instructed and
    * returns the reconstructed string text.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryReader } from 'att-string-transcoder';
    *
@@ -193,6 +207,8 @@ export class BinaryReader {
   /**
    * Reads the next 32 bits from the binary string and returns the reconstructed unsigned integer.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryReader } from 'att-string-transcoder';
    *
@@ -210,6 +226,8 @@ export class BinaryReader {
   /**
    * Reads the next 64 bits from the binary string and returns the reconstructed unsigned long integer.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryReader } from 'att-string-transcoder';
    *
@@ -227,6 +245,8 @@ export class BinaryReader {
   /**
    * Reads the next 16 bits from the binary string and returns the reconstructed unsigned short integer.
    *
+   * @since v3.0.0
+   *
    * @example
    * import { BinaryReader } from 'att-string-transcoder';
    *