split-frames 2.4.4 → 2.5.0

package/test/3_startAndEnd.js

@@ -1,325 +0,0 @@
-"use strict";
-
-// deps
-
-	const assert = require("assert");
-	const SplitFrames = require(require("path").join(__dirname, "..", "lib", "main.js"));
-
-// consts
-
-	const STX = 0x02;
-	const ETX = 0x03;
-	const DLE = 0x10;
-
-// module
-
-describe("start & end", () => {
-
-	it("should split frame with no start", () => {
-
-		return new Promise((resolve, reject) => {
-
-			const splitter = new SplitFrames({
-				"startWith": STX,
-				"endWith": ETX
-			}).once("error", reject).once("data", (chunk) => {
-
-				assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-				assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-				assert.deepStrictEqual(chunk, Buffer.from([ STX, 0x24, ETX ]), "The chunk is not as expected");
-
-				resolve();
-
-			});
-
-			// tested frame
-			splitter.write(Buffer.from([ 0x24, 0x24, 0x25, 0x26, ETX ]));
-			// valid frame to close tested frame
-			splitter.write(Buffer.from([ STX, 0x24, ETX ]));
-
-		});
-
-	});
-
-	it("should split frame with no end", () => {
-
-		return new Promise((resolve, reject) => {
-
-			const splitter = new SplitFrames({
-				"startWith": STX,
-				"endWith": ETX
-			}).once("error", reject).once("data", (chunk) => {
-
-				assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-				assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-				assert.deepStrictEqual(chunk, Buffer.from([ STX, 0x24, 0x24, 0x25, 0x26, ETX ]), "The chunk is not as expected");
-
-				resolve();
-
-			});
-
-			// tested frame
-			splitter.write(Buffer.from([ STX, 0x24, 0x24, 0x25, 0x26 ]));
-			// close tested frame
-			splitter.write(Buffer.from([ ETX ]));
-
-		});
-
-	});
-
-	it("should split frame with one start & end", () => {
-
-		return new Promise((resolve, reject) => {
-
-			new SplitFrames({
-				"startWith": STX,
-				"endWith": ETX
-			}).once("error", reject).once("data", (chunk) => {
-
-				assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-				assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-				assert.deepStrictEqual(chunk, Buffer.from([ STX, 0x24, 0x25, ETX ]), "The chunk is not as expected");
-
-				resolve();
-
-			// tested frame
-			}).write(Buffer.from([ 0x24, STX, 0x24, 0x25, ETX, 0x24 ]));
-
-		});
-
-	});
-
-	it("should split frame with two start & end", () => {
-
-		return new Promise((resolve, reject) => {
-
-			let dataCount = 0;
-
-			const splitter = new SplitFrames({
-				"startWith": STX,
-				"endWith": ETX
-			}).once("error", reject).on("data", (chunk) => {
-
-				++dataCount;
-
-				if (1 === dataCount) {
-
-					assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-					assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-					assert.deepStrictEqual(chunk, Buffer.from([ STX, 0x24, 0x25, ETX ]), "The chunk is not as expected");
-
-				}
-				else if (2 === dataCount) {
-
-					assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-					assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-					assert.deepStrictEqual(chunk, Buffer.from([ STX, 0x24, ETX ]), "The chunk is not as expected");
-
-					resolve();
-
-				}
-
-			});
-
-			// tested frame
-			splitter.write(Buffer.from([ 0x24, STX, 0x24, 0x25, ETX, 0x24 ]));
-			// close tested frame
-			splitter.write(Buffer.from([ STX, 0x24, ETX ]));
-
-		});
-
-	});
-
-	it("should split frame with one bit start and two bits end", () => {
-
-		return new Promise((resolve, reject) => {
-
-			new SplitFrames({
-				"startWith": STX,
-				"endWith": Buffer.from([ DLE, ETX ])
-			}).once("error", reject).once("data", (chunk) => {
-
-				assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-				assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-				assert.deepStrictEqual(chunk, Buffer.from([ STX, 0x24, 0x25, 0x26, DLE, ETX ]), "The chunk is not as expected");
-
-				resolve();
-
-			// tested frame
-			}).write(Buffer.from([ 0x24, STX, 0x24, 0x25, 0x26, DLE, ETX, 0x27, 0x28, 0x29, DLE, ETX ]));
-
-		});
-
-	});
-
-	it("should split frame with two bits start and one bit end", () => {
-
-		return new Promise((resolve, reject) => {
-
-			new SplitFrames({
-				"startWith": Buffer.from([ DLE, STX ]),
-				"endWith": ETX
-			}).once("error", reject).once("data", (chunk) => {
-
-				assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-				assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-				assert.deepStrictEqual(chunk, Buffer.from([ DLE, STX, 0x24, 0x25, 0x26, ETX ]), "The chunk is not as expected");
-
-				resolve();
-
-			// tested frame
-			}).write(Buffer.from([ 0x24, DLE, STX, 0x24, 0x25, 0x26, ETX, 0x27, 0x28, 0x29, DLE, ETX ]));
-
-		});
-
-	});
-
-	it("should split frame with one bit start and two bits end", () => {
-
-		return new Promise((resolve, reject) => {
-
-			new SplitFrames({
-				"startWith": STX,
-				"endWith": Buffer.from([ DLE, ETX ])
-			}).once("error", reject).once("data", (chunk) => {
-
-				assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-				assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-				assert.deepStrictEqual(chunk, Buffer.from([ STX, 0x24, 0x25, 0x26, DLE, ETX ]), "The chunk is not as expected");
-
-				resolve();
-
-			// tested frame
-			}).write(Buffer.from([ 0x24, STX, 0x24, 0x25, 0x26, DLE, ETX, 0x27, 0x28, 0x29, DLE, ETX ]));
-
-		});
-
-	});
-
-	it("should split frame with two bits start and two bits end", () => {
-
-		return new Promise((resolve, reject) => {
-
-			new SplitFrames({
-				"startWith": Buffer.from([ DLE, STX ]),
-				"endWith": Buffer.from([ DLE, ETX ])
-			}).once("error", reject).once("data", (chunk) => {
-
-				assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-				assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-				assert.deepStrictEqual(chunk,
-					Buffer.from([ DLE, STX, 0x24, 0x25, 0x26, ETX, 0x27, 0x28, 0x29, DLE, ETX ]),
-					"The chunk is not as expected"
-				);
-
-				resolve();
-
-			// tested frame
-			}).write(Buffer.from([ 0x24, DLE, STX, 0x24, 0x25, 0x26, ETX, 0x27, 0x28, 0x29, DLE, ETX ]));
-
-		});
-
-	});
-
-	it("should split frame with escaped data", () => {
-
-		return new Promise((resolve, reject) => {
-
-			new SplitFrames({
-				"startWith": STX,
-				"endWith": ETX,
-				"escapeWith": DLE,
-				"escaped": [ DLE, STX, ETX ]
-			}).once("error", reject).once("data", (chunk) => {
-
-				assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-				assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-
-				assert.deepStrictEqual(chunk,
-					Buffer.from([ STX, 0x24, DLE, STX, 0x24, 0x25, DLE, DLE, 0x26, 0x27, DLE, ETX, 0x28, ETX ]),
-					"The chunk is not as expected"
-				);
-
-				resolve();
-
-			// tested frame
-			}).write(Buffer.from([ STX, 0x24, DLE, STX, 0x24, 0x25, DLE, DLE, 0x26, 0x27, DLE, ETX, 0x28, ETX ]));
-
-		});
-
-	});
-
-	describe("control bits", () => {
-
-		it("should end with no control bit", () => {
-
-			return new Promise((resolve) => {
-
-				new SplitFrames({
-					"startWith": STX,
-					"endWith": ETX,
-					"controlBits": "none"
-				}).on("data", (chunk) => {
-
-					assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-					assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-					assert.deepStrictEqual(chunk, Buffer.from([ STX, 0x20, 0x21, 0x22, 0x24, ETX ]), "The chunk is not as expected");
-
-					resolve();
-
-				// tested frame
-				}).write(Buffer.from([ 0x24, STX, 0x20, 0x21, 0x22, 0x24, ETX, 0x07, 0x24 ]));
-
-			});
-
-		});
-
-		it("should end with one control bit", () => {
-
-			return new Promise((resolve) => {
-
-				new SplitFrames({
-					"startWith": STX,
-					"endWith": ETX,
-					"controlBits": "end+1"
-				}).on("data", (chunk) => {
-
-					assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-					assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-					assert.deepStrictEqual(chunk, Buffer.from([ STX, 0x20, 0x21, 0x22, 0x24, ETX, 0x07 ]), "The chunk is not as expected");
-
-					resolve();
-
-				// tested frame
-				}).write(Buffer.from([ 0x24, STX, 0x20, 0x21, 0x22, 0x24, ETX, 0x07, 0x24 ]));
-
-			});
-
-		});
-
-		it("should end with two control bits", () => {
-
-			return new Promise((resolve) => {
-
-				new SplitFrames({
-					"startWith": STX,
-					"endWith": ETX,
-					"controlBits": "end+2"
-				}).on("data", (chunk) => {
-
-					assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-					assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-					assert.deepStrictEqual(chunk, Buffer.from([ STX, 0x20, 0x21, 0x22, 0x24, ETX, 0x07, 0x24 ]), "The chunk is not as expected");
-
-					resolve();
-
-				// tested frame
-				}).write(Buffer.from([ 0x24, STX, 0x20, 0x21, 0x22, 0x24, ETX, 0x07, 0x24 ]));
-
-			});
-
-		});
-
-	});
-
-});

package/test/4_specifics.js

@@ -1,283 +0,0 @@
-/*
-	eslint no-new: 0
-*/
-
-"use strict";
-
-// deps
-
-	const assert = require("assert");
-	const SplitFrames = require(require("path").join(__dirname, "..", "lib", "main.js"));
-
-// consts
-
-	const STX = 0x02;
-	const ETX = 0x03;
-	const DLE = 0x10;
-	const ACK = 0x06;
-	const NAK = 0x15;
-
-// module
-
-describe("specifics", () => {
-
-	describe("without tags", () => {
-
-		it("should test \"ack\" without tags", () => {
-
-			return new Promise((resolve, reject) => {
-
-				let count = 0;
-
-				const splitter = new SplitFrames({
-					"specifics": {
-						"ack": ACK
-					}
-				}).once("error", reject).once("data", (chunk) => {
-
-					assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-					assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-					assert.deepStrictEqual(chunk, Buffer.from([ 0x01, DLE, 0x02 ]), "The chunk is not as expected");
-
-					assert.strictEqual(count, 3, "The amount of \"ack\" received is not as expected");
-
-					resolve();
-
-				}).on("ack", () => {
-					++count;
-				});
-
-				splitter.write(Buffer.from([ ACK, 0x01, DLE, ACK, 0x02, ACK ]));
-
-			});
-
-		});
-
-		it("should test \"ack\" with two bits", () => {
-
-			return new Promise((resolve, reject) => {
-
-				let count = 0;
-
-				const splitter = new SplitFrames({
-					"specifics": {
-						"ack": Buffer.from([ DLE, ACK ])
-					}
-				}).once("error", reject).once("data", (chunk) => {
-
-					assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-					assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-					assert.deepStrictEqual(chunk, Buffer.from([ 0x01, 0x02 ]), "The chunk is not as expected");
-
-					assert.strictEqual(count, 3, "The amount of \"ack\" received is not as expected");
-
-					resolve();
-
-				}).on("ack", () => {
-					++count;
-				});
-
-				splitter.write(Buffer.from([ DLE, ACK, 0x01, DLE, ACK, 0x02, DLE, ACK ]));
-
-			});
-
-		});
-
-		it("should test escaped \"ack\"", () => {
-
-			return new Promise((resolve, reject) => {
-
-				let count = 0;
-
-				const splitter = new SplitFrames({
-					"specifics": {
-						"ack": ACK
-					},
-					"escapeWith": DLE,
-					"escaped": [ DLE, ACK ]
-				}).once("error", reject).once("data", (chunk) => {
-
-					assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-					assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-					assert.deepStrictEqual(chunk, Buffer.from([ 0x01, DLE, ACK, 0x02 ]), "The chunk is not as expected");
-
-					assert.strictEqual(count, 2, "The amount of \"ack\" received is not as expected");
-
-					resolve();
-
-				}).on("ack", () => {
-					++count;
-				});
-
-				splitter.write(Buffer.from([ ACK, 0x01, DLE, ACK, 0x02, ACK ]));
-
-			});
-
-		});
-
-		it("should test array \"ack\" without tags", () => {
-
-			const ACK2 = 0x86;
-
-			return new Promise((resolve, reject) => {
-
-				let count = 0;
-
-				const splitter = new SplitFrames({
-					"specifics": {
-						"ack": [ ACK, ACK2 ]
-					}
-				}).once("error", reject).once("data", (chunk) => {
-
-					assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-					assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-					assert.deepStrictEqual(chunk, Buffer.from([ 0x01, DLE, 0x02 ]), "The chunk is not as expected");
-
-					assert.strictEqual(count, 3, "The amount of \"ack\" received is not as expected");
-
-					resolve();
-
-				}).on("ack", () => {
-					++count;
-				});
-
-				splitter.write(Buffer.from([ ACK, 0x01, DLE, ACK2, 0x02, ACK ]));
-
-			});
-
-		});
-
-	});
-
-	describe("with tags", () => {
-
-		it("should test \"ack\" with start tags", () => {
-
-			assert.throws(() => {
-				new SplitFrames({
-					"specifics": {
-						"ack": ACK
-					},
-					"startWith": STX
-				});
-			}, Error);
-
-		});
-
-		it("should test \"ack\" with end tags", () => {
-
-			return new Promise((resolve, reject) => {
-
-				let countData = 0;
-				let countAck = 0;
-
-				new SplitFrames({
-					"specifics": {
-						"ack": ACK,
-						"nak": NAK
-					},
-					"endWith": ETX,
-					"escapeWith": DLE,
-					"escaped": [ DLE, ACK, NAK ]
-				}).once("error", reject).on("data", (chunk) => {
-
-					++countData;
-
-					assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-					assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-
-					if (1 === countData) {
-						assert.deepStrictEqual(chunk, Buffer.from([ DLE, ACK, 0x21, 0x21, 0x21, 0x21, ETX ]), "The chunk is not as expected");
-					}
-					else if (2 === countData) {
-						assert.deepStrictEqual(chunk, Buffer.from([ 0x24, 0x25, 0x27, ETX ]), "The chunk is not as expected");
-						assert.strictEqual(countData, 5, "The amount of \"ack\" received is not as expected");
-					}
-
-				}).on("ack", () => {
-
-					++countAck;
-
-					if (5 === countAck) {
-						resolve();
-					}
-
-				}).write(Buffer.from([ ACK, NAK, ACK, ACK, DLE, ACK, 0x21, 0x21, 0x21, 0x21, ETX, ACK, NAK, ACK, 0x24, 0x25, 0x27, ETX ]));
-
-			});
-
-		});
-
-		it("should test \"ack\" with start and end tags", () => {
-
-			return new Promise((resolve, reject) => {
-
-				let count = 0;
-
-				new SplitFrames({
-					"specifics": {
-						"ack": ACK
-					},
-					"startWith": STX,
-					"endWith": ETX,
-					"escapeWith": DLE,
-					"escaped": [ DLE, ACK ]
-				}).once("error", reject).once("data", (chunk) => {
-
-					assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-					assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-					assert.deepStrictEqual(chunk, Buffer.from([ STX, 0x24, 0x25, 0x27, ETX ]), "The chunk is not as expected");
-
-					assert.strictEqual(count, 3, "The amount of \"ack\" received is not as expected");
-
-				}).on("ack", () => {
-
-					++count;
-
-					if (4 === count) {
-						resolve();
-					}
-
-				}).write(Buffer.from([ ACK, 0x21, ACK, 0x21, 0x21, ACK, 0x21, DLE, ACK, STX, 0x24, 0x25, 0x27, ETX, ACK ]));
-
-			});
-
-		});
-
-		it("should test \"ack\" with two bits and start and end tags", () => {
-
-			return new Promise((resolve, reject) => {
-
-				let count = 0;
-
-				new SplitFrames({
-					"specifics": {
-						"ack": Buffer.from([ DLE, ACK ])
-					},
-					"startWith": STX,
-					"endWith": ETX
-				}).once("error", reject).once("data", (chunk) => {
-
-					assert.strictEqual(typeof chunk, "object", "The chunk is not an object");
-					assert.strictEqual(chunk instanceof Buffer, true, "The chunk is not a Buffer");
-					assert.deepStrictEqual(chunk, Buffer.from([ STX, 0x24, 0x25, 0x27, ETX ]), "The chunk is not as expected");
-
-					assert.strictEqual(count, 3, "The amount of \"ack\" received is not as expected");
-
-				}).on("ack", () => {
-
-					++count;
-
-					if (4 === count) {
-						resolve();
-					}
-
-				}).write(Buffer.from([ DLE, ACK, 0x21, DLE, ACK, 0x21, 0x21, DLE, ACK, 0x21, STX, 0x24, 0x25, 0x27, ETX, DLE, ACK ]));
-
-			});
-
-		});
-
-	});
-
-});