@@ -285,12 +285,12 @@ Object.defineProperty(RethinkDBAdapter, '__super__', {
285285 * var MyRethinkDBAdapter = RethinkDBAdapter.extend(instanceProps, classProps)
286286 * var adapter = new MyRethinkDBAdapter()
287287 *
288- * @name RethinkDBAdapter.extend
289- * @method
288+ * @method RethinkDBAdapter.extend
289+ * @static
290290 * @param {Object } [instanceProps] Properties that will be added to the
291- * prototype of the Subclass .
291+ * prototype of the subclass .
292292 * @param {Object } [classProps] Properties that will be added as static
293- * properties to the Subclass itself.
293+ * properties to the subclass itself.
294294 * @return {Constructor } Subclass of `RethinkDBAdapter`.
295295 */
296296RethinkDBAdapter . extend = utils . extend
@@ -1009,6 +1009,10 @@ utils.addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
10091009/**
10101010 * Details of the current version of the `js-data-rethinkdb` module.
10111011 *
1012+ * @example
1013+ * import {version} from 'js-data-rethinkdb'
1014+ * console.log(version.full)
1015+ *
10121016 * @name module:js-data-rethinkdb.version
10131017 * @type {Object }
10141018 * @property {string } version.full The full semver value.
@@ -1022,4 +1026,33 @@ utils.addHiddenPropsToTarget(RethinkDBAdapter.prototype, {
10221026 */
10231027export const version = '<%= version %>'
10241028
1029+ /**
1030+ * {@link RethinkDBAdapter } class.
1031+ *
1032+ * @example
1033+ * import {RethinkDBAdapter} from 'js-data-rethinkdb'
1034+ * const adapter = new RethinkDBAdapter()
1035+ *
1036+ * @name module:js-data-rethinkdb.RethinkDBAdapter
1037+ * @see RethinkDBAdapter
1038+ * @type {Constructor }
1039+ */
1040+
1041+ /**
1042+ * Registered as `js-data-rethinkdb` in NPM.
1043+ *
1044+ * @example <caption>Install from NPM</caption>
1045+ * npm i --save js-data-rethinkdb@beta js-data@beta rethinkdbdash
1046+ *
1047+ * @example <caption>Load via CommonJS</caption>
1048+ * var RethinkDBAdapter = require('js-data-rethinkdb').RethinkDBAdapter
1049+ * var adapter = new RethinkDBAdapter()
1050+ *
1051+ * @example <caption>Load via ES2015 Modules</caption>
1052+ * import {RethinkDBAdapter} from 'js-data-rethinkdb'
1053+ * const adapter = new RethinkDBAdapter()
1054+ *
1055+ * @module js-data-rethinkdb
1056+ */
1057+
10251058export default RethinkDBAdapter
0 commit comments