✅ 📚 test read and writing nested keys.

test read and writing nested keys.

✅ Adding a test, 📚 Documentation

Author: TimMikeladze

README.md

@@ -153,6 +153,16 @@ try {
   console.log(err)
 }
 
+// It's possible to pass arrays as key names. This is especially useful if you want to scope your data to a specific user or group. Internally all array keys will be joined with a `.` character.
+
+await db.set<ExampleData>(['user', 'testUserId'], {
+  value: {
+    displayName: 'Test User'
+  }
+})
+
+await db.get<ExampleData>(['user', 'testUserId'])
+
 await db.has('key') // true
 
 await db.keys() // ['key']

__tests__/GistDatabase.test.ts

@@ -6,6 +6,7 @@ const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms))
 let index = 0
 
 for (const compressionType of Object.values(CompressionType)) {
+  // for (const compressionType of [CompressionType.msgpack]) {
   it('GistDatabase - initialize with existing gist id', async () => {
     const db = new GistDatabase({
       token: process.env.GIST_TOKEN
@@ -203,7 +204,45 @@ it('get and set and del static util functions', () => {
   expect(GistDatabase.get(res, ['a'])).toBe(2)
 })
 
-describe('GistDatabase - advanced scenario', () => {
+describe('GistDatabase - works with nested keys', () => {
+  let db: GistDatabase
+  beforeAll(async () => {
+    db = new GistDatabase({
+      token: process.env.GIST_TOKEN,
+      compression: CompressionType.pretty
+    })
+  })
+  afterAll(async () => {
+    await db.destroy()
+  })
+  it('writes and reads a nested key', async () => {
+    await db.set(['parent'], {
+      value: {
+        name: 'parent'
+      }
+    })
+
+    await db.set(['parent', 'child'], {
+      value: {
+        name: 'child'
+      }
+    })
+
+    expect(await db.get(['parent'])).toMatchObject({
+      value: {
+        name: 'parent'
+      }
+    })
+
+    expect(await db.get(['parent', 'child'])).toMatchObject({
+      value: {
+        name: 'child'
+      }
+    })
+  })
+})
+
+describe('GistDatabase - advanced scenario 1', () => {
   let db: GistDatabase
   beforeAll(async () => {
     db = new GistDatabase({
@@ -299,7 +338,7 @@ describe('GistDatabase - advanced scenario', () => {
   })
 })
 
-describe('GistDatabase - advanced scenario', () => {
+describe('GistDatabase - advanced scenario 2', () => {
   let db: GistDatabase
   beforeAll(async () => {
     db = new GistDatabase({