@synnaxlabs/client 0.17.0 → 0.17.1

package/examples/node/basicReadWrite.js

@@ -0,0 +1,67 @@
+import { DataType, Synnax, TimeRange, TimeSpan, TimeStamp } from "@synnaxlabs/client";
+
+// This example demonstrates the basics of reading and writing data from an index and data
+// channel in Synnax. We'll write a sine wave of data to a channel and then read it back.
+
+// Connect to a locally running, insecure Synnax cluster. If your connection parameters
+// are different, enter them here.
+const client = new Synnax({
+    host: "localhost",
+    port: 9090,
+    username: "synnax",
+    password: "seldon",
+    secure: false
+});
+
+// Create an index channel that will be used to store our timestamps.
+const timeChannel = await client.channels.create({
+    name: "basic_read_write_time",
+    isIndex: true,
+    dataType: DataType.TIMESTAMP
+});
+
+// Create a channel that will be used to store our data.
+const indexChannel = await client.channels.create({
+    name: "basic_read_write_data",
+    isIndex: false,
+    dataType: DataType.FLOAT32,
+    // We need to specify the index channel that we want to use to store the timestamps
+    // for this data channel.
+    index: timeChannel.key,
+});
+
+const N_SAMPLES = 5000;
+
+// We'll start our write at the current time. This timestamp should be the same as or 
+// just before the first timestamp we write.
+const start = TimeStamp.now();
+
+// Generate a new timestamp every millisecond for N_SAMPLES.
+const time = BigInt64Array.from({ length: N_SAMPLES }, (_, i) => start.add(TimeSpan.milliseconds(i)).valueOf());
+// Generate a sine wave for N_SAMPLES.
+const data = Float32Array.from({ length: N_SAMPLES }, (_, i) => Math.sin(i / 100));
+
+// Write the data to the channel. Note that we need to write the timestamps first,
+// otherwise writing the data will fail. Notice how we align the writes with the 'start'
+// timestamp.
+await timeChannel.write(start, time);
+await indexChannel.write(start, data);
+
+// Define the time range to read the data back from
+const tr = new TimeRange(start, start.add(TimeSpan.milliseconds(N_SAMPLES)));
+
+// Read the data back. The order doesn't matter here.
+const readTime = await timeChannel.read(tr);
+const readData = await indexChannel.read(tr);
+
+// Print out some information.
+console.log({
+    firstTimestamp: readTime.at(0),
+    firstData: readData.at(0),
+    lastTimestamp: readTime.at(N_SAMPLES - 1),
+    lastData: readData.at(N_SAMPLES - 1),
+    returnLength: readData.length,
+});
+
+// Make sure to close the client when you're done.
+client.close();

package/examples/node/package-lock.json

@@ -9,7 +9,7 @@
       "version": "1.0.0",
       "license": "ISC",
       "dependencies": {
-        "@synnaxlabs/client": "^0.16.4"
+        "@synnaxlabs/client": "^0.17.0"
       }
     },
     "node_modules/@grpc/grpc-js": {
@@ -215,9 +215,9 @@
       }
     },
     "node_modules/@opentelemetry/api-logs": {
-      "version": "0.49.1",
-      "resolved": "https://registry.npmjs.org/@opentelemetry/api-logs/-/api-logs-0.49.1.tgz",
-      "integrity": "sha512-kaNl/T7WzyMUQHQlVq7q0oV4Kev6+0xFwqzofryC66jgGMacd0QH5TwfpbUwSTby+SdAdprAe5UKMvBw4tKS5Q==",
+      "version": "0.50.0",
+      "resolved": "https://registry.npmjs.org/@opentelemetry/api-logs/-/api-logs-0.50.0.tgz",
+      "integrity": "sha512-JdZuKrhOYggqOpUljAq4WWNi5nB10PmgoF0y2CvedLGXd0kSawb/UBnWT8gg1ND3bHCNHStAIVT0ELlxJJRqrA==",
       "peer": true,
       "dependencies": {
         "@opentelemetry/api": "^1.0.0"
@@ -643,11 +643,11 @@
       }
     },
     "node_modules/@opentelemetry/context-zone": {
-      "version": "1.22.0",
-      "resolved": "https://registry.npmjs.org/@opentelemetry/context-zone/-/context-zone-1.22.0.tgz",
-      "integrity": "sha512-ukPkASKUt9l4P3g7Dggntb3jG3dVL4dPXfDc8FUZ6pOCiLa5NRrRPQPbDdCumytbw5Yor9paiXCg/oQgMyYMHw==",
+      "version": "1.23.0",
+      "resolved": "https://registry.npmjs.org/@opentelemetry/context-zone/-/context-zone-1.23.0.tgz",
+      "integrity": "sha512-7piNTrpH+gZNMDDOHIJXCSwp0Xslh3R96HWH5HwXw+4PykR4+jVoXvd6jziQxudX9rFAfu2B64A10DHs4ZWrfA==",
       "dependencies": {
-        "@opentelemetry/context-zone-peer-dep": "1.22.0",
+        "@opentelemetry/context-zone-peer-dep": "1.23.0",
         "zone.js": "^0.11.0 || ^0.13.0 || ^0.14.0"
       },
       "engines": {
@@ -655,9 +655,9 @@
       }
     },
     "node_modules/@opentelemetry/context-zone-peer-dep": {
-      "version": "1.22.0",
-      "resolved": "https://registry.npmjs.org/@opentelemetry/context-zone-peer-dep/-/context-zone-peer-dep-1.22.0.tgz",
-      "integrity": "sha512-kQ0K6syNQQYj4Pd5Q4yiUAsuthpzWDmVPPqMUSACh9ArRYLq8ZY9JdnkqkT1RyeecpSDh5uG+x5dbx6drpJ79g==",
+      "version": "1.23.0",
+      "resolved": "https://registry.npmjs.org/@opentelemetry/context-zone-peer-dep/-/context-zone-peer-dep-1.23.0.tgz",
+      "integrity": "sha512-3ia5w2y3CGHIhMSggttliGbeRBWclIyMMXdfRCcit1NHg1ocieA9qYxyUEetbOvPrQpoti3O3k+5eyQUv7r8nw==",
       "engines": {
         "node": ">=14"
       },
@@ -667,11 +667,11 @@
       }
     },
     "node_modules/@opentelemetry/core": {
-      "version": "1.22.0",
-      "resolved": "https://registry.npmjs.org/@opentelemetry/core/-/core-1.22.0.tgz",
-      "integrity": "sha512-0VoAlT6x+Xzik1v9goJ3pZ2ppi6+xd3aUfg4brfrLkDBHRIVjMP0eBHrKrhB+NKcDyMAg8fAbGL3Npg/F6AwWA==",
+      "version": "1.23.0",
+      "resolved": "https://registry.npmjs.org/@opentelemetry/core/-/core-1.23.0.tgz",
+      "integrity": "sha512-hdQ/a9TMzMQF/BO8Cz1juA43/L5YGtCSiKoOHmrTEf7VMDAZgy8ucpWx3eQTnQ3gBloRcWtzvcrMZABC3PTSKQ==",
       "dependencies": {
-        "@opentelemetry/semantic-conventions": "1.22.0"
+        "@opentelemetry/semantic-conventions": "1.23.0"
       },
       "engines": {
         "node": ">=14"
@@ -3185,12 +3185,12 @@
       }
     },
     "node_modules/@opentelemetry/resources": {
-      "version": "1.22.0",
-      "resolved": "https://registry.npmjs.org/@opentelemetry/resources/-/resources-1.22.0.tgz",
-      "integrity": "sha512-+vNeIFPH2hfcNL0AJk/ykJXoUCtR1YaDUZM+p3wZNU4Hq98gzq+7b43xbkXjadD9VhWIUQqEwXyY64q6msPj6A==",
+      "version": "1.23.0",
+      "resolved": "https://registry.npmjs.org/@opentelemetry/resources/-/resources-1.23.0.tgz",
+      "integrity": "sha512-iPRLfVfcEQynYGo7e4Di+ti+YQTAY0h5mQEUJcHlU9JOqpb4x965O6PZ+wMcwYVY63G96KtdS86YCM1BF1vQZg==",
       "dependencies": {
-        "@opentelemetry/core": "1.22.0",
-        "@opentelemetry/semantic-conventions": "1.22.0"
+        "@opentelemetry/core": "1.23.0",
+        "@opentelemetry/semantic-conventions": "1.23.0"
       },
       "engines": {
         "node": ">=14"
@@ -3425,13 +3425,13 @@
       }
     },
     "node_modules/@opentelemetry/sdk-trace-base": {
-      "version": "1.22.0",
-      "resolved": "https://registry.npmjs.org/@opentelemetry/sdk-trace-base/-/sdk-trace-base-1.22.0.tgz",
-      "integrity": "sha512-pfTuSIpCKONC6vkTpv6VmACxD+P1woZf4q0K46nSUvXFvOFqjBYKFaAMkKD3M1mlKUUh0Oajwj35qNjMl80m1Q==",
+      "version": "1.23.0",
+      "resolved": "https://registry.npmjs.org/@opentelemetry/sdk-trace-base/-/sdk-trace-base-1.23.0.tgz",
+      "integrity": "sha512-PzBmZM8hBomUqvCddF/5Olyyviayka44O5nDWq673np3ctnvwMOvNrsUORZjKja1zJbwEuD9niAGbnVrz3jwRQ==",
       "dependencies": {
-        "@opentelemetry/core": "1.22.0",
-        "@opentelemetry/resources": "1.22.0",
-        "@opentelemetry/semantic-conventions": "1.22.0"
+        "@opentelemetry/core": "1.23.0",
+        "@opentelemetry/resources": "1.23.0",
+        "@opentelemetry/semantic-conventions": "1.23.0"
       },
       "engines": {
         "node": ">=14"
@@ -3513,13 +3513,13 @@
       }
     },
     "node_modules/@opentelemetry/sdk-trace-web": {
-      "version": "1.22.0",
-      "resolved": "https://registry.npmjs.org/@opentelemetry/sdk-trace-web/-/sdk-trace-web-1.22.0.tgz",
-      "integrity": "sha512-id5bUhWYg475xbm4hjwWA4PnWM4duNK1EyFRkZxa3BZNuCITwiKCLvDkVhlE9RK2kvuDOPmcRxgSbU1apF9/1w==",
+      "version": "1.23.0",
+      "resolved": "https://registry.npmjs.org/@opentelemetry/sdk-trace-web/-/sdk-trace-web-1.23.0.tgz",
+      "integrity": "sha512-tx9N3hIkd6k567BeujBnpXYdhu3ptYVk0ZkhdcjyQ3I8ZDJ+/JkVtaVNLAuf8hp1buTqNDmxSipALMxEmK2fnw==",
       "dependencies": {
-        "@opentelemetry/core": "1.22.0",
-        "@opentelemetry/sdk-trace-base": "1.22.0",
-        "@opentelemetry/semantic-conventions": "1.22.0"
+        "@opentelemetry/core": "1.23.0",
+        "@opentelemetry/sdk-trace-base": "1.23.0",
+        "@opentelemetry/semantic-conventions": "1.23.0"
       },
       "engines": {
         "node": ">=14"
@@ -3529,9 +3529,9 @@
       }
     },
     "node_modules/@opentelemetry/semantic-conventions": {
-      "version": "1.22.0",
-      "resolved": "https://registry.npmjs.org/@opentelemetry/semantic-conventions/-/semantic-conventions-1.22.0.tgz",
-      "integrity": "sha512-CAOgFOKLybd02uj/GhCdEeeBjOS0yeoDeo/CA7ASBSmenpZHAKGB3iDm/rv3BQLcabb/OprDEsSQ1y0P8A7Siw==",
+      "version": "1.23.0",
+      "resolved": "https://registry.npmjs.org/@opentelemetry/semantic-conventions/-/semantic-conventions-1.23.0.tgz",
+      "integrity": "sha512-MiqFvfOzfR31t8cc74CTP1OZfz7MbqpAnLCra8NqQoaHJX6ncIRTdYOQYBDQ2uFISDq0WY8Y9dDTWvsgzzBYRg==",
       "engines": {
         "node": ">=14"
       }
@@ -3639,26 +3639,38 @@
         "node": ">=18"
       }
     },
+    "node_modules/@synnaxlabs/alamos/node_modules/@synnaxlabs/x": {
+      "version": "0.13.0",
+      "resolved": "https://registry.npmjs.org/@synnaxlabs/x/-/x-0.13.0.tgz",
+      "integrity": "sha512-9Sh5Io7/Ywegk/axxwHA2wDsmdYL28RQYKUo+gkXtzM6+uj1JSpFvyZFVRSx21uP3p6ABE9MwFCZcCY2/N1iWw==",
+      "dependencies": {
+        "async-mutex": "^0.4.0",
+        "js-convert-case": "^4.2.0",
+        "msgpackr": "^1.9.9",
+        "nanoid": "^5.0.2",
+        "typescript": "^5.3.3",
+        "zod": "3.22.4"
+      }
+    },
     "node_modules/@synnaxlabs/client": {
-      "version": "0.16.4",
-      "resolved": "https://registry.npmjs.org/@synnaxlabs/client/-/client-0.16.4.tgz",
-      "integrity": "sha512-vOj3AZivCv1QUZI4fuZPhm+8bEaXaEMrN8q3dPSTTZmih4WXxl4wApP0CNdNHdr9qQb6xIa+SKSoxQYN5ZfvXw==",
+      "version": "0.17.0",
+      "resolved": "https://registry.npmjs.org/@synnaxlabs/client/-/client-0.17.0.tgz",
+      "integrity": "sha512-ydQpLQ0MUpkvJ/TqHidWNSRSdz6DoSctSbaCu/+TuDy74bIamDWBMQu5fmsTcA5NeQzzmFZgiOMRaFOa9fG1gg==",
       "dependencies": {
-        "@synnaxlabs/freighter": "0.8.1",
-        "@synnaxlabs/x": "0.13.0",
+        "@synnaxlabs/freighter": "0.9.1",
+        "@synnaxlabs/x": "0.14.1",
         "async-mutex": "^0.4.0",
         "zod": "3.22.4"
       }
     },
     "node_modules/@synnaxlabs/freighter": {
-      "version": "0.8.1",
-      "resolved": "https://registry.npmjs.org/@synnaxlabs/freighter/-/freighter-0.8.1.tgz",
-      "integrity": "sha512-Ujd3Ls15eTRFOCgM8sWrHuu9QKFh5/xM+K+sPCgu1s6Tl9IrBYdhEzJFvGHUZnvfXegblABacGS3ErMvtdtq7A==",
+      "version": "0.9.1",
+      "resolved": "https://registry.npmjs.org/@synnaxlabs/freighter/-/freighter-0.9.1.tgz",
+      "integrity": "sha512-0ulbbzZ5XixGJgy/ri6ecl9qNrU2NrSj5Sb+vfSb3438CXeTmSY+Q1aJ8/Ksk5sl97AHbtKIGZyuV75AHX6RHw==",
       "dependencies": {
         "@synnaxlabs/alamos": "0.3.0",
-        "@synnaxlabs/x": "0.13.0",
+        "@synnaxlabs/x": "0.14.1",
         "js-convert-case": "^4.2.0",
-        "msgpackr": "^1.10.0",
         "node-fetch": "2.6.11",
         "ws": "^8.15.1",
         "zod": "3.22.4"
@@ -3668,9 +3680,9 @@
       }
     },
     "node_modules/@synnaxlabs/x": {
-      "version": "0.13.0",
-      "resolved": "https://registry.npmjs.org/@synnaxlabs/x/-/x-0.13.0.tgz",
-      "integrity": "sha512-9Sh5Io7/Ywegk/axxwHA2wDsmdYL28RQYKUo+gkXtzM6+uj1JSpFvyZFVRSx21uP3p6ABE9MwFCZcCY2/N1iWw==",
+      "version": "0.14.1",
+      "resolved": "https://registry.npmjs.org/@synnaxlabs/x/-/x-0.14.1.tgz",
+      "integrity": "sha512-+rLxNBvFwZjU0JVRslzGoB5OCixITlRIsfibRMGV/P5lUzylA1BKBiAsjrg8i4gWtTx3pQUyrunTFbiTe0HWmA==",
       "dependencies": {
         "async-mutex": "^0.4.0",
         "js-convert-case": "^4.2.0",
@@ -3874,9 +3886,9 @@
       }
     },
     "node_modules/@types/node": {
-      "version": "20.12.2",
-      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.12.2.tgz",
-      "integrity": "sha512-zQ0NYO87hyN6Xrclcqp7f8ZbXNbRfoGWNcMvHTPQp9UUrwI0mI7XBz+cu7/W6/VClYo2g63B0cjull/srU7LgQ==",
+      "version": "20.12.3",
+      "resolved": "https://registry.npmjs.org/@types/node/-/node-20.12.3.tgz",
+      "integrity": "sha512-sD+ia2ubTeWrOu+YMF+MTAB7E+O7qsMqAbMfW7DG3K1URwhZ5hN1pLlRVGbf4wDFzSfikL05M17EyorS86jShw==",
       "dependencies": {
         "undici-types": "~5.26.4"
       }
@@ -3919,9 +3931,9 @@
       }
     },
     "node_modules/@types/serve-static": {
-      "version": "1.15.6",
-      "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.6.tgz",
-      "integrity": "sha512-xkChxykiNb1X2YBevPIhQhNU9m9M7h9e2gDsmePAP2kNqhOvpKOrZWOCzq2ERQqfNFzlzHG2bdM0u3z5x+gQgg==",
+      "version": "1.15.7",
+      "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.7.tgz",
+      "integrity": "sha512-W8Ym+h8nhuRwaKPaDw34QUkwsGi6Rc4yYqvKFo5rm2FUEhCFbzVWrxXUxuKK8TASjWsysJY0nsmNCGhCOIsrOw==",
       "dependencies": {
         "@types/http-errors": "*",
         "@types/node": "*",
@@ -4500,9 +4512,9 @@
       }
     },
     "node_modules/joi": {
-      "version": "17.12.2",
-      "resolved": "https://registry.npmjs.org/joi/-/joi-17.12.2.tgz",
-      "integrity": "sha512-RonXAIzCiHLc8ss3Ibuz45u28GOsWE1UpfDXLbN/9NKbL4tCJf8TWYVKsoYuuh+sAUt7fsSNpA+r2+TBA6Wjmw==",
+      "version": "17.12.3",
+      "resolved": "https://registry.npmjs.org/joi/-/joi-17.12.3.tgz",
+      "integrity": "sha512-2RRziagf555owrm9IRVtdKynOBeITiDpuZqIpgwqXShPncPKNiRQoiGsl/T8SQdq+8ugRzH2LqY67irr2y/d+g==",
       "dependencies": {
         "@hapi/hoek": "^9.3.0",
         "@hapi/topo": "^5.1.0",

package/examples/node/package.json

@@ -11,6 +11,6 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@synnaxlabs/client": "^0.16.4"
+    "@synnaxlabs/client": "^0.17.0"
   }
 }

package/examples/node/streamWrite.js

@@ -0,0 +1,23 @@
+// This example demonstrates how to write data to an index channel and its corresponding
+// data channel in Synnax in a streaming fashion. Streaming data is ideal for live
+// applications (such as data acquisition from a sensor) or for very large datasets that
+// cannot be written all at once.
+
+import { Synnax } from "@synnaxlabs/client";
+
+// Connect to a locally running, insecure Synnax cluster. If your connection parameters
+// are different, enter them here.
+const client = new Synnax({
+    host: "localhost",
+    port: 9090,
+    username: "synnax",
+    password: "seldon",
+    secure: false
+});
+
+// Create an index channel that will be used to store our timestamps.
+const timeChannel = await client.channels.create({
+    name: "stream_write_example_time",
+    isIndex: true,
+    dataType: "timestamp"
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synnaxlabs/client",
   "private": false,
-  "version": "0.17.0",
+  "version": "0.17.1",
   "type": "module",
   "description": "The Client Library for Synnax",
   "repository": "https://github.com/synnaxlabs/synnax/tree/main/client/ts",
@@ -18,8 +18,8 @@
   "dependencies": {
     "async-mutex": "^0.4.0",
     "zod": "3.22.4",
-    "@synnaxlabs/freighter": "0.9.1",
-    "@synnaxlabs/x": "0.14.1"
+    "@synnaxlabs/x": "0.14.1",
+    "@synnaxlabs/freighter": "0.9.1"
   },
   "devDependencies": {
     "@types/node": "^20.10.5",
@@ -27,9 +27,9 @@
     "typescript": "^5.3.3",
     "vite": "^5.1.2",
     "vitest": "^1.2.2",
+    "@synnaxlabs/vite-plugin": "0.0.1",
     "@synnaxlabs/tsconfig": "0.0.2",
-    "eslint-config-synnaxlabs": "0.0.1",
-    "@synnaxlabs/vite-plugin": "0.0.1"
+    "eslint-config-synnaxlabs": "0.0.1"
   },
   "main": "dist/client.cjs",
   "module": "dist/client.js",

package/src/channel/channel.spec.ts

@@ -7,8 +7,8 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { DataType, Rate } from "@synnaxlabs/x";
-import { describe, test, expect } from "vitest";
+import { DataType, Rate, TimeStamp } from "@synnaxlabs/x";
+import { describe, test, expect, it } from "vitest";
 
 import { QueryError } from "@/errors";
 import { newClient } from "@/setupspecs";
@@ -62,6 +62,72 @@ describe("Channel", () => {
       expect(channels[0].name).toEqual("test1");
       expect(channels[1].name).toEqual("test2");
     });
+    describe("retrieveIfNameExists", () => {
+      it("should retrieve the existing channel when it exists", async () => {
+        const name = `test-${Math.random()}-${TimeStamp.now().valueOf()}`
+        const channel = await client.channels.create({
+          name,
+          leaseholder: 1,
+          rate: Rate.hz(1),
+          dataType: DataType.FLOAT32,
+        });
+        const channelTwo = await client.channels.create({
+          name,
+          leaseholder: 1,
+          rate: Rate.hz(1),
+          dataType: DataType.FLOAT32,
+        },
+        {retrieveIfNameExists: true}
+        );
+        expect(channelTwo.key).toEqual(channel.key);
+      });
+      it("should create a new channel when it does not exist", async () => {
+        const name = `test-${Math.random()}-${TimeStamp.now().valueOf()}`
+        const channel = await client.channels.create({
+          name,
+          leaseholder: 1,
+          rate: Rate.hz(1),
+          dataType: DataType.FLOAT32,
+        });
+        const channelTwo = await client.channels.create({
+          name: `${name}-2`,
+          leaseholder: 1,
+          rate: Rate.hz(1),
+          dataType: DataType.FLOAT32,
+        },
+        {retrieveIfNameExists: true}
+        );
+        expect(channelTwo.key).not.toEqual(channel.key);
+      });
+      it("should retrieve and create the correct channels when creating many", async () => {
+        const name = `test-${Math.random()}-${TimeStamp.now().valueOf()}`
+        const channel = await client.channels.create({
+          name,
+          leaseholder: 1,
+          rate: Rate.hz(1),
+          dataType: DataType.FLOAT32,
+        });
+        const channelTwo = await client.channels.create([
+          {
+            name,
+            leaseholder: 1,
+            rate: Rate.hz(1),
+            dataType: DataType.FLOAT32,
+          },
+          {
+            name: `${name}-2`,
+            leaseholder: 1,
+            rate: Rate.hz(1),
+            dataType: DataType.FLOAT32,
+          },
+        ],
+        {retrieveIfNameExists: true}
+        );
+        expect(channelTwo.length).toEqual(2);
+        expect(channelTwo[0].key).toEqual(channel.key);
+        expect(channelTwo[1].key).not.toEqual(channel.key);
+      });
+    })
   });
   test("retrieve by key", async () => {
     const channel = await client.channels.create({

package/src/channel/client.ts

@@ -39,6 +39,10 @@ import {
 import { MultipleResultsError, NoResultsError, ValidationError } from "@/errors";
 import { type framer } from "@/framer";
 
+interface CreateOptions {
+  retrieveIfNameExists?: boolean;
+}
+
 /**
  * Represents a Channel in a Synnax database. Typically, channels should not be
  * instantiated directly, but instead created via the `.channels.create` or retrieved
@@ -216,7 +220,7 @@ export class Client implements AsyncTermSearcher<string, Key, Channel> {
    * });
    * ```
    */
-  async create(channel: NewPayload): Promise<Channel>;
+  async create(channel: NewPayload, options?: CreateOptions): Promise<Channel>;
 
   /**
    * Creates multiple channels with the given properties. The order of the channels
@@ -241,13 +245,21 @@ export class Client implements AsyncTermSearcher<string, Key, Channel> {
    *
    * @param channels
    */
-  async create(channels: NewPayload[]): Promise<Channel[]>;
+  async create(channels: NewPayload[], options?: CreateOptions): Promise<Channel[]>;
 
-  async create(channels: NewPayload | NewPayload[]): Promise<Channel | Channel[]> {
+  async create(channels: NewPayload | NewPayload[], options: CreateOptions = {}): Promise<Channel | Channel[]> {
+    const { retrieveIfNameExists = false } = options;
     const single = !Array.isArray(channels);
-    const payloads = await this.creator.create(toArray(channels));
-    const res = this.sugar(payloads);
-    return single ? res[0] : res;
+    let toCreate = toArray(channels);
+    let created: Channel[] = [];
+    if (retrieveIfNameExists) {
+      const res = await this.retriever.retrieve(toCreate.map((c) => c.name));
+      const existingNames = new Set(res.map((c) => c.name));
+      toCreate = toCreate.filter((c) => !existingNames.has(c.name));
+      created = this.sugar(res);
+    }
+    created = created.concat(this.sugar(await this.creator.create(toCreate)));
+    return single ? created[0] : created;
   }
 
   /**

package/examples/node/basicReadWriter.js

@@ -1,66 +0,0 @@
-import { DataType, Synnax, TimeSpan, TimeStamp } from "@synnaxlabs/client";
-
-const client = new Synnax({
-    host: "localhost",
-    port: 9090,
-    username: "synnax",
-    password: "seldon",
-    secure: false
-});
-
-const time_channel = await client.channels.create({
-    name: "basic_read_write_time",
-    isIndex: true,
-    dataType: DataType.TIMESTAMP
-});
-
-const data_channel = await client.channels.create({
-    name: "basic_read_write_data",
-    isIndex: false,
-    dataType: DataType.FLOAT32,
-    index: time_channel.key,
-});
-
-const N_SAMPLES = 500;
-
-const start = TimeStamp.now();
-
-console.log(BigInt(start.valueOf().toString()) - BigInt(start.bigInt.toString()))
-
-const data = Float32Array.from({ length: N_SAMPLES }, (_, i) => Math.sin(i / 100));
-const time = BigInt64Array.from({ length: N_SAMPLES }, (_, i) => BigInt(start.add(TimeSpan.milliseconds(i)).valueOf()));
-console.log(time[0], start, Number(time[0]) - start.valueOf())
-
-console.log(time_channel.key, data_channel.key)
-
-// await client.telem.write(time_channel.key, start, time);
-// await client.telem.write(data_channel.key, start, data);
-
-const w1 = await client.telem.newWriter({
-    start,
-    channels: time_channel.key,
-});
-try {
-    await w1.write(time_channel.key, time);
-    console.log(await w1.commit());
-} finally {
-    await w1.close();
-}
-
-const w = await client.telem.newWriter({
-    start,
-    channels: data_channel.key,
-});
-try {
-    await w.write(data_channel.key, data);
-    console.log(await w.commit());
-} finally {
-    await w.close();
-}
-
-
-// await client.telem.write(data_channel.key, start, data);
-
-// console.log("HERE")
-
-client.close();