@neurodevs/node-lsl 8.0.1 → 8.0.3

package/src/implementations/TimeMarkerOutlet.ts

@@ -1,67 +1,67 @@
 import {
-	TimeMarkerOutlet,
-	LslOutletOptions,
-	DurationMarker,
-	TimeMarkerOutletConstructor,
+    TimeMarkerOutlet,
+    LslOutletOptions,
+    DurationMarker,
+    TimeMarkerOutletConstructor,
 } from '../nodeLsl.types'
 import LslOutletImpl from './LslOutlet'
 
 export default class TimeMarkerOutletImpl
-	extends LslOutletImpl
-	implements TimeMarkerOutlet
+    extends LslOutletImpl
+    implements TimeMarkerOutlet
 {
-	public static Class?: TimeMarkerOutletConstructor
+    public static Class?: TimeMarkerOutletConstructor
 
-	private isPlaying: boolean = false
-	private waitResolve?: () => void
-	private timeout?: any
+    private isPlaying = false
+    private waitResolve?: () => void
+    private timeout?: any
 
-	public static Outlet(options?: Partial<LslOutletOptions>) {
-		const defaultOptions = {
-			name: 'Time markers',
-			type: 'Markers',
-			channelNames: ['Markers'],
-			sampleRate: 0,
-			channelFormat: 'string',
-			sourceId: 'time-markers',
-			manufacturer: 'N/A',
-			unit: 'N/A',
-			chunkSize: 0,
-			maxBuffered: 0,
-		} as LslOutletOptions
+    public static Outlet(options?: Partial<LslOutletOptions>) {
+        const defaultOptions = {
+            name: 'Time markers',
+            type: 'Markers',
+            channelNames: ['Markers'],
+            sampleRate: 0,
+            channelFormat: 'string',
+            sourceId: 'time-markers',
+            manufacturer: 'N/A',
+            unit: 'N/A',
+            chunkSize: 0,
+            maxBuffered: 0,
+        } as LslOutletOptions
 
-		return new (this.Class ?? this)({
-			...defaultOptions,
-			...options,
-		}) as TimeMarkerOutlet
-	}
+        return new (this.Class ?? this)({
+            ...defaultOptions,
+            ...options,
+        }) as TimeMarkerOutlet
+    }
 
-	public async pushMarkers(markers: DurationMarker[]) {
-		this.isPlaying = true
+    public async pushMarkers(markers: DurationMarker[]) {
+        this.isPlaying = true
 
-		for (let marker of markers) {
-			this.pushSample([marker.name])
+        for (let marker of markers) {
+            this.pushSample([marker.name])
 
-			await this.wait(marker.durationMs)
+            await this.wait(marker.durationMs)
 
-			if (!this.isPlaying) {
-				return
-			}
-		}
-	}
+            if (!this.isPlaying) {
+                return
+            }
+        }
+    }
 
-	protected async wait(durationMs: number) {
-		return new Promise((resolve) => this.setTimeout(resolve, durationMs))
-	}
+    protected async wait(durationMs: number) {
+        return new Promise((resolve) => this.setTimeout(resolve, durationMs))
+    }
 
-	private setTimeout(resolve: (value: unknown) => void, durationMs: number) {
-		this.waitResolve = resolve as any
-		this.timeout = setTimeout(resolve, durationMs)
-	}
+    private setTimeout(resolve: (value: unknown) => void, durationMs: number) {
+        this.waitResolve = resolve as any
+        this.timeout = setTimeout(resolve, durationMs)
+    }
 
-	public stop() {
-		this.waitResolve?.()
-		clearTimeout(this.timeout)
-		this.isPlaying = false
-	}
+    public stop() {
+        this.waitResolve?.()
+        clearTimeout(this.timeout)
+        this.isPlaying = false
+    }
 }

package/src/nodeLsl.types.ts

@@ -1,113 +1,113 @@
-import { FFIParams } from 'ffi-rs'
+import { FuncObj, FieldType } from 'ffi-rs'
 import { CHANNEL_FORMATS } from './consts'
 
 export interface LslOutlet {
-	destroy(): void
-	pushSample(sample: LslSample): void
+    destroy(): void
+    pushSample(sample: LslSample): void
 }
 
 export interface LslOutletOptions {
-	name: string
-	type: string
-	channelNames: string[]
-	sampleRate: number
-	channelFormat: ChannelFormat
-	sourceId: string
-	manufacturer: string
-	unit: string
-	chunkSize: number
-	maxBuffered: number
+    name: string
+    type: string
+    channelNames: string[]
+    sampleRate: number
+    channelFormat: ChannelFormat
+    sourceId: string
+    manufacturer: string
+    unit: string
+    chunkSize: number
+    maxBuffered: number
 }
 
 export type ChannelFormat = (typeof CHANNEL_FORMATS)[number]
 
 export interface TimeMarkerOutlet extends LslOutlet {
-	pushMarkers(markers: DurationMarker[]): Promise<void>
-	stop(): void
+    pushMarkers(markers: DurationMarker[]): Promise<void>
+    stop(): void
 }
 
 export type TimeMarkerOutletConstructor = new (
-	options: LslOutletOptions
+    options: LslOutletOptions
 ) => TimeMarkerOutlet
 
 export interface DurationMarker {
-	name: string
-	durationMs: number
+    name: string
+    durationMs: number
 }
 
 export interface Liblsl {
-	createStreamInfo(options: CreateStreamInfoOptions): BoundStreamInfo
-	appendChannelsToStreamInfo(options: AppendChannelsToStreamInfoOptions): void
-	createOutlet(options: CreateOutletOptions): BoundOutlet
-	destroyOutlet(options: DestroyOutletOptions): void
-	pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions): void
-	pushSampleStringTimestamp(options: PushSampleStringTimestampOptions): void
-	localClock(): number
+    createStreamInfo(options: CreateStreamInfoOptions): BoundStreamInfo
+    appendChannelsToStreamInfo(options: AppendChannelsToStreamInfoOptions): void
+    createOutlet(options: CreateOutletOptions): BoundOutlet
+    destroyOutlet(options: DestroyOutletOptions): void
+    pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions): void
+    pushSampleStringTimestamp(options: PushSampleStringTimestampOptions): void
+    localClock(): number
 }
 
 export interface CreateStreamInfoOptions {
-	name: string
-	type: string
-	channelCount: number
-	sampleRate: number
-	channelFormat: number
-	sourceId: string
-	manufacturer?: string
-	unit?: string
+    name: string
+    type: string
+    channelCount: number
+    sampleRate: number
+    channelFormat: number
+    sourceId: string
+    manufacturer?: string
+    unit?: string
 }
 
 export interface AppendChannelsToStreamInfoOptions {
-	info: BoundStreamInfo
-	channels: LslChannel[]
+    info: BoundStreamInfo
+    channels: LslChannel[]
 }
 
 export interface CreateOutletOptions {
-	info: BoundStreamInfo
-	chunkSize: number
-	maxBuffered: number
+    info: BoundStreamInfo
+    chunkSize: number
+    maxBuffered: number
 }
 
 export interface DestroyOutletOptions {
-	outlet: BoundOutlet
+    outlet: BoundOutlet
 }
 
 export interface PushSampleFloatTimestampOptions {
-	outlet: BoundOutlet
-	sample: number[]
-	timestamp: number
+    outlet: BoundOutlet
+    sample: number[]
+    timestamp: number
 }
 
 export interface PushSampleStringTimestampOptions {
-	outlet: BoundOutlet
-	sample: string[]
-	timestamp: number
+    outlet: BoundOutlet
+    sample: string[]
+    timestamp: number
 }
 
 export interface LslChannel {
-	label: string
-	unit: string
-	type: string
+    label: string
+    unit: string
+    type: string
 }
 
 export type LslSample = (number | string | undefined)[]
 
 export interface LiblslBindings {
-	lsl_create_streaminfo(
-		options: [string, string, number, number, number, string]
-	): BoundStreamInfo
+    lsl_create_streaminfo(
+        options: [string, string, number, number, number, string]
+    ): BoundStreamInfo
 
-	lsl_create_outlet(options: [BoundStreamInfo, number, number]): BoundOutlet
+    lsl_create_outlet(options: [BoundStreamInfo, number, number]): BoundOutlet
 
-	lsl_destroy_outlet(outlet: [BoundOutlet]): void
+    lsl_destroy_outlet(outlet: [BoundOutlet]): void
 
-	lsl_push_sample_ft(options: [BoundOutlet, LslSample, number]): void
+    lsl_push_sample_ft(options: [BoundOutlet, LslSample, number]): void
 
-	lsl_push_sample_strt(options: [BoundOutlet, LslSample, number]): void
+    lsl_push_sample_strt(options: [BoundOutlet, LslSample, number]): void
 
-	lsl_local_clock(options: []): number
-	lsl_get_desc(info: [BoundStreamInfo]): BoundDescription
-	lsl_append_child(options: [BoundDescription, string]): BoundChild
-	lsl_append_child_value(options: [BoundChild, string, string]): void
+    lsl_local_clock(options: []): number
+    lsl_get_desc(info: [BoundStreamInfo]): BoundDescription
+    lsl_append_child(options: [BoundDescription, string]): BoundChild
+    lsl_append_child_value(options: [BoundChild, string, string]): void
 }
 
 export interface BoundStreamInfo {}
@@ -115,7 +115,4 @@ export interface BoundOutlet {}
 export interface BoundDescription {}
 export interface BoundChild {}
 
-export type FfiRsDefineOptions = Record<
-	string,
-	Omit<FFIParams<any>, 'funcName' | 'paramsValue'>
->
+export type FfiRsDefineOptions = FuncObj<FieldType, boolean | undefined>

package/src/testDoubles/FakeLiblsl.ts

@@ -1,61 +1,63 @@
 import {
-	BoundOutlet,
-	BoundStreamInfo,
-	CreateStreamInfoOptions,
-	AppendChannelsToStreamInfoOptions,
-	CreateOutletOptions,
-	PushSampleFloatTimestampOptions,
-	PushSampleStringTimestampOptions,
-	Liblsl,
+    BoundOutlet,
+    BoundStreamInfo,
+    CreateStreamInfoOptions,
+    AppendChannelsToStreamInfoOptions,
+    CreateOutletOptions,
+    PushSampleFloatTimestampOptions,
+    PushSampleStringTimestampOptions,
+    Liblsl,
 } from '../nodeLsl.types'
 
 export default class FakeLiblsl implements Liblsl {
-	public outlet: BoundOutlet = {} as BoundOutlet
-	public streamInfo: BoundStreamInfo = {} as BoundStreamInfo
-
-	public lastCreateStreamInfoOptions?: CreateStreamInfoOptions
-	public lastAppendChannelsToStreamInfoOptions?: AppendChannelsToStreamInfoOptions
-	public lastCreateOutletOptions?: CreateOutletOptions
-	public lastPushSampleFloatTimestampOptions?: PushSampleFloatTimestampOptions
-	public lastPushSampleStringTimestampOptions?: PushSampleStringTimestampOptions
-
-	public createStreamInfoHitCount = 0
-	public destroyOutletHitCount = 0
-	public localClockHitCount = 0
-	public pushSampleStringTimestampHitCount = 0
-
-	public createStreamInfo(options: CreateStreamInfoOptions) {
-		this.createStreamInfoHitCount++
-		this.lastCreateStreamInfoOptions = options
-		return this.streamInfo
-	}
-
-	public appendChannelsToStreamInfo(
-		options: AppendChannelsToStreamInfoOptions
-	) {
-		this.lastAppendChannelsToStreamInfoOptions = options
-	}
-
-	public createOutlet(options: CreateOutletOptions) {
-		this.lastCreateOutletOptions = options
-		return this.outlet
-	}
-
-	public destroyOutlet() {
-		this.destroyOutletHitCount++
-	}
-
-	public pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions) {
-		this.lastPushSampleFloatTimestampOptions = options
-	}
-
-	public pushSampleStringTimestamp(options: PushSampleStringTimestampOptions) {
-		this.lastPushSampleStringTimestampOptions = options
-		this.pushSampleStringTimestampHitCount++
-	}
-
-	public localClock() {
-		this.localClockHitCount++
-		return new Date().getTime()
-	}
+    public outlet: BoundOutlet = {} as BoundOutlet
+    public streamInfo: BoundStreamInfo = {} as BoundStreamInfo
+
+    public lastCreateStreamInfoOptions?: CreateStreamInfoOptions
+    public lastAppendChannelsToStreamInfoOptions?: AppendChannelsToStreamInfoOptions
+    public lastCreateOutletOptions?: CreateOutletOptions
+    public lastPushSampleFloatTimestampOptions?: PushSampleFloatTimestampOptions
+    public lastPushSampleStringTimestampOptions?: PushSampleStringTimestampOptions
+
+    public createStreamInfoHitCount = 0
+    public destroyOutletHitCount = 0
+    public localClockHitCount = 0
+    public pushSampleStringTimestampHitCount = 0
+
+    public createStreamInfo(options: CreateStreamInfoOptions) {
+        this.createStreamInfoHitCount++
+        this.lastCreateStreamInfoOptions = options
+        return this.streamInfo
+    }
+
+    public appendChannelsToStreamInfo(
+        options: AppendChannelsToStreamInfoOptions
+    ) {
+        this.lastAppendChannelsToStreamInfoOptions = options
+    }
+
+    public createOutlet(options: CreateOutletOptions) {
+        this.lastCreateOutletOptions = options
+        return this.outlet
+    }
+
+    public destroyOutlet() {
+        this.destroyOutletHitCount++
+    }
+
+    public pushSampleFloatTimestamp(options: PushSampleFloatTimestampOptions) {
+        this.lastPushSampleFloatTimestampOptions = options
+    }
+
+    public pushSampleStringTimestamp(
+        options: PushSampleStringTimestampOptions
+    ) {
+        this.lastPushSampleStringTimestampOptions = options
+        this.pushSampleStringTimestampHitCount++
+    }
+
+    public localClock() {
+        this.localClockHitCount++
+        return new Date().getTime()
+    }
 }

package/src/testDoubles/MockTimeMarkerOutlet.ts

@@ -2,60 +2,60 @@ import { assert } from '@sprucelabs/test-utils'
 import { DurationMarker, LslSample, TimeMarkerOutlet } from '..'
 
 export default class MockTimeMarkerOutlet implements TimeMarkerOutlet {
-	private didPushMarkers = false
-	private pushedMarkers?: DurationMarker[]
-	private didPushSamples = false
-	private pushedSamples?: LslSample[]
-
-	public stop() {}
-	public destroy() {}
-
-	public pushSample(sample: LslSample) {
-		if (!this.didPushSamples) {
-			this.didPushSamples = true
-			this.pushedSamples = []
-		}
-		this.pushedSamples?.push(sample)
-	}
-
-	public async pushMarkers(markers: DurationMarker[]) {
-		this.didPushMarkers = true
-		this.pushedMarkers = markers
-	}
-
-	public assertDidPushSamples(samples?: LslSample[]) {
-		assert.isTrue(
-			this.didPushSamples,
-			`Expected to have pushed samples but didn't. Try 'outlet.pushSample(...)'`
-		)
-
-		if (samples) {
-			assert.isEqualDeep(this.pushedSamples, samples)
-		}
-	}
-
-	public assertDidNotPushSamples() {
-		assert.isFalse(
-			this.didPushSamples,
-			`Expected to NOT have pushed samples but did. Try 'outlet.pushSample(...)'`
-		)
-	}
-
-	public assertDidPushMarkers(markers?: DurationMarker[]) {
-		assert.isTrue(
-			this.didPushMarkers,
-			`Expected to have pushed markers but didn't. Try 'outlet.pushMarkers(...)'`
-		)
-
-		if (markers) {
-			assert.isEqualDeep(this.pushedMarkers, markers)
-		}
-	}
-
-	public assertDidNotPushMarkers() {
-		assert.isFalse(
-			this.didPushMarkers,
-			`Expected to NOT have pushed markers but did. Try 'outlet.pushMarkers(...)'`
-		)
-	}
+    private didPushMarkers = false
+    private pushedMarkers?: DurationMarker[]
+    private didPushSamples = false
+    private pushedSamples?: LslSample[]
+
+    public stop() {}
+    public destroy() {}
+
+    public pushSample(sample: LslSample) {
+        if (!this.didPushSamples) {
+            this.didPushSamples = true
+            this.pushedSamples = []
+        }
+        this.pushedSamples?.push(sample)
+    }
+
+    public async pushMarkers(markers: DurationMarker[]) {
+        this.didPushMarkers = true
+        this.pushedMarkers = markers
+    }
+
+    public assertDidPushSamples(samples?: LslSample[]) {
+        assert.isTrue(
+            this.didPushSamples,
+            `Expected to have pushed samples but didn't. Try 'outlet.pushSample(...)'`
+        )
+
+        if (samples) {
+            assert.isEqualDeep(this.pushedSamples, samples)
+        }
+    }
+
+    public assertDidNotPushSamples() {
+        assert.isFalse(
+            this.didPushSamples,
+            `Expected to NOT have pushed samples but did. Try 'outlet.pushSample(...)'`
+        )
+    }
+
+    public assertDidPushMarkers(markers?: DurationMarker[]) {
+        assert.isTrue(
+            this.didPushMarkers,
+            `Expected to have pushed markers but didn't. Try 'outlet.pushMarkers(...)'`
+        )
+
+        if (markers) {
+            assert.isEqualDeep(this.pushedMarkers, markers)
+        }
+    }
+
+    public assertDidNotPushMarkers() {
+        assert.isFalse(
+            this.didPushMarkers,
+            `Expected to NOT have pushed markers but did. Try 'outlet.pushMarkers(...)'`
+        )
+    }
 }

package/src/testDoubles/SpyExtendsTimeMarkerOutlet.ts

@@ -2,17 +2,17 @@ import TimeMarkerOutletImpl from '../implementations/TimeMarkerOutlet'
 import { LslOutletOptions } from '../nodeLsl.types'
 
 export default class SpyExtendsTimeMarkerOutlet extends TimeMarkerOutletImpl {
-	public spyOptions: LslOutletOptions
-	public totalWaitTimeMs: number
+    public spyOptions: LslOutletOptions
+    public totalWaitTimeMs: number
 
-	public constructor(options: LslOutletOptions) {
-		super(options)
-		this.spyOptions = options
-		this.totalWaitTimeMs = 0
-	}
+    public constructor(options: LslOutletOptions) {
+        super(options)
+        this.spyOptions = options
+        this.totalWaitTimeMs = 0
+    }
 
-	public async wait(durationMs: number) {
-		this.totalWaitTimeMs += durationMs
-		return Promise.resolve()
-	}
+    public async wait(durationMs: number) {
+        this.totalWaitTimeMs += durationMs
+        return Promise.resolve()
+    }
 }

package/src/testDoubles/SpyImplementsTimeMarkerOutlet.ts

@@ -1,38 +1,38 @@
 import { DurationMarker, TimeMarkerOutlet } from '../nodeLsl.types'
 
 export default class SpyImplementsTimeMarkerOutlet implements TimeMarkerOutlet {
-	public pushMarkersCalls: DurationMarker[][]
-	public pushSampleCalls: string[][]
-	public numStopCalls: number
-	public numDestroyCalls: number
+    public pushMarkersCalls: DurationMarker[][]
+    public pushSampleCalls: string[][]
+    public numStopCalls: number
+    public numDestroyCalls: number
 
-	public constructor() {
-		this.pushMarkersCalls = []
-		this.pushSampleCalls = []
-		this.numStopCalls = 0
-		this.numDestroyCalls = 0
-	}
+    public constructor() {
+        this.pushMarkersCalls = []
+        this.pushSampleCalls = []
+        this.numStopCalls = 0
+        this.numDestroyCalls = 0
+    }
 
-	public async pushMarkers(markers: DurationMarker[]) {
-		this.pushMarkersCalls.push(markers)
-	}
+    public async pushMarkers(markers: DurationMarker[]) {
+        this.pushMarkersCalls.push(markers)
+    }
 
-	public pushSample(sample: string[]) {
-		this.pushSampleCalls.push(sample)
-	}
+    public pushSample(sample: string[]) {
+        this.pushSampleCalls.push(sample)
+    }
 
-	public stop() {
-		this.numStopCalls++
-	}
+    public stop() {
+        this.numStopCalls++
+    }
 
-	public destroy() {
-		this.numDestroyCalls++
-	}
+    public destroy() {
+        this.numDestroyCalls++
+    }
 
-	public resetSpy() {
-		this.pushMarkersCalls = []
-		this.pushSampleCalls = []
-		this.numStopCalls = 0
-		this.numDestroyCalls = 0
-	}
+    public resetSpy() {
+        this.pushMarkersCalls = []
+        this.pushSampleCalls = []
+        this.numStopCalls = 0
+        this.numDestroyCalls = 0
+    }
 }

package/src/validations.ts

@@ -1,17 +1,17 @@
 export function isStringInArray(value: string, array: readonly string[]) {
-	return array.indexOf(value) !== -1
+    return array.indexOf(value) !== -1
 }
 
 export function isGreaterThanOrEqualToZero(value: number) {
-	return value >= 0
+    return value >= 0
 }
 
 export function isPositiveInteger(value: number) {
-	//@ts-ignore
-	return Number.isInteger(value) && value > 0
+    //@ts-ignore
+    return Number.isInteger(value) && value > 0
 }
 
 export function isPositiveIntegerOrZero(value: number) {
-	//@ts-ignore
-	return Number.isInteger(value) && value >= 0
+    //@ts-ignore
+    return Number.isInteger(value) && value >= 0
 }