@neurodevs/node-lsl 0.0.1 → 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neurodevs/node-lsl",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "main": "build/index.js",
   "repository": "https://github.com/neurodevs/node-lsl.git",
   "scripts": {

package/src/LslOutlet.ts

@@ -1,9 +1,11 @@
 import { SchemaError, assertOptions } from '@sprucelabs/schema'
 import LiblslImpl, { LslSample } from './Liblsl'
 
-export default class LslOutlet {
+export default class LslOutletImpl implements LslOutlet {
 	private outletOptions: LslOutletOptions
-	public constructor(options: LslOutletOptions) {
+	public static Class?: new (options: LslOutletOptions) => LslOutlet
+
+	protected constructor(options: LslOutletOptions) {
 		const { channelCount, sampleRate, channelFormat, chunkSize, maxBuffered } =
 			assertOptions(options, [
 				'name',
@@ -27,6 +29,10 @@ export default class LslOutlet {
 		this.outletOptions = options
 	}
 
+	public static Outlet(options: LslOutletOptions) {
+		return new (this.Class ?? this)(options)
+	}
+
 	private assertValidMaxBufferred(maxBuffered: number) {
 		if (!this.isPositiveIntegerOrZero(maxBuffered)) {
 			throw new SchemaError({
@@ -141,3 +147,7 @@ export interface LslOutletOptions {
 	chunkSize: number
 	maxBuffered: number
 }
+
+export interface LslOutlet {
+	pushSample(sample: LslSample): void
+}

package/src/__tests__/behavioral/LslOutlet.test.ts

@@ -151,6 +151,13 @@ export default class LslOutletTest extends AbstractSpruceTest {
 		})
 	}
 
+	@test()
+	protected static async canOverrideClasInstantiatedInFactory() {
+		LslOutlet.Class = CheckingOutlet
+		const instance = this.Outlet()
+		assert.isInstanceOf(instance, CheckingOutlet)
+	}
+
 	private static pushSample(sample: LslSample) {
 		const outlet = this.Outlet()
 		outlet.pushSample(sample)
@@ -185,7 +192,7 @@ export default class LslOutletTest extends AbstractSpruceTest {
 	}
 
 	private static Outlet(options?: Partial<LslOutletOptions>) {
-		return new LslOutlet({
+		return LslOutlet.Outlet({
 			...this.randomOutletOptions,
 			...options,
 		})
@@ -215,3 +222,9 @@ class SpyLiblsl implements Liblsl {
 		this.lastPushedSample = sample
 	}
 }
+
+class CheckingOutlet extends LslOutlet {
+	public constructor(options: LslOutletOptions) {
+		super(options)
+	}
+}