api documentation for db-lite (2019.8.20)

this zero-dependency package will provide a persistent, in-browser database, with a working web-demo

table of contents

  1. module db-lite
    1. function db-lite._DbTable (opt)
    2. function db-lite.assertThrow (passed, message)
    3. function db-lite.cliRun (opt)
    4. function db-lite.dbCrudRemoveAll (onError)
    5. function db-lite.dbDrop (onError)
    6. function db-lite.dbExport (onError)
    7. function db-lite.dbImport (text, onError)
    8. function db-lite.dbLoad (onError)
    9. function db-lite.dbReset (dbSeedList, onError)
    10. function db-lite.dbRowGetItem (dbRow, key)
    11. function db-lite.dbRowListGetManyByOperator ( dbRowList, fieldName, operator, bb, not )
    12. function db-lite.dbRowListGetManyByQuery (dbRowList, query, fieldName, not)
    13. function db-lite.dbRowProject (dbRow, fieldList)
    14. function db-lite.dbRowSetId (dbRow, idIndex)
    15. function db-lite.dbSave (onError)
    16. function db-lite.dbSeed (dbSeedList, onError)
    17. function db-lite.dbTableCreateMany (optionList, onError)
    18. function db-lite.dbTableCreateOne (opt, onError)
    19. function db-lite.functionOrNop (fnc)
    20. function db-lite.identity (value)
    21. function db-lite.jsonCopy (obj)
    22. function db-lite.jsonStringifyOrdered (obj, replacer, space)
    23. function db-lite.listShuffle (list)
    24. function db-lite.nop ()
    25. function db-lite.objectAssignDefault (target, source)
    26. function db-lite.objectSetOverride (dict, overrides, depth, env)
    27. function db-lite.onErrorDefault (err)
    28. function db-lite.onErrorWithStack (onError)
    29. function db-lite.onEventDomDb (evt)
    30. function db-lite.onParallel (onError, onEach, onRetry)
    31. function db-lite.replStart ()
    32. function db-lite.setTimeoutOnError (onError, timeout, err, data)
    33. function db-lite.sortCompare (aa, bb, ii, jj)
    34. function db-lite.storageClear (onError)
    35. function db-lite.storageDefer (opt, onError)
    36. function db-lite.storageGetItem (key, onError)
    37. function db-lite.storageInit ()
    38. function db-lite.storageKeys (onError)
    39. function db-lite.storageLength (onError)
    40. function db-lite.storageRemoveItem (key, onError)
    41. function db-lite.storageSetItem (key, value, onError)
    42. number db-lite.timeExit
    43. object db-lite._DbTable.prototype
    44. object db-lite.cliDict
    45. object db-lite.db
    46. object db-lite.dbTableDict
    47. object db-lite.local
    48. object db-lite.storageDeferList
    49. string db-lite.__dirname
    50. string db-lite.storageDir
  2. module db-lite._DbTable
    1. function db-lite._DbTable (opt)
  3. module db-lite._DbTable.prototype
    1. function db-lite._DbTable.prototype._cleanup ()
    2. function db-lite._DbTable.prototype._crudGetManyByQuery ( query, sort, skip, limit, shuffle )
    3. function db-lite._DbTable.prototype._crudGetOneById (idDict)
    4. function db-lite._DbTable.prototype._crudRemoveOneById (idDict, circularSet)
    5. function db-lite._DbTable.prototype._crudSetOneById (dbRow)
    6. function db-lite._DbTable.prototype._crudUpdateOneById (dbRow)
    7. function db-lite._DbTable.prototype.crudCountAll (onError)
    8. function db-lite._DbTable.prototype.crudCountManyByQuery (query, onError)
    9. function db-lite._DbTable.prototype.crudGetManyById (idDictList, onError)
    10. function db-lite._DbTable.prototype.crudGetManyByQuery (opt, onError)
    11. function db-lite._DbTable.prototype.crudGetOneById (idDict, onError)
    12. function db-lite._DbTable.prototype.crudGetOneByQuery (query, onError)
    13. function db-lite._DbTable.prototype.crudGetOneByRandom (onError)
    14. function db-lite._DbTable.prototype.crudRemoveAll (onError)
    15. function db-lite._DbTable.prototype.crudRemoveManyById (idDictList, onError)
    16. function db-lite._DbTable.prototype.crudRemoveManyByQuery (query, onError)
    17. function db-lite._DbTable.prototype.crudRemoveOneById (idDict, onError)
    18. function db-lite._DbTable.prototype.crudSetManyById (dbRowList, onError)
    19. function db-lite._DbTable.prototype.crudSetOneById (dbRow, onError)
    20. function db-lite._DbTable.prototype.crudUpdateManyById (dbRowList, onError)
    21. function db-lite._DbTable.prototype.crudUpdateManyByQuery ( query, dbRow, onError )
    22. function db-lite._DbTable.prototype.crudUpdateOneById (dbRow, onError)
    23. function db-lite._DbTable.prototype.drop (onError)
    24. function db-lite._DbTable.prototype.export (onError)
    25. function db-lite._DbTable.prototype.idIndexCreate (opt, onError)
    26. function db-lite._DbTable.prototype.idIndexRemove (opt, onError)
    27. function db-lite._DbTable.prototype.save (onError)
  4. module db-lite.cliDict
    1. function db-lite.cliDict.dbTableCrudGetManyByQuery ()
    2. function db-lite.cliDict.dbTableCrudRemoveManyByQuery ()
    3. function db-lite.cliDict.dbTableCrudSetManyById ()
    4. function db-lite.cliDict.dbTableHeaderDictGet ()
    5. function db-lite.cliDict.dbTableHeaderDictSet ()
    6. function db-lite.cliDict.dbTableIdIndexCreate ()
    7. function db-lite.cliDict.dbTableIdIndexRemove ()
    8. function db-lite.cliDict.dbTableList ()
    9. function db-lite.cliDict.dbTableRemove ()

module db-lite

function db-lite._DbTable (opt)

function db-lite.assertThrow (passed, message)

function db-lite.cliRun (opt)

function db-lite.dbCrudRemoveAll (onError)

function db-lite.dbDrop (onError)

function db-lite.dbExport (onError)

function db-lite.dbImport (text, onError)

function db-lite.dbLoad (onError)

function db-lite.dbReset (dbSeedList, onError)

function db-lite.dbRowGetItem (dbRow, key)

function db-lite.dbRowListGetManyByOperator ( dbRowList, fieldName, operator, bb, not )

function db-lite.dbRowListGetManyByQuery (dbRowList, query, fieldName, not)

function db-lite.dbRowProject (dbRow, fieldList)

function db-lite.dbRowSetId (dbRow, idIndex)

function db-lite.dbSave (onError)

function db-lite.dbSeed (dbSeedList, onError)

function db-lite.dbTableCreateMany (optionList, onError)

function db-lite.dbTableCreateOne (opt, onError)

function db-lite.functionOrNop (fnc)

function db-lite.identity (value)

function db-lite.jsonCopy (obj)

function db-lite.jsonStringifyOrdered (obj, replacer, space)

function db-lite.listShuffle (list)

function db-lite.nop ()

function db-lite.objectAssignDefault (target, source)

function db-lite.objectSetOverride (dict, overrides, depth, env)

function db-lite.onErrorDefault (err)

function db-lite.onErrorWithStack (onError)

function db-lite.onEventDomDb (evt)

function db-lite.onParallel (onError, onEach, onRetry)

function db-lite.replStart ()

function db-lite.setTimeoutOnError (onError, timeout, err, data)

function db-lite.sortCompare (aa, bb, ii, jj)

function db-lite.storageClear (onError)

function db-lite.storageDefer (opt, onError)

function db-lite.storageGetItem (key, onError)

function db-lite.storageInit ()

function db-lite.storageKeys (onError)

function db-lite.storageLength (onError)

function db-lite.storageRemoveItem (key, onError)

function db-lite.storageSetItem (key, value, onError)

module db-lite._DbTable

function db-lite._DbTable (opt)

module db-lite._DbTable.prototype

function db-lite._DbTable.prototype._cleanup ()

function db-lite._DbTable.prototype._crudGetManyByQuery ( query, sort, skip, limit, shuffle )

function db-lite._DbTable.prototype._crudGetOneById (idDict)

function db-lite._DbTable.prototype._crudRemoveOneById (idDict, circularSet)

function db-lite._DbTable.prototype._crudSetOneById (dbRow)

function db-lite._DbTable.prototype._crudUpdateOneById (dbRow)

function db-lite._DbTable.prototype.crudCountAll (onError)

function db-lite._DbTable.prototype.crudCountManyByQuery (query, onError)

function db-lite._DbTable.prototype.crudGetManyById (idDictList, onError)

function db-lite._DbTable.prototype.crudGetManyByQuery (opt, onError)

function db-lite._DbTable.prototype.crudGetOneById (idDict, onError)

function db-lite._DbTable.prototype.crudGetOneByQuery (query, onError)

function db-lite._DbTable.prototype.crudGetOneByRandom (onError)

function db-lite._DbTable.prototype.crudRemoveAll (onError)

function db-lite._DbTable.prototype.crudRemoveManyById (idDictList, onError)

function db-lite._DbTable.prototype.crudRemoveManyByQuery (query, onError)

function db-lite._DbTable.prototype.crudRemoveOneById (idDict, onError)

function db-lite._DbTable.prototype.crudSetManyById (dbRowList, onError)

function db-lite._DbTable.prototype.crudSetOneById (dbRow, onError)

function db-lite._DbTable.prototype.crudUpdateManyById (dbRowList, onError)

function db-lite._DbTable.prototype.crudUpdateManyByQuery ( query, dbRow, onError )

function db-lite._DbTable.prototype.crudUpdateOneById (dbRow, onError)

function db-lite._DbTable.prototype.drop (onError)

function db-lite._DbTable.prototype.export (onError)

function db-lite._DbTable.prototype.idIndexCreate (opt, onError)

function db-lite._DbTable.prototype.idIndexRemove (opt, onError)

function db-lite._DbTable.prototype.save (onError)

module db-lite.cliDict

function db-lite.cliDict.dbTableCrudGetManyByQuery ()

function db-lite.cliDict.dbTableCrudRemoveManyByQuery ()

function db-lite.cliDict.dbTableCrudSetManyById ()

function db-lite.cliDict.dbTableHeaderDictGet ()

function db-lite.cliDict.dbTableHeaderDictSet ()

function db-lite.cliDict.dbTableIdIndexCreate ()

function db-lite.cliDict.dbTableIdIndexRemove ()

function db-lite.cliDict.dbTableList ()

function db-lite.cliDict.dbTableRemove ()

[ this document was created with utility2 ]