@rangedb/js 1.0.0 → 1.1.0

package/dist/index.d.ts

@@ -121,23 +121,31 @@ export class RangeDB {
      */
     getMetadata(): Promise<JSONObject | JSONArray>;
     /**
-     * Get a raw ArrayBuffer from database for given key or null if not exists
+     * Get a raw ArrayBuffer from database for given key or null if not exists.
      *
-     * @param {bigint} key
+     * @param {bigint | number} key
      *
      * @returns {Promise<ArrayBuffer | null>}
-     * */
-    getRaw(key: bigint): Promise<ArrayBuffer | null>;
+     */
+    getRaw(key: bigint | number): Promise<ArrayBuffer | null>;
+    /**
+     * Get a string from database for a given key or null if not exists
+     *
+     * @param {bigint | number} key
+     *
+     * @returns {Promise<string | null>}
+     */
+    getString(key: bigint | number): Promise<string | null>;
     /**
      * Get a JSON from database for a given key or null if not exists
      * It may throw JSON parsing error
      *
-     * @param {bigint} key
+     * @param {bigint | number} key
      *
      * @returns {Promise<JSONValue | null>}
      * @throws {SyntaxError}
      */
-    getJson(key: bigint): Promise<JSONValue | null>;
+    getJson(key: bigint | number): Promise<JSONValue | null>;
 }
 export type RangeDBOptions = {
     /**

package/index.js

@@ -101,7 +101,7 @@ export class RangeDB {
    * @returns {Promise<ArrayBuffer>}
    */
   async readRange(start, end) {
-    const {headers, arrayBuffer} = await fetch(this.url, {
+    const { headers, arrayBuffer } = await fetch(this.url, {
       headers: {
         range: `bytes=${start}-${end}`,
       },
@@ -291,13 +291,16 @@ export class RangeDB {
   }
 
   /**
-   * Get a raw ArrayBuffer from database for given key or null if not exists
+   * Get a raw ArrayBuffer from database for given key or null if not exists.
    *
-   * @param {bigint} key
+   * @param {bigint | number} key
    *
    * @returns {Promise<ArrayBuffer | null>}
-   * */
+   */
   async getRaw(key) {
+    if (typeof key === 'number') {
+      key = BigInt(key)
+    }
     if (!this.index) {
       await this.getIndex()
     }
@@ -312,21 +315,35 @@ export class RangeDB {
     return RangeDB.findInChunk(key, chunkBuffer)
   }
 
+  /**
+   * Get a string from database for a given key or null if not exists
+   *
+   * @param {bigint | number} key
+   *
+   * @returns {Promise<string | null>}
+   */
+  async getString(key) {
+    const buffer = await this.getRaw(key)
+    if (buffer === null) {
+      return null
+    }
+    return new TextDecoder().decode(buffer)
+  }
+
   /**
    * Get a JSON from database for a given key or null if not exists
    * It may throw JSON parsing error
    *
-   * @param {bigint} key
+   * @param {bigint | number} key
    *
    * @returns {Promise<JSONValue | null>}
    * @throws {SyntaxError}
    */
   async getJson(key) {
-    const buffer = await this.getRaw(key)
-    if (buffer === null) {
+    const str = await this.getString(key)
+    if (str === null) {
       return null
     }
-    const string = new TextDecoder().decode(buffer)
-    return JSON.parse(string)
+    return JSON.parse(str)
   }
 }

package/package.json

@@ -1,7 +1,10 @@
 {
   "name": "@rangedb/js",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "type": "module",
+  "repository": {
+    "url": "https://github.com/RangeDB/rangedb"
+  },
   "main": "./index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -11,7 +14,7 @@
     }
   },
   "scripts": {
-    "build:types": "npx -p typescript tsc",
+    "build:types": "tsc",
     "prepare": "npm run build:types",
     "test": "node --test --experimental-test-coverage",
     "test:watch": "node --test --watch"
@@ -25,6 +28,6 @@
   ],
   "publishConfig": {
     "access": "public",
-    "provenance": false
+    "provenance": true
   }
 }