docs: move scoped constants away from globals

Author: ruiquelhas

index.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2015, 2022, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0, as
@@ -162,8 +162,8 @@ exports.getVersion = function () {
 
 /**
  * Database entity types.
- * @name Mode
- * @type {Query~DataModel}
+ * @const
+ * @type {Query.DataModel}
  * @example
  * mysqlx.Mode.TABLE
  * mysqlx.Mode.DOCUMENT
@@ -172,8 +172,8 @@ exports.Mode = query.Type;
 
 /**
  * Locking modes.
- * @name LockContention
- * @type {Locking~LockContention}
+ * @const
+ * @type {Locking.LockContention}
  * @example
  * mysqlx.LockContention.DEFAULT
  * mysqlx.LockContention.NOWAIT
@@ -183,7 +183,8 @@ exports.LockContention = locking.LockContention;
 
 /**
  * Schema validation.
- * @name Schema
+ * @const
+ * @property {module:Schema.ValidationLevel} ValidationLevel
  * @example
  * mysqlx.Schema.ValidationLevel.OFF
  * mysqlx.Schema.ValidationLevel.STRICT

lib/DevAPI/Locking.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2017, 2022, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0, as
@@ -39,17 +39,22 @@ const preparing = require('./Preparing');
  * Enum to identify row locking types.
  * @readonly
  * @private
- * @name Type
+ * @name Locking.Type
  * @enum {number}
+ * @example
+ * Type.NONE
+ * Type.EXCLUSIVE_LOCK
+ * Type.SHARED_LOCK
  */
 const Type = Object.assign({ NONE: 0 }, RowLock);
 
 /**
  * Enum to identify row locking modes.
  * @readonly
- * @name LockContention
+ * @name Locking.LockContention
  * @enum {number}
  * @example
+ * LockContention.DEFAULT
  * LockContention.NOWAIT
  * LockContention.SKIP_LOCKED
  */
@@ -158,18 +163,8 @@ function Locking (state) {
     };
 }
 
-/**
- * Row locking types.
- * @type {Type}
- * @const
- */
+// Export contants.
 Locking.Type = Type;
-
-/**
- * Row locking modes.
- * @type {LockContention}
- * @const
- */
 Locking.LockContention = LockContention;
 
 module.exports = Locking;

lib/DevAPI/Query.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2017, 2022, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0, as
@@ -33,7 +33,7 @@
 /**
  * Enum to identify data-model types and parser modes.
  * @readonly
- * @name DataModel
+ * @name Query.DataModel
  * @enum {number}
  * @example
  * DataModel.TABLE
@@ -45,7 +45,6 @@ const MessageType = require('../Protocol/Stubs/mysqlx_prepare_pb').Prepare.OneOf
 /**
  * Query mixin.
  * @mixin
- * @private
  * @alias Query
  * @param {Object} state
  * @returns {Query}
@@ -100,12 +99,7 @@ function Query (state) {
     };
 }
 
-/**
- * Database entity types.
- * @type {DataModel}
- * @const
- * @private
- */
+// Export constants.
 Query.Type = DataModel;
 
 module.exports = Query;

lib/DevAPI/Schema.js

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015, 2021, Oracle and/or its affiliates.
+ * Copyright (c) 2015, 2022, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0, as
@@ -43,7 +43,7 @@ const log = logger('api:schema');
 /**
  * Enum to identify schema validation levels.
  * @readonly
- * @name ValidationLevel
+ * @name module:Schema.ValidationLevel
  * @enum {string}
  * @example
  * ValidationLevel.OFF
@@ -64,7 +64,7 @@ const ValidationLevel = {
  * Options available for specifying a collection validation schema.
  * @typedef {object} module:Schema.SchemaValidationOptions
  * @prop {object} [schema] - [JSON Schema]{@link https://json-schema.org/} definition
- * @prop {ValidationLevel} [level] - enforcement level
+ * @prop {module:Schema.ValidationLevel} [level] - enforcement level
  */
 
 /**
@@ -308,6 +308,7 @@ function Schema (connection, name) {
     });
 }
 
+// Export constants.
 Schema.ValidationLevel = ValidationLevel;
 
 module.exports = Schema;