Simple Storage

[johnlindquist]

Read and Write Using the db Helper

The db helpers reads/writes to json files in the ~/.kenv/db directory. It's meant as a simple wrapper around common json operations.

// Menu: Database Read/Write Example
// Description: Add/remove items from a list of fruit

let fruitDb = await db(["apple", "banana", "orange"])

// This will keep prompting until you hit Escape
while (true) {
  let fruitToAdd = await arg(
    {
      placeholder: "Add a fruit",
      //allows to submit input not in the list
      strict: false,
    },
    fruitDb.items
  )

  fruitDb.items.push(fruitToAdd)
  await fruitDb.write()

  let fruitToDelete = await arg(
    "Delete a fruit",
    fruitDb.items
  )

  fruitDb.items = fruitDb.items.filter(
    fruit => fruit !== fruitToDelete
  )

  await fruitDb.write()
}

Open db-store in Script Kit

[peterroe]

Nice feature!

[frontendwizard]

I notice the types don't really allow you to type the db. Reading the code, I found this:

export declare let db: (key: any, defaults?: any, fromCache?: boolean) => Promise<Low & any>;

I suppose this type should change to support a generic that describe the type of things that are going to live on this db. It's really clear to me what key really means in this context. from this script it looks like key is actually the initial items on the db. Do all of these items get inserted into a items array?

[frontendwizard]

oh, ts type is just misleading. If I understood correctly, this method also has an overload that allow you to use it without a key param, just passing the defaults and that gets the content into an items array. I'll open an issue on this.

[frontendwizard]

#859