@neurodevs/node-lsl 16.1.0 → 17.1.0

package/src/scripts/runLslStreamOutlet.ts

@@ -1,19 +1,25 @@
 import LslStreamOutlet from '../impl/LslStreamOutlet.js'
 
 async function main() {
-    const instance = await LslStreamOutlet.Create({
-        name: 'Muse S (2nd gen)',
-        type: 'EEG',
-        channelNames: ['TP9', 'AF7', 'AF8', 'TP10', 'AUX'],
-        sampleRateHz: 256,
+    const outlet = await LslStreamOutlet.Create({
+        name: '10 Hz Pulse',
+        type: 'HZ',
+        sourceId: '10-hz-pulse',
+        channelNames: ['Ch1', 'Ch2', 'Ch3'],
         channelFormat: 'float32',
-        sourceId: 'muse-s-eeg',
-        manufacturer: 'Interaxon Inc.',
-        units: 'microvolt',
-        chunkSize: 12,
+        sampleRateHz: 10,
+        chunkSize: 1,
     })
 
-    instance.pushSample([1, 2, 3, 4, 5])
+    for (let i = 0; i < 100; i++) {
+        await new Promise((resolve) => setTimeout(resolve, 100))
+
+        outlet.pushSample([
+            Math.random() * 100,
+            Math.random() * 100,
+            Math.random() * 100,
+        ])
+    }
 }
 
 main().catch((error) => {

package/src/scripts/runOutletToInlet.ts

@@ -17,18 +17,16 @@ const outlet = await LslStreamOutlet.Create({
 console.log('Creating inlet...')
 
 const inletOptions = {
-    name: 'TestOutlet',
-    type: 'TEST',
-    sourceId: 'TestOutletID',
-    sampleRateHz: 100,
-    channelNames: ['Ch1', 'Ch2', 'Ch3'],
-    channelFormat: 'float32' as const,
+    info: outlet.info,
     chunkSize: 1,
 }
 
-const inlet = LslStreamInlet.Create(inletOptions, (samples, timestamps) => {
-    console.log('Received samples:', samples, 'at timestamps:', timestamps)
-})
+const inlet = await LslStreamInlet.Create(
+    inletOptions,
+    (samples, timestamps) => {
+        console.log('Received samples:', samples, 'at timestamps:', timestamps)
+    }
+)
 
 console.log('Start pulling...')
 inlet.startPulling()

package/src/testDoubles/Liblsl/FakeLiblsl.ts

@@ -21,7 +21,7 @@ import {
 } from 'impl/LiblslAdapter.js'
 
 export default class FakeLiblsl implements Liblsl {
-    public static fakeResolveHandles: bigint[] = []
+    public static fakeStreamInfoHandles: BoundStreamInfo[] = []
 
     public static fakeSamples: Float32Array[] = [
         new Float32Array([1, 2, 3]),
@@ -90,7 +90,7 @@ export default class FakeLiblsl implements Liblsl {
 
     public async resolveByProp(options: ResolveByPropOptions) {
         this.lastResolveByPropOptions = options
-        return FakeLiblsl.fakeResolveHandles
+        return FakeLiblsl.fakeStreamInfoHandles as bigint[]
     }
 
     public pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions) {

package/src/testDoubles/StreamInfo/FakeStreamInfo.ts

@@ -4,20 +4,20 @@ import { BoundStreamInfo } from 'impl/LiblslAdapter.js'
 import { StreamInfo, StreamInfoOptions } from '../../impl/LslStreamInfo.js'
 
 export default class FakeStreamInfo implements StreamInfo {
-    public static callsToConstructor: StreamInfoOptions[] = []
+    public static callsToConstructor: (StreamInfoOptions | undefined)[] = []
     public static numCallsToDestroy = 0
 
-    public static boundStreamInfo = {} as BoundStreamInfo
+    public static boundInfo = {} as BoundStreamInfo
 
     public name = generateId()
     public type = generateId()
     public sourceId = generateId()
-    public channelNames: string[] = [generateId(), generateId()]
+    public channelNames: string[] = [generateId(), generateId(), generateId()]
     public channelFormat = 'float32' as const
     public sampleRateHz = 0
     public units = 'N/A'
 
-    public constructor(options: StreamInfoOptions) {
+    public constructor(options?: StreamInfoOptions) {
         FakeStreamInfo.callsToConstructor.push(options)
     }
 
@@ -29,8 +29,8 @@ export default class FakeStreamInfo implements StreamInfo {
         return this.channelNames.length
     }
 
-    public get boundStreamInfo() {
-        return FakeStreamInfo.boundStreamInfo
+    public get boundInfo() {
+        return FakeStreamInfo.boundInfo
     }
 
     public static resetTestDouble() {

package/src/testDoubles/StreamInfo/SpyStreamInfo.ts

@@ -8,10 +8,6 @@ export default class SpyStreamInfo extends LslStreamInfo {
         SpyStreamInfo.numCallsToConstructor++
     }
 
-    public getBoundInfo() {
-        return this.boundInfo
-    }
-
     public getName() {
         return this.name
     }

package/src/testDoubles/StreamInlet/FakeStreamInlet.ts

@@ -1,10 +1,13 @@
 import { StreamInfo } from '../../impl/LslStreamInfo.js'
-import { StreamInlet, StreamInletOptions } from '../../impl/LslStreamInlet.js'
+import {
+    StreamInlet,
+    StreamInletConstructorOptions,
+} from '../../impl/LslStreamInlet.js'
 
 export default class FakeStreamInlet implements StreamInlet {
     public static callsToConstructor: {
         info?: StreamInfo
-        options?: StreamInletOptions
+        options?: StreamInletConstructorOptions
         onData?: (samples: Float32Array, timestamps: Float64Array) => void
     }[] = []
 
@@ -19,7 +22,7 @@ export default class FakeStreamInlet implements StreamInlet {
 
     public constructor(
         info?: StreamInfo,
-        options?: StreamInletOptions,
+        options?: StreamInletConstructorOptions,
         onData?: (samples: Float32Array, timestamps: Float64Array) => void
     ) {
         this.onData = onData ?? (() => {})

package/src/testDoubles/StreamInlet/SpyStreamInlet.ts

@@ -1,22 +1,18 @@
 import { StreamInfo } from '../../impl/LslStreamInfo.js'
 import LslStreamInlet, {
     OnDataCallback,
-    StreamInletOptions,
+    StreamInletConstructorOptions,
 } from '../../impl/LslStreamInlet.js'
 
 export class SpyStreamInlet extends LslStreamInlet {
     public constructor(
         info: StreamInfo,
-        options: StreamInletOptions,
+        options: StreamInletConstructorOptions,
         onData: OnDataCallback
     ) {
         super(info, options, onData)
     }
 
-    public getName() {
-        return this.name
-    }
-
     public getStreamInfo() {
         return this.info
     }

package/src/testDoubles/StreamOutlet/FakeStreamOutlet.ts

@@ -7,6 +7,7 @@ import {
     StreamOutlet,
     StreamOutletOptions,
 } from '../../impl/LslStreamOutlet.js'
+import FakeStreamInfo from '../StreamInfo/FakeStreamInfo.js'
 
 export default class FakeStreamOutlet implements StreamOutlet {
     public static callsToConstructor: {
@@ -17,10 +18,13 @@ export default class FakeStreamOutlet implements StreamOutlet {
     public static callsToPushSample: LslSample[] = []
     public static numCallsToDestroy = 0
 
+    public info: StreamInfo
     public options?: StreamOutletOptions
 
     public constructor(info?: StreamInfo, options?: StreamOutletOptions) {
         FakeStreamOutlet.callsToConstructor.push({ info, options })
+
+        this.info = info ?? new FakeStreamInfo()
         this.options = options
     }