Skip to content

Commit 30fb3b2

Browse files
committed
A few updates.
1 parent f849201 commit 30fb3b2

File tree

5 files changed

+57
-16
lines changed

5 files changed

+57
-16
lines changed

circle.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
machine:
22
node:
33
version: 4.1.0
4-
54
dependencies:
65
pre:
6+
- npm i js-data@^3.0.0-beta.3 rethinkdbdash
77
- source /etc/lsb-release && echo "deb http://download.rethinkdb.com/apt $DISTRIB_CODENAME main" | sudo tee /etc/apt/sources.list.d/rethinkdb.list
88
- wget -qO- http://download.rethinkdb.com/apt/pubkey.gpg | sudo apt-key add -
99
- sudo apt-get update -qq

mocha.start.js

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,14 @@ require('babel-polyfill')
77
var JSData = require('js-data')
88
var JSDataAdapterTests = require('js-data-adapter-tests')
99
var JSDataRethinkDB = require('./')
10-
var version = JSDataRethinkDB.version
11-
var OPERATORS = JSDataRethinkDB.OPERATORS
12-
var RethinkDBAdapter = JSDataRethinkDB.RethinkDBAdapter
1310

1411
var assert = global.assert = JSDataAdapterTests.assert
1512
global.sinon = JSDataAdapterTests.sinon
1613

1714
JSDataAdapterTests.init({
1815
debug: false,
1916
JSData: JSData,
20-
Adapter: RethinkDBAdapter,
17+
Adapter: JSDataRethinkDB.RethinkDBAdapter,
2118
adapterConfig: {
2219
min: 1,
2320
max: 5,
@@ -33,8 +30,13 @@ JSDataAdapterTests.init({
3330
require('./test/handleErrors.test')
3431

3532
describe('exports', function () {
36-
assert(OPERATORS)
37-
assert(OPERATORS['=='])
38-
assert(version)
39-
assert(version.full)
33+
it('should have correct exports', function () {
34+
assert(JSDataRethinkDB.default)
35+
assert(JSDataRethinkDB.RethinkDBAdapter)
36+
assert(JSDataRethinkDB.RethinkDBAdapter === JSDataRethinkDB.default)
37+
assert(JSDataRethinkDB.OPERATORS)
38+
assert(JSDataRethinkDB.OPERATORS['=='])
39+
assert(JSDataRethinkDB.version)
40+
assert(JSDataRethinkDB.version.full)
41+
})
4042
})

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,12 @@
6464
"rethinkdbdash": ">=1.15.0"
6565
},
6666
"devDependencies": {
67-
"babel-polyfill": "6.7.4",
67+
"babel-polyfill": "6.8.0",
6868
"babel-preset-es2015-rollup": "1.1.1",
6969
"istanbul": "0.4.3",
70-
"js-data-adapter-tests": "^2.0.0-alpha.16",
70+
"js-data-adapter-tests": "^2.0.0-alpha.20",
7171
"js-data-repo-tools": "0.5.0",
72-
"rollup": "0.26.1",
72+
"rollup": "0.26.2",
7373
"rollup-plugin-babel": "2.4.0",
7474
"source-map-support": "0.4.0",
7575
"watch": "0.18.0"

rollup.config.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
var babel = require('rollup-plugin-babel')
22

33
module.exports = {
4+
external: [
5+
'rethinkdbdash',
6+
'js-data',
7+
'js-data-adapter',
8+
'mout/string/underscore'
9+
],
410
plugins: [
511
babel({
612
exclude: 'node_modules/**'

src/index.js

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -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
*/
296296
RethinkDBAdapter.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
*/
10231027
export 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+
10251058
export default RethinkDBAdapter

0 commit comments

Comments
 (0)