Merge pull request #34 from neurosity/ts

TypeScript migration

.esdoc.json

@@ -2,6 +2,12 @@
   "source": "./src",
   "destination": "./docs",
   "plugins": [
+    {
+      "name": "esdoc-typescript-plugin",
+      "option": {
+        "enable": true
+      }
+    },
     {
       "name": "esdoc-standard-plugin",
       "option": {

.gitignore

@@ -2,8 +2,9 @@ node_modules
 npm-debug.log
 .idea
 dist
-package-lock.json
 build
 .DS_Store
 */.DS_Store
-docs
+docs
+.cache
+.env

README.md

@@ -21,6 +21,41 @@ Get started by installing the library:
 npm install @neurosity/pipes
 ```
 
+## Getting started
+
+```bash
+npm install @neurosity/pipes
+```
+
+Then import the module
+
+##### ESM
+
+```js
+import { epoch } from "@neurosity/pipes";
+```
+
+##### Node
+
+```js
+const { epoch } = require("@neurosity/pipes");
+```
+
+##### Browser
+
+```html
+<script type="module">
+  import { epoch } from "./node_modules/neurosity/pipes/esm/eeg-pipes.mjs";
+</script>
+<script nomodule src="./node_modules/neurosity/pipes/browser/eeg-pipes.js">
+```
+
+##### Electron
+
+```js
+import { epoch } from "@neurosity/pipes/dist/electron";
+```
+
 ## Usage
 
 An Observable of EEG data is required to work with pipes. This can be done by using `fromEvent` from RxJS in order to push callback events into an Observable stream.
@@ -42,11 +77,7 @@ const eeg$ = fromEvent(bci, "data");
 Now we have an Observable of EEG data that support Pipeable operators.
 
 ```js
-eeg$
-  .pipe
-  // ...
-  ()
-  .subscribe();
+eeg$.pipe().subscribe();
 ```
 
 The following are some libraries that provide EEG as RxJS observables out of the box:
@@ -201,4 +232,4 @@ A PSD represents the absolute power of different frequency bins in an Epoch of E
 
 ## Generating documentation
 
-To generate the docs, run `yarn esdoc`
+To generate the docs, run `npm run build:docs`

examples/addInfo.js → examples/addInfo.ts

@@ -1,4 +1,4 @@
-const { createEEG, addInfo } = require("../");
+import { createEEG, addInfo } from "../src";
 
 const eeg1$ = createEEG().pipe(addInfo({ samplingRate: 250 }));
 

examples/createEEG.js → examples/createEEG.ts

@@ -1,4 +1,4 @@
-const { createEEG } = require("..");
+import { createEEG } from "../src";
 
 // defaults to muse-lsl.csv
 const eeg$ = createEEG();

examples/epoching.js → examples/epoching.ts

@@ -1,4 +1,4 @@
-const { createEEG, addInfo, epoch } = require("..");
+import { createEEG, addInfo, epoch } from "../src";
 
 const eeg1$ = createEEG().pipe(
   addInfo({ samplingRate: 256 }),
@@ -15,9 +15,9 @@ const eeg3$ = createEEG({ samplingRate: 1000 }).pipe(
 );
 
 // Should leave info.samplingRate = 128 intact
-const eeg4$ = createEEG({samplingRate: 128}).pipe(
-  addInfo({samplingRate: 128}),
-  epoch({duration: 256, interval: 250 }),
+const eeg4$ = createEEG({ samplingRate: 128 }).pipe(
+  addInfo({ samplingRate: 128 }),
+  epoch({ duration: 256, interval: 250 })
 );
 
 eeg2$.subscribe(console.log);