Merge pull request #8 from synadia-io/jsdoc

added js doc and refactored some terms

nhgc/jsr.json

@@ -1,5 +1,5 @@
 {
   "name": "@synadiaorbit/nhgc",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "exports": "./mod.ts"
 }

nhgc/kv.ts

@@ -17,9 +17,9 @@ import {
   Kv,
   KvBucketInfo,
   KvEntry,
+  KvOperation,
   KvWatchFn,
   KvWatchOpts,
-  Operation,
   ReviverFn,
   toKvChangeEvent,
   Value,
@@ -33,7 +33,7 @@ type KvE = {
   created: string;
   revision: number;
   delta: number;
-  operation: Operation;
+  operation: KvOperation;
   value: Uint8Array;
 };
 
@@ -65,7 +65,7 @@ class KvEntryImpl implements KvEntry {
         created: r.headers.get("X-Nats-Kv-Created") || "",
         revision: parseInt(r.headers.get("X-Nats-Kv-Revision") || "0"),
         delta: parseInt(r.headers.get("X-Nats-Kv-Delta") || "0"),
-        operation: r.headers.get("X-Nats-Kv-Operation") as Operation,
+        operation: r.headers.get("X-Nats-Kv-Operation") as KvOperation,
         value,
       };
       return Promise.resolve(new KvEntryImpl(kve));
@@ -76,7 +76,7 @@ class KvEntryImpl implements KvEntry {
     return this.entry.value;
   }
 
-  get operation(): Operation {
+  get operation(): KvOperation {
     return this.entry.operation;
   }
 
@@ -241,7 +241,7 @@ export class KvImpl extends HttpImpl implements Kv {
     opts: KvWatchOpts,
   ): Promise<KvWatcher> {
     const args: string[] = [];
-    args.push(`X-Nats-Api-Key=${this.apiKey}`);
+    args.push(`authorization=${this.apiKey}`);
 
     const dopts = Object.assign({
       filter: ">",

nhgc/mod.ts

@@ -15,10 +15,21 @@
 import { Kvm } from "./types.ts";
 import { KvmImpl } from "./kvm.ts";
 
+/**
+ * Interface to the API of the NHG
+ */
 export interface NHG {
+  /**
+   * Return an object that you can use to manage or access
+   * KeyValue stores.
+   */
   kvm: Kvm;
 }
 
+/**
+ * Creates a client for the Nats-Http-Gateway.
+ * @param opts
+ */
 export function newNHG(
   opts: { url: string; apiKey: string },
 ): NHG {

nhgc/nhgc.ts

@@ -50,7 +50,7 @@ export class HttpImpl implements Http {
     }
     const r = Object.assign(opts, { method, body });
     const headers = new Headers(opts.headers);
-    headers.append("X-Nats-Api-Key", this.apiKey);
+    headers.append("Authorization", this.apiKey);
     r.headers = headers;
     return fetch(u, r);
   }