w-orm-lowdb 1.0.0 → 1.0.2

package/docs/WOrmLowdb.mjs.html

@@ -48,7 +48,8 @@
             <pre class="prettyprint source linenums"><code>import events from 'events'
 import { Low } from 'lowdb'
 import { JSONFile } from 'lowdb/node'
-import { Query } from 'mingo'
+import { Query } from 'mingo' //須指定安裝6.5.6, 若6.6.0無法匯入Query
+import { Mutex } from 'async-mutex'
 import get from 'lodash-es/get.js'
 import each from 'lodash-es/each.js'
 import map from 'lodash-es/map.js'
@@ -105,10 +106,13 @@ function WOrmLowdb(opt = {}) {
     //lowdb
     let lowdb = new Low(adapter, {})
 
-    //default
-    if (!haskey(lowdb.data, key)) {
-        lowdb.data[key] = []
-    }
+    //mutex
+    let mutex = new Mutex()
+
+    // //default, 此處偵測會失效, 因操作函數內會通過lowdb.read()初始化, 預設創建空陣列會被取代
+    // if (!haskey(lowdb.data, key)) {
+    //     lowdb.data[key] = []
+    // }
 
     //ee
     let ee = new events.EventEmitter()
@@ -130,6 +134,11 @@ function WOrmLowdb(opt = {}) {
             //read
             await lowdb.read()
 
+            //default, 使用lowdb.read()初始化後須馬上檢測, 若無key則須先創建空陣列
+            if (!haskey(lowdb.data, key)) {
+                lowdb.data[key] = []
+            }
+
             //filter
             if (iseobj(find)) {
 
@@ -166,89 +175,96 @@ function WOrmLowdb(opt = {}) {
      * @returns {Promise} 回傳Promise，resolve回傳插入結果，reject回傳錯誤訊息
      */
     async function insert(data) {
-        let isErr = false
+        return await mutex.runExclusive(async () => {
+            let isErr = false
 
-        //check
-        if (!iseobj(data) &amp;&amp; !isearr(data)) {
-            return Promise.reject(`data is not an effective object or array`)
-        }
+            //check
+            if (!iseobj(data) &amp;&amp; !isearr(data)) {
+                return Promise.reject(`data is not an effective object or array`)
+            }
 
-        //cloneDeep, 與外部數據脫勾
-        data = cloneDeep(data)
+            //cloneDeep, 與外部數據脫勾
+            data = cloneDeep(data)
 
-        //res
-        let res = null
-        try {
+            //res
+            let res = null
+            try {
 
-            //check
-            if (!isarr(data)) {
-                data = [data]
-            }
+                //check
+                if (!isarr(data)) {
+                    data = [data]
+                }
+
+                //check id
+                data = map(data, function(v) {
+                    if (!isestr(v.id)) {
+                        v.id = genID()
+                    }
+                    return v
+                })
+
+                //read
+                await lowdb.read()
 
-            //check id
-            data = map(data, function(v) {
-                if (!isestr(v.id)) {
-                    v.id = genID()
+                //default, 使用lowdb.read()初始化後須馬上檢測, 若無key則須先創建空陣列
+                if (!haskey(lowdb.data, key)) {
+                    lowdb.data[key] = []
                 }
-                return v
-            })
 
-            //read
-            await lowdb.read()
+                //kp
+                let kp = {}
+                each(lowdb.data[key], (v, k) => {
+                    kp[v.id] = { k, v }
+                })
 
-            //kp
-            let kp = {}
-            each(lowdb.data[key], (v, k) => {
-                kp[v.id] = { k, v }
-            })
+                //each
+                let nAll = size(data)
+                let nPush = 0
+                let b = false
+                each(data, (v) => {
 
-            //each
-            let nAll = size(data)
-            let nPush = 0
-            let b = false
-            each(data, (v) => {
+                    //check
+                    if (!haskey(kp, v.id)) {
+                        //未存在v.id
 
-                //check
-                if (!haskey(kp, v.id)) {
-                    //未存在v.id
+                        //push
+                        lowdb.data[key].push(v)
 
-                    //push
-                    lowdb.data[key].push(v)
+                        nPush++
+                        b = true
+                    }
+                    else {
+                        //已存在v.id則不push
+                    }
 
-                    nPush++
-                    b = true
+                })
+
+                //write
+                if (b) {
+                    await lowdb.write()
                 }
-                else {
-                    //已存在v.id則不push
+
+                //res
+                res = {
+                    n: nAll,
+                    nInserted: nPush,
+                    ok: 1,
                 }
 
-            })
+                //emit
+                ee.emit('change', 'insert', data, res)
 
-            //write
-            if (b) {
-                await lowdb.write()
             }
-
-            //res
-            res = {
-                n: nAll,
-                nInserted: nPush,
-                ok: 1,
+            catch (err) {
+                isErr = true
+                res = err
             }
 
-            //emit
-            ee.emit('change', 'insert', data, res)
-
-        }
-        catch (err) {
-            isErr = true
-            res = err
-        }
-
-        if (isErr) {
-            return Promise.reject(res)
-        }
-        return res
+            if (isErr) {
+                return Promise.reject(res)
+            }
+            return res
+        })
     }
 
     /**
@@ -261,117 +277,121 @@ function WOrmLowdb(opt = {}) {
      * @returns {Promise} 回傳Promise，resolve回傳儲存結果，reject回傳錯誤訊息
      */
     async function save(data, option = {}) {
-        let isErr = false
-
-        //check
-        if (!iseobj(data) &amp;&amp; !isearr(data)) {
-            return Promise.reject(`data is not an effective object or array`)
-        }
+        return await mutex.runExclusive(async () => {
+            let isErr = false
 
-        //cloneDeep, 與外部數據脫勾
-        data = cloneDeep(data)
+            //check
+            if (!iseobj(data) &amp;&amp; !isearr(data)) {
+                return Promise.reject(`data is not an effective object or array`)
+            }
 
-        //autoInsert
-        let autoInsert = get(option, 'autoInsert', true)
+            //cloneDeep, 與外部數據脫勾
+            data = cloneDeep(data)
 
-        //res
-        let res = null
-        try {
+            //autoInsert
+            let autoInsert = get(option, 'autoInsert', true)
 
-            //check
-            if (!isarr(data)) {
-                data = [data]
-            }
+            //res
+            let res = null
+            try {
 
-            //check id
-            data = map(data, function(v) {
-                if (!isestr(v.id)) {
-                    v.id = genID()
+                //check
+                if (!isarr(data)) {
+                    data = [data]
                 }
-                return v
-            })
 
-            //read
-            await lowdb.read()
+                //check id
+                data = map(data, function(v) {
+                    if (!isestr(v.id)) {
+                        v.id = genID()
+                    }
+                    return v
+                })
+
+                //read
+                await lowdb.read()
 
-            //kp
-            let kp = {}
-            each(lowdb.data[key], (v, k) => {
-                kp[v.id] = { k, v }
-            })
+                //default, 使用lowdb.read()初始化後須馬上檢測, 若無key則須先創建空陣列
+                if (!haskey(lowdb.data, key)) {
+                    lowdb.data[key] = []
+                }
 
-            //pmSeries
-            let b = false
-            res = await pmSeries(data, async(v) => {
+                //kp
+                let kp = {}
+                each(lowdb.data[key], (v, k) => {
+                    kp[v.id] = { k, v }
+                })
 
-                //rest
-                let rest = null
+                //pmSeries
+                let b = false
+                res = await pmSeries(data, async(v) => {
 
-                //id
-                let id = get(v, 'id', '')
+                    //rest
+                    let rest = null
 
-                //查找資料表內v.id為_v
-                let r = get(kp, id, null)
+                    //查找資料表內v.id
+                    let r = get(kp, v.id, null)
 
-                //check
-                if (iseobj(r)) {
-                    //已存在v.id
-                    if (isEqual(v, r.v)) {
-                        //內容相同不更新
-                    }
-                    else {
-                        //內容不同須更新
+                    //check
+                    if (iseobj(r)) {
+                        //已存在v.id
+                        if (isEqual(v, r.v)) {
+                            //內容相同不更新
+                        }
+                        else {
+                            //內容不同須更新
 
-                        //merge
-                        lowdb.data[key][r.k] = merge(lowdb.data[key][r.k], v)
+                            //merge
+                            lowdb.data[key][r.k] = merge(lowdb.data[key][r.k], v)
 
-                        rest = { update: true }
-                        b = true
+                            rest = { update: true }
+                            b = true
+                        }
                     }
-                }
 
-                //rest
-                if (iseobj(rest)) {
-                    rest = {
-                        n: 1,
-                        nModified: 1,
-                        ok: 1,
+                    //rest
+                    if (iseobj(rest)) {
+                        rest = {
+                            n: 1,
+                            nModified: 1,
+                            ok: 1,
+                        }
                     }
-                }
-                else {
-                    rest = {
-                        n: 0,
-                        nModified: 0,
-                        ok: 1,
+                    else {
+                        rest = {
+                            n: 0,
+                            nModified: 0,
+                            ok: 1,
+                        }
                     }
-                }
 
-                //autoInsert
-                if (autoInsert &amp;&amp; rest.n === 0) {
-                    rest = await insert(v)
-                }
+                    //autoInsert
+                    if (autoInsert &amp;&amp; rest.n === 0) {
+                        rest = await insert(v)
+                    }
 
-                return rest
-            })
+                    return rest
+                })
 
-            //write
-            if (b) {
-                await lowdb.write()
-            }
+                //write
+                if (b) {
+                    await lowdb.write()
+                }
 
-            //emit
-            ee.emit('change', 'save', data, res)
+                //emit
+                ee.emit('change', 'save', data, res)
 
-        }
-        catch (err) {
-            isErr = true
-            res = err
-        }
+            }
+            catch (err) {
+                isErr = true
+                res = err
+            }
 
-        if (isErr) {
-            return Promise.reject(res)
-        }
-        return res
+            if (isErr) {
+                return Promise.reject(res)
+            }
+            return res
+        })
     }
 
     /**
@@ -382,119 +402,126 @@ function WOrmLowdb(opt = {}) {
      * @returns {Promise} 回傳Promise，resolve回傳刪除結果，reject回傳錯誤訊息
      */
     async function del(data) {
-        let isErr = false
-
-        //check
-        if (!iseobj(data) &amp;&amp; !isearr(data)) {
-            return Promise.reject(`data is not an effective object or array`)
-        }
-
-        //cloneDeep, 與外部數據脫勾
-        data = cloneDeep(data)
-
-        //res
-        let res = null
-        try {
+        return await mutex.runExclusive(async () => {
+            let isErr = false
 
             //check
-            if (!isarr(data)) {
-                data = [data]
+            if (!iseobj(data) &amp;&amp; !isearr(data)) {
+                return Promise.reject(`data is not an effective object or array`)
             }
 
-            //read
-            await lowdb.read()
+            //cloneDeep, 與外部數據脫勾
+            data = cloneDeep(data)
+
+            //res
+            let res = null
+            try {
 
-            //kp
-            let kp = {}
-            each(lowdb.data[key], (v, k) => {
-                kp[v.id] = { k, v }
-            })
+                //check
+                if (!isarr(data)) {
+                    data = [data]
+                }
 
-            //pmSeries
-            let ks = []
-            let b = false
-            res = await pmSeries(data, async(v) => {
+                //read
+                await lowdb.read()
 
-                //rest
-                let rest = null
+                //default, 使用lowdb.read()初始化後須馬上檢測, 若無key則須先創建空陣列
+                if (!haskey(lowdb.data, key)) {
+                    lowdb.data[key] = []
+                }
 
-                //id
-                let id = get(v, 'id', '')
+                //kp
+                let kp = {}
+                each(lowdb.data[key], (v, k) => {
+                    kp[v.id] = { k, v }
+                })
 
-                //check
-                if (isestr(id)) {
+                //pmSeries
+                let ks = []
+                let b = false
+                res = await pmSeries(data, async(v) => {
 
-                    //查找資料表內v.id為_v
-                    let r = get(kp, id, null)
+                    //rest
+                    let rest = null
+
+                    //id
+                    let id = get(v, 'id', '')
 
                     //check
-                    if (iseobj(r)) {
-                        //已存在v.id則須刪除
+                    if (isestr(id)) {
 
-                        //push
-                        ks.push(r.k)
+                        //查找資料表內v.id為_v
+                        let r = get(kp, id, null)
 
-                        b = true
+                        //check
+                        if (iseobj(r)) {
+                            //已存在v.id則須刪除
+
+                            //push
+                            ks.push(r.k)
+
+                            b = true
+
+                            //rest
+                            rest = {
+                                n: 1,
+                                nDeleted: 1,
+                                ok: 1,
+                            }
+
+                        }
+                        else {
+                            //不存在v.id則不刪除
+
+                            //rest
+                            rest = {
+                                n: 1,
+                                nDeleted: 0,
+                                ok: 1,
+                            }
 
-                        //rest
-                        rest = {
-                            n: 1,
-                            nDeleted: 1,
-                            ok: 1,
                         }
 
                     }
                     else {
-                        //不存在v.id則不刪除
+                        //未給v.id則不刪除
 
                         //rest
                         rest = {
                             n: 1,
                             nDeleted: 0,
-                            ok: 1,
+                            ok: 0, //未給v.id視為有問題數據, 故ok給0
                         }
 
                     }
 
-                }
-                else {
-                    //未給v.id則不刪除
+                    return rest
+                })
 
-                    //rest
-                    rest = {
-                        n: 1,
-                        nDeleted: 0,
-                        ok: 0, //未給v.id視為有問題數據, 故ok給0
-                    }
+                //update
+                if (b) {
+                    lowdb.data[key] = arrPullAt(lowdb.data[key], ks)
+                }
 
+                //write
+                if (b) {
+                    await lowdb.write()
                 }
 
-                return rest
-            })
+                //emit
+                ee.emit('change', 'del', data, res)
 
-            //update
-            if (b) {
-                lowdb.data[key] = arrPullAt(lowdb.data[key], ks)
             }
-
-            //write
-            if (b) {
-                await lowdb.write()
+            catch (err) {
+                isErr = true
+                res = err
             }
 
-            //emit
-            ee.emit('change', 'del', data, res)
-
-        }
-        catch (err) {
-            isErr = true
-            res = err
-        }
-
-        if (isErr) {
-            return Promise.reject(res)
-        }
-        return res
+            if (isErr) {
+                return Promise.reject(res)
+            }
+            return res
+        })
     }
 
     /**
@@ -505,104 +532,111 @@ function WOrmLowdb(opt = {}) {
      * @returns {Promise} 回傳Promise，resolve回傳刪除結果，reject回傳錯誤訊息
      */
     async function delAll(find = {}) {
-        let isErr = false
+        return await mutex.runExclusive(async () => {
+            let isErr = false
 
-        //res
-        let res = null
-        try {
+            //res
+            let res = null
+            try {
 
-            //read
-            await lowdb.read()
+                //read
+                await lowdb.read()
 
-            //filter
-            let nAll = size(lowdb.data[key])
-            let nDel = 0
-            let b = false
-            if (iseobj(find)) {
+                //default, 使用lowdb.read()初始化後須馬上檢測, 若無key則須先創建空陣列
+                if (!haskey(lowdb.data, key)) {
+                    lowdb.data[key] = []
+                }
 
-                //q
-                let q = new Query(find)
-                // console.log('q', q)
+                //filter
+                let nAll = size(lowdb.data[key])
+                let nDel = 0
+                let b = false
+                if (iseobj(find)) {
 
-                //find
-                let _res = q.find(lowdb.data[key]).all()
-                // console.log('_res', _res)
+                    //q
+                    let q = new Query(find)
+                    // console.log('q', q)
 
-                //nDel
-                nDel = size(_res)
-                // console.log('nDel', nDel)
+                    //find
+                    let _res = q.find(lowdb.data[key]).all()
+                    // console.log('_res', _res)
+
+                    //nDel
+                    nDel = size(_res)
+                    // console.log('nDel', nDel)
+
+                    if (nDel === 0) {
+                        //未有find結果等於不刪除
+                    }
+                    else if (nAll === nDel) {
+                        //全在find結果內等於全部刪除
 
-                if (nDel === 0) {
-                    //未有find結果等於不刪除
+                        //empty
+                        lowdb.data[key] = []
+
+                        b = true
+                    }
+                    else {
+                        //部份在find結果內
+
+                        //_kp
+                        let _kp = {}
+                        each(_res, (v, k) => {
+                            _kp[v.id] = { k, v }
+                        })
+
+                        //arr
+                        let arr = []
+                        each(lowdb.data[key], (v, k) => {
+                            if (!haskey(_kp, v.id)) {
+                                //未在find結果內代表須保留
+                                arr.push(v)
+                            }
+                        })
+
+                        //update
+                        lowdb.data[key] = arr
+
+                        b = true
+                    }
                 }
-                else if (nAll === nDel) {
-                    //全在find結果內等於全部刪除
+                else {
+
+                    //nDel
+                    nDel = nAll
 
                     //empty
                     lowdb.data[key] = []
 
                     b = true
                 }
-                else {
-                    //部份在find結果內
-
-                    //_kp
-                    let _kp = {}
-                    each(_res, (v, k) => {
-                        _kp[v.id] = { k, v }
-                    })
-
-                    //arr
-                    let arr = []
-                    each(lowdb.data[key], (v, k) => {
-                        if (!haskey(_kp, v.id)) {
-                            //未在find結果內代表須保留
-                            arr.push(v)
-                        }
-                    })
-
-                    //update
-                    lowdb.data[key] = arr
 
-                    b = true
+                //write
+                if (b) {
+                    await lowdb.write()
                 }
-            }
-            else {
 
-                //nDel
-                nDel = nAll
+                //res
+                res = {
+                    n: nAll,
+                    nDeleted: nDel,
+                    ok: 1,
+                }
 
-                //empty
-                lowdb.data[key] = []
+                //emit
+                ee.emit('change', 'delAll', null, res)
 
-                b = true
             }
-
-            //write
-            if (b) {
-                await lowdb.write()
+            catch (err) {
+                isErr = true
+                res = err
             }
 
-            //res
-            res = {
-                n: nAll,
-                nDeleted: nDel,
-                ok: 1,
+            if (isErr) {
+                return Promise.reject(res)
             }
-
-            //emit
-            ee.emit('change', 'delAll', null, res)
-
-        }
-        catch (err) {
-            isErr = true
-            res = err
-        }
-
-        if (isErr) {
-            return Promise.reject(res)
-        }
-        return res
+            return res
+        })
     }
 
     //bind
@@ -631,7 +665,7 @@ export default WOrmLowdb
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Tue Mar 18 2025 21:23:44 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Fri May 09 2025 11:30:47 GMT+0800 (台北標準時間) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>