docs(NODE-4158): Annotate BSON classes with a category (#496)

src/binary.ts

@@ -25,6 +25,7 @@ export interface BinaryExtended {
 /**
  * A class representation of the BSON Binary type.
  * @public
+ * @category BSONType
  */
 export class Binary {
   _bsontype!: 'Binary';

src/code.ts

@@ -9,6 +9,7 @@ export interface CodeExtended {
 /**
  * A class representation of the BSON Code type.
  * @public
+ * @category BSONType
  */
 export class Code {
   _bsontype!: 'Code';

src/db_ref.ts

@@ -23,6 +23,7 @@ export function isDBRefLike(value: unknown): value is DBRefLike {
 /**
  * A class representation of the BSON DBRef type.
  * @public
+ * @category BSONType
  */
 export class DBRef {
   _bsontype!: 'DBRef';

src/decimal128.ts

@@ -118,6 +118,7 @@ export interface Decimal128Extended {
 /**
  * A class representation of the BSON Decimal128 type.
  * @public
+ * @category BSONType
  */
 export class Decimal128 {
   _bsontype!: 'Decimal128';

src/double.ts

@@ -8,6 +8,7 @@ export interface DoubleExtended {
 /**
  * A class representation of the BSON Double type.
  * @public
+ * @category BSONType
  */
 export class Double {
   _bsontype!: 'Double';

src/int_32.ts

@@ -8,6 +8,7 @@ export interface Int32Extended {
 /**
  * A class representation of a BSON Int32 type.
  * @public
+ * @category BSONType
  */
 export class Int32 {
   _bsontype!: 'Int32';

src/long.ts

@@ -58,6 +58,7 @@ export interface LongExtended {
 /**
  * A class representing a 64-bit integer
  * @public
+ * @category BSONType
  * @remarks
  * The internal representation of a long is the two given signed, 32-bit values.
  * We use 32-bit pieces because these are the size of integers on which

src/max_key.ts

@@ -6,6 +6,7 @@ export interface MaxKeyExtended {
 /**
  * A class representation of the BSON MaxKey type.
  * @public
+ * @category BSONType
  */
 export class MaxKey {
   _bsontype!: 'MaxKey';

src/min_key.ts

@@ -6,6 +6,7 @@ export interface MinKeyExtended {
 /**
  * A class representation of the BSON MinKey type.
  * @public
+ * @category BSONType
  */
 export class MinKey {
   _bsontype!: 'MinKey';

src/objectid.ts

@@ -26,6 +26,7 @@ const kId = Symbol('id');
 /**
  * A class representation of the BSON ObjectId type.
  * @public
+ * @category BSONType
  */
 export class ObjectId {
   _bsontype!: 'ObjectID';

src/regexp.ts

@@ -22,6 +22,7 @@ export interface BSONRegExpExtended {
 /**
  * A class representation of the BSON RegExp type.
  * @public
+ * @category BSONType
  */
 export class BSONRegExp {
   _bsontype!: 'BSONRegExp';

src/symbol.ts

@@ -6,6 +6,7 @@ export interface BSONSymbolExtended {
 /**
  * A class representation of the BSON Symbol type.
  * @public
+ * @category BSONType
  */
 export class BSONSymbol {
   _bsontype!: 'Symbol';

src/timestamp.ts

@@ -19,7 +19,10 @@ export interface TimestampExtended {
   };
 }
 
-/** @public */
+/**
+ * @public
+ * @category BSONType
+ * */
 export class Timestamp extends LongWithoutOverridesClass {
   _bsontype!: 'Timestamp';
 

tsdoc.json

@@ -0,0 +1,9 @@
+{
+    "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+    "tagDefinitions": [
+        {
+            "syntaxKind": "block",
+            "tagName": "@category"
+        }
+    ]
+}