npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@picgo/store

v2.1.0

Published

For PicGo projects to write & read data or configuration in disk.

Downloads

755

Readme

PicGo/store

For PicGo projects to write & read data or configuration in disk.

Coverage Status PicGo Convention

Usage

import { DBStore } from '@picgo/store'

const db = new DBStore('path/to/your/xxx.db', 'collectionName')

const main = async () => {
  const result = await db.insert({
    imgUrl: 'xxxx.jpg',
  })
  console.log(result)
  // {
  //   id: 'xxxxx',
  //   imgUrl: 'xxx.jpg',
  //   createdAt: 123123123123,
  //   updatedAt: 123123123123
  // }
}

API Reference

For now, @picgo/store has two export member: DBStore & JSONStore.

DBStore

  • new DBStore(dbPath: string, collectionName: string)
const db = new DBStore('picgo.db', 'uploadImgs')

Get .get(filter?: IFilter)

  • return: Promise<IGetResult<IObject>[]>
  • interface: IGetResult

To get the whole collection value.

async () => {
  const collection = await db.get()
  console.log(collection) // { total: x, data: [{...}, {...}, ...] }
}

To get filtered collection: (just like SQL orderBy, limit & offset)

async () => {
  const collection = await db.get({
    orderBy: 'desc', // ['desc' | 'asc'] -> order with created-time
    limit: 1, // limit >= 1
    offset: 0, // offset >= 0
  })
  console.log(collection) // { total: 1, data: [{...}] }
}

Insert .insert<T>(value: T)

  • return: Promise<IResult<T>>
  • interface: IResult

To insert an item to collection.

async () => {
  const result = await db.insert({
    imgUrl: 'https://xxxx.jpg'
  })
  console.log(result)
  // {
  //   id: string,
  //   imgUrl: string,
  //   createdAt: number,
  //   updatedAt: number 
  // }
}

InsertMany .insertMany<T>(value: T[])

  • return: Promise<IResult<T>[]>
  • interface: IResult

To insert multiple items to collection at once .

async () => {
  const result = await db.insertMany([
    {
      imgUrl: 'https://xxxx.jpg'
    },
    {
      imgUrl: 'https://yyyy.jpg'
    }
  ])
  console.log(result)
  // [{
  //   id: string,
  //   imgUrl: string,
  //   createdAt: number,
  //   updatedAt: number 
  // },{
  //   id: string,
  //   imgUrl: string,
  //   createdAt: number,
  //   updatedAt: number 
  // }]
}

UpdateById .updateById(id: string, value: IObject)

  • return: Promise<boolean>
  • interface: IObject

To update an item by id. It will return false if the id does not exist.

async () => {
  const result = await db.updateById('test-id', {
    test: 123
  })
  console.log(result) // true
}

GetById .getById(id: string)

  • return: Promise<IObject | undefined>
  • interface: IObject

To get an item by id.

async () => {
  const result = await db.getById('xxx')
  console.log(result) // undefined
}

RemoveById .removeById(id: string);

  • return: Promise<void>

To remove an item by id.

async () => {
  const result = await db.removeById('xxx')
  console.log(result) // undefined
}

Overwrite .overwrite<T>(value: T[]) (v2.0.0)

  • return: Promise<IResult<T>[]>
  • interface: IResult

To overwrite whole collection:

async () => {
  const result = await db.overwrite([
    {
      imgUrl: 'https://xxxx.jpg'
    },
    {
      imgUrl: 'https://yyyy.jpg'
    }
  ])
  console.log(result)
  // [{
  //   id: string,
  //   imgUrl: string,
  //   createdAt: number,
  //   updatedAt: number 
  // },{
  //   id: string,
  //   imgUrl: string,
  //   createdAt: number,
  //   updatedAt: number 
  // }]
}

UpdateMany .updateMany(list: IObject[]) (v2.1.0)

  • return: Promise<{ total: number, success: number }>
  • interface: IObject

To update many items by id:

async () => {
  const result = await db.updateMany([
    {
      id: 'xxx', // need to have id
      imgUrl: 'https://xxxx.jpg'
    },
    {
      id: 'yyy',
      imgUrl: 'https://yyyy.jpg'
    },
    {
      imgUrl: 'https://zzzz.jpg'
    }
  ])
  console.log(result)
  // { total: 3, success: 2 }
}

License

MIT

Copyright (c) 2020 Molunerfinn