🎨 ✨ change signature of set

change signature of set

🎨 Improve format/structure, ✨ New feature

README.md

@@ -2,7 +2,7 @@
 
 Turn [gist](https://gist.github.com/) into your personal key/value data-store.
 
-- 🚀 [Example repo]() of a todo list build with Next.js.
+- 🚀 [Example repo](https://github.com/TimMikeladze/gist-database-nextjs) of a todo list build with Next.js.
 - 🔗 [Demo app]() deployed with Vercel.
 
 ```console
@@ -67,7 +67,9 @@ const db = new GistDatabase({
 })
 
 const res = await db.set('key', {
- hello: 'world'
+ value: {
+ hello: 'world'
+ }
 })
 
 const found = await db.get('key')
@@ -83,8 +85,10 @@ const found = await db.get('key')
  **/
 
 const updated = await db.set('key', {
- hello: 'world',
- foo: 'bar'
+ value: {
+ hello: 'world',
+ foo: 'bar'
+ }
 })
 
 /**
@@ -102,13 +106,10 @@ await db.has('key') // true
 
 await db.delete('key') // void
 
-await db.set(
- 'key_with_ttl',
- {
- description: "I'll expire soon and be deleted upon retrieval"
- },
- 1000
-)
+await db.set('key_with_ttl', {
+ ttl: 1000, // 1 second
+ description: "I'll expire soon and be deleted upon retrieval"
+})
 
 // Get or delete many keys at once. `undefined` will be returned for keys that don't exist.
 

__tests__/GistDatabase.test.ts

@@ -15,7 +15,9 @@ describe('GistDatabase', () => {
  })
  it('sets and gets', async () => {
  const res = await db.set('test_one', {
- name: 'test_one'
+ value: {
+ name: 'test_one'
+ }
  })
  expect(res).toMatchObject({
  value: {
@@ -34,7 +36,9 @@ describe('GistDatabase', () => {
  })
  it('deletes', async () => {
  await db.set('test_two', {
- name: 'test_two'
+ value: {
+ name: 'test_two'
+ }
  })
  expect(await db.get('test_two')).toEqual({
  value: {
@@ -47,13 +51,10 @@ describe('GistDatabase', () => {
  expect(await db.get('test_two')).toBeUndefined()
  })
  it('key with a ttl gets deleted', async () => {
- const res = await db.set(
- 'test_ttl',
- {
- name: 'test_ttl'
- },
- 250
- )
+ const res = await db.set('test_ttl', {
+ value: {},
+ ttl: 250
+ })
 
  await sleep(500)
 

src/GistDatabase.ts

@@ -185,10 +185,13 @@ export class GistDatabase {
 
  public async set<T = any>(
  key: string | string[],
- value: T,
- ttl?: number,
- description?: string
+ args: {
+ description?: string
+ ttl?: number
+ value?: T
+ }
  ): Promise<Doc<T>> {
+ const { description, ttl, value = {} } = args
  if (!isPlainObject(value)) {
  throw new Error('value must be a plain javascript object')
  }
@@ -244,7 +247,7 @@ export class GistDatabase {
  }
 
  return {
- value,
+ value: value as T,
  gist,
  id: gist.id
  }