@onehat/data 1.6.0 → 1.6.1

package/cypress/integration/Repository/Repository.spec.js

@@ -581,6 +581,23 @@ describe('Repository Base', function() {
 			expect(result.value).to.be.eq('three');
 		});
 
+		it('getById', function() {
+			const result = this.repository.getById(3);
+			expect(result.value).to.be.eq('three');
+		});
+
+		it('getBy', function() {
+			const result = this.repository.getBy(entity => entity.id === 2 || entity.id === 3);
+			expect(result.length).to.be.eq(2);
+			expect(result[0].value).to.be.eq('two');
+			expect(result[1].value).to.be.eq('three');
+		});
+
+		it('getFirstBy', function() {
+			const result = this.repository.getFirstBy(entity => entity.id === 3);
+			expect(result.value).to.be.eq('three');
+		});
+
 		it('getByRange', function() {
 			const result = this.repository.getByRange(1, 4);
 			expect(_.size(result)).to.be.eq(4);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@onehat/data",
-	"version": "1.6.0",
+	"version": "1.6.1",
 	"description": "JS data modeling package with adapters for many storage mediums.",
 	"main": "src/index.js",
 	"type": "module",

package/src/Repository/Repository.js

@@ -1064,20 +1064,19 @@ export default class Repository extends EventEmitter {
 	/**
 	 * Get a single Entity by its id
 	 * @param {integer} id - id of record to retrieve
-	 * @return {Entity} The Entity with matching id
+	 * @return {Entity} The Entity with matching id, or undefined
 	 */
 	getById = (id) => {
 		if (this.isDestroyed) {
 			throw Error('this.getById is no longer valid. Repository has been destroyed.');
 		}
-		const result = this.getBy((entity) => entity.id === id);
-		return result.length > 0 ? result[0] : null;
+		return this.getFirstBy(entity => entity.id === id);
 	}
 
 	/**
 	 * Get an array of Entities by supplied filter function
 	 * @param {function} filter - Filter function to apply to all entities
-	 * @return {Entity[]} Entities that passed through filter
+	 * @return {Entity[]} Entities that passed through filter, or []
 	 */
 	getBy = (filter) => {
 		if (this.isDestroyed) {
@@ -1093,7 +1092,7 @@ export default class Repository extends EventEmitter {
 	 * filters into account. Defaults to false.
 	 * 
 	 * @param {function} filter - Filter function to search by
-	 * @return {Entity} First Entity found
+	 * @return {Entity} First Entity found, or undefined
 	 */
 	getFirstBy = (filter) => {
 		if (this.isDestroyed) {
@@ -1104,7 +1103,7 @@ export default class Repository extends EventEmitter {
 
 	/**
 	 * Get all phantom (unsaved) Entities
-	 * @return {Entity[]} Array of phantom Entities
+	 * @return {Entity[]} Array of phantom Entities, or []
 	 */
 	getPhantom = () => {
 		if (this.isDestroyed) {
@@ -1115,7 +1114,7 @@ export default class Repository extends EventEmitter {
 
 	/**
 	 * Get all Entities not yet persisted to a storage medium
-	 * @return {Entity[]} Array of dirty Entities
+	 * @return {Entity[]} Array of dirty Entities, or []
 	 */
 	getNonPersisted = () => {
 		if (this.isDestroyed) {
@@ -1128,7 +1127,7 @@ export default class Repository extends EventEmitter {
 
 	/**
 	 * Get all dirty (having unsaved changes) Entities
-	 * @return {Entity[]} Array of dirty Entities
+	 * @return {Entity[]} Array of dirty Entities, or []
 	 */
 	getDirty = () => {
 		if (this.isDestroyed) {
@@ -1141,7 +1140,7 @@ export default class Repository extends EventEmitter {
 
 	/**
 	 * Get all deleted Entities
-	 * @return {Entity[]} Array of deleted Entities
+	 * @return {Entity[]} Array of deleted Entities, or []
 	 */
 	getDeleted = () => {
 		if (this.isDestroyed) {