PicGo/store

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

Usage

1import { DBStore } from '@picgo/store'
2
3const db = new DBStore('path/to/your/xxx.db', 'collectionName')
4
5const main = async () => {
6  const result = await db.insert({
7    imgUrl: 'xxxx.jpg',
8  })
9  console.log(result)
10  // {
11  //   id: 'xxxxx',
12  //   imgUrl: 'xxx.jpg',
13  //   createdAt: 123123123123,
14  //   updatedAt: 123123123123
15  // }
16}

API Reference

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

DBStore

• new DBStore(dbPath: string, collectionName: string)

1const db = new DBStore('picgo.db', 'uploadImgs')

Get .get(filter?: IFilter)

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

To get the whole collection value.

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

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

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

Insert .insert<T>(value: T)

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

To insert an item to collection.

1async () => {
2  const result = await db.insert({
3    imgUrl: 'https://xxxx.jpg'
4  })
5  console.log(result)
6  // {
7  //   id: string,
8  //   imgUrl: string,
9  //   createdAt: number,
10  //   updatedAt: number 
11  // }
12}

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

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

To insert multiple items to collection at once .

1async () => {
2  const result = await db.insertMany([
3    {
4      imgUrl: 'https://xxxx.jpg'
5    },
6    {
7      imgUrl: 'https://yyyy.jpg'
8    }
9  ])
10  console.log(result)
11  // [{
12  //   id: string,
13  //   imgUrl: string,
14  //   createdAt: number,
15  //   updatedAt: number 
16  // },{
17  //   id: string,
18  //   imgUrl: string,
19  //   createdAt: number,
20  //   updatedAt: number 
21  // }]
22}

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.

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

GetById .getById(id: string)

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

To get an item by id.

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

RemoveById .removeById(id: string);

• return: Promise<void>

To remove an item by id.

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

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

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

To overwrite whole collection:

1async () => {
2  const result = await db.overwrite([
3    {
4      imgUrl: 'https://xxxx.jpg'
5    },
6    {
7      imgUrl: 'https://yyyy.jpg'
8    }
9  ])
10  console.log(result)
11  // [{
12  //   id: string,
13  //   imgUrl: string,
14  //   createdAt: number,
15  //   updatedAt: number 
16  // },{
17  //   id: string,
18  //   imgUrl: string,
19  //   createdAt: number,
20  //   updatedAt: number 
21  // }]
22}

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

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

To update many items by id:

1async () => {
2  const result = await db.updateMany([
3    {
4      id: 'xxx', // need to have id
5      imgUrl: 'https://xxxx.jpg'
6    },
7    {
8      id: 'yyy',
9      imgUrl: 'https://yyyy.jpg'
10    },
11    {
12      imgUrl: 'https://zzzz.jpg'
13    }
14  ])
15  console.log(result)
16  // { total: 3, success: 2 }
17}

License

MIT

Copyright (c) 2020 Molunerfinn