Skip to content

Commit cadd628

Browse files
author
Kwabena Ampofo
authored
docs(NODE-4158): Annotate BSON classes with a category (#496)
1 parent 7faeb17 commit cadd628

File tree

14 files changed

+25
-1
lines changed

14 files changed

+25
-1
lines changed

src/binary.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ export interface BinaryExtended {
2525
/**
2626
* A class representation of the BSON Binary type.
2727
* @public
28+
* @category BSONType
2829
*/
2930
export class Binary {
3031
_bsontype!: 'Binary';

src/code.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ export interface CodeExtended {
99
/**
1010
* A class representation of the BSON Code type.
1111
* @public
12+
* @category BSONType
1213
*/
1314
export class Code {
1415
_bsontype!: 'Code';

src/db_ref.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ export function isDBRefLike(value: unknown): value is DBRefLike {
2323
/**
2424
* A class representation of the BSON DBRef type.
2525
* @public
26+
* @category BSONType
2627
*/
2728
export class DBRef {
2829
_bsontype!: 'DBRef';

src/decimal128.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ export interface Decimal128Extended {
118118
/**
119119
* A class representation of the BSON Decimal128 type.
120120
* @public
121+
* @category BSONType
121122
*/
122123
export class Decimal128 {
123124
_bsontype!: 'Decimal128';

src/double.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ export interface DoubleExtended {
88
/**
99
* A class representation of the BSON Double type.
1010
* @public
11+
* @category BSONType
1112
*/
1213
export class Double {
1314
_bsontype!: 'Double';

src/int_32.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ export interface Int32Extended {
88
/**
99
* A class representation of a BSON Int32 type.
1010
* @public
11+
* @category BSONType
1112
*/
1213
export class Int32 {
1314
_bsontype!: 'Int32';

src/long.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ export interface LongExtended {
5858
/**
5959
* A class representing a 64-bit integer
6060
* @public
61+
* @category BSONType
6162
* @remarks
6263
* The internal representation of a long is the two given signed, 32-bit values.
6364
* We use 32-bit pieces because these are the size of integers on which

src/max_key.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ export interface MaxKeyExtended {
66
/**
77
* A class representation of the BSON MaxKey type.
88
* @public
9+
* @category BSONType
910
*/
1011
export class MaxKey {
1112
_bsontype!: 'MaxKey';

src/min_key.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ export interface MinKeyExtended {
66
/**
77
* A class representation of the BSON MinKey type.
88
* @public
9+
* @category BSONType
910
*/
1011
export class MinKey {
1112
_bsontype!: 'MinKey';

src/objectid.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ const kId = Symbol('id');
2626
/**
2727
* A class representation of the BSON ObjectId type.
2828
* @public
29+
* @category BSONType
2930
*/
3031
export class ObjectId {
3132
_bsontype!: 'ObjectID';

0 commit comments

Comments
 (0)