From 08d7de10f4a163eb8db43be4ce92dc8bb3fa4efd Mon Sep 17 00:00:00 2001 From: Nick Van Doorn Date: Sun, 20 Jan 2019 13:50:38 -0800 Subject: Update docs for release 1.3.0 --- docs/assets/js/search.js | 2 +- docs/classes/_database_.database.html | 173 ++++++++++++++-- docs/classes/_error_model_.naiveerror.html | 7 +- docs/enums/_error_model_.naiveerrorcode.html | 7 +- docs/globals.html | 4 + docs/index.html | 3 + .../_change_handlers_model_.changehandlers.html | 220 +++++++++++++++++++++ docs/interfaces/_context_model_.context.html | 27 ++- .../_database_model_.databaseinterface.html | 80 +++++++- docs/modules/_change_handlers_model_.html | 188 ++++++++++++++++++ docs/modules/_context_model_.html | 3 + docs/modules/_database_.html | 56 +++++- docs/modules/_database_model_.html | 3 + docs/modules/_database_test_.html | 7 +- docs/modules/_error_model_.html | 7 +- docs/modules/_util_.html | 37 +++- 16 files changed, 785 insertions(+), 39 deletions(-) create mode 100644 docs/interfaces/_change_handlers_model_.changehandlers.html create mode 100644 docs/modules/_change_handlers_model_.html diff --git a/docs/assets/js/search.js b/docs/assets/js/search.js index f10b402..04f7e60 100644 --- a/docs/assets/js/search.js +++ b/docs/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"1":"External module","4":"Enumeration","16":"Enumeration member","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","2097152":"Object literal"},"rows":[{"id":0,"kind":1,"name":"\"context.model\"","url":"modules/_context_model_.html","classes":"tsd-kind-external-module"},{"id":1,"kind":256,"name":"Context","url":"interfaces/_context_model_.context.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"context.model\""},{"id":2,"kind":1024,"name":"logger","url":"interfaces/_context_model_.context.html#logger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"context.model\".Context"},{"id":3,"kind":65536,"name":"__type","url":"interfaces/_context_model_.context.html#logger.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"context.model\".Context.logger"},{"id":4,"kind":1024,"name":"cachePath","url":"interfaces/_context_model_.context.html#cachepath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"context.model\".Context"},{"id":5,"kind":1024,"name":"maxDbSizeMB","url":"interfaces/_context_model_.context.html#maxdbsizemb","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"context.model\".Context"},{"id":6,"kind":1,"name":"\"database.model\"","url":"modules/_database_model_.html","classes":"tsd-kind-external-module"},{"id":7,"kind":256,"name":"DatabaseInterface","url":"interfaces/_database_model_.databaseinterface.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"database.model\""},{"id":8,"kind":2048,"name":"init","url":"interfaces/_database_model_.databaseinterface.html#init","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":9,"kind":2048,"name":"read","url":"interfaces/_database_model_.databaseinterface.html#read","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":10,"kind":2048,"name":"write","url":"interfaces/_database_model_.databaseinterface.html#write","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":11,"kind":2048,"name":"remove","url":"interfaces/_database_model_.databaseinterface.html#remove","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":12,"kind":2048,"name":"flush","url":"interfaces/_database_model_.databaseinterface.html#flush","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":13,"kind":2048,"name":"toString","url":"interfaces/_database_model_.databaseinterface.html#tostring","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":14,"kind":1,"name":"\"error.model\"","url":"modules/_error_model_.html","classes":"tsd-kind-external-module"},{"id":15,"kind":4,"name":"NaiveErrorCode","url":"enums/_error_model_.naiveerrorcode.html","classes":"tsd-kind-enum tsd-parent-kind-external-module","parent":"\"error.model\""},{"id":16,"kind":16,"name":"UNCAUGHT","url":"enums/_error_model_.naiveerrorcode.html#uncaught","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"\"error.model\".NaiveErrorCode"},{"id":17,"kind":16,"name":"OUT_OF_SPACE","url":"enums/_error_model_.naiveerrorcode.html#out_of_space","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"\"error.model\".NaiveErrorCode"},{"id":18,"kind":128,"name":"NaiveError","url":"classes/_error_model_.naiveerror.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"error.model\""},{"id":19,"kind":512,"name":"constructor","url":"classes/_error_model_.naiveerror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"error.model\".NaiveError"},{"id":20,"kind":1024,"name":"code","url":"classes/_error_model_.naiveerror.html#code","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"error.model\".NaiveError"},{"id":21,"kind":1024,"name":"name","url":"classes/_error_model_.naiveerror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"\"error.model\".NaiveError"},{"id":22,"kind":1024,"name":"message","url":"classes/_error_model_.naiveerror.html#message","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"\"error.model\".NaiveError"},{"id":23,"kind":1024,"name":"stack","url":"classes/_error_model_.naiveerror.html#stack","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"\"error.model\".NaiveError"},{"id":24,"kind":1024,"name":"Error","url":"classes/_error_model_.naiveerror.html#error","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"\"error.model\".NaiveError"},{"id":25,"kind":32,"name":"e","url":"modules/_error_model_.html#e","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"error.model\""},{"id":26,"kind":64,"name":"lookupMsg","url":"modules/_error_model_.html#lookupmsg","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"error.model\""},{"id":27,"kind":1,"name":"\"util\"","url":"modules/_util_.html","classes":"tsd-kind-external-module"},{"id":28,"kind":64,"name":"last","url":"modules/_util_.html#last","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter","parent":"\"util\""},{"id":29,"kind":1,"name":"\"database\"","url":"modules/_database_.html","classes":"tsd-kind-external-module"},{"id":30,"kind":128,"name":"Database","url":"classes/_database_.database.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"database\""},{"id":31,"kind":1024,"name":"buff","url":"classes/_database_.database.html#buff","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":32,"kind":512,"name":"constructor","url":"classes/_database_.database.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"database\".Database"},{"id":33,"kind":1024,"name":"ctx","url":"classes/_database_.database.html#ctx","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":34,"kind":2048,"name":"init","url":"classes/_database_.database.html#init","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":35,"kind":2048,"name":"read","url":"classes/_database_.database.html#read","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":36,"kind":2048,"name":"write","url":"classes/_database_.database.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":37,"kind":2048,"name":"remove","url":"classes/_database_.database.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":38,"kind":2048,"name":"flush","url":"classes/_database_.database.html#flush","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":39,"kind":2048,"name":"toString","url":"classes/_database_.database.html#tostring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":40,"kind":2048,"name":"resolve","url":"classes/_database_.database.html#resolve","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":41,"kind":2048,"name":"serialize","url":"classes/_database_.database.html#serialize","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":42,"kind":2048,"name":"hasSpace","url":"classes/_database_.database.html#hasspace","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":43,"kind":64,"name":"splitPath","url":"modules/_database_.html#splitpath","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":44,"kind":64,"name":"isRootNode","url":"modules/_database_.html#isrootnode","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":45,"kind":32,"name":"write","url":"modules/_database_.html#write","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":46,"kind":32,"name":"read","url":"modules/_database_.html#read","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":47,"kind":2097152,"name":"DEFAULT_CTX","url":"modules/_database_.html#default_ctx","classes":"tsd-kind-object-literal tsd-parent-kind-external-module","parent":"\"database\""},{"id":48,"kind":32,"name":"logger","url":"modules/_database_.html#default_ctx.logger","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"database\".DEFAULT_CTX"},{"id":49,"kind":32,"name":"cachePath","url":"modules/_database_.html#default_ctx.cachepath","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"database\".DEFAULT_CTX"},{"id":50,"kind":32,"name":"maxDbSizeMB","url":"modules/_database_.html#default_ctx.maxdbsizemb","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"database\".DEFAULT_CTX"},{"id":51,"kind":1,"name":"\"database.test\"","url":"modules/_database_test_.html","classes":"tsd-kind-external-module"},{"id":52,"kind":64,"name":"generateString","url":"modules/_database_test_.html#generatestring","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database.test\""},{"id":53,"kind":32,"name":"maxDbSizeMB","url":"modules/_database_test_.html#maxdbsizemb","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database.test\""}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"1":"External module","4":"Enumeration","16":"Enumeration member","32":"Variable","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","2097152":"Object literal"},"rows":[{"id":0,"kind":1,"name":"\"change-handlers.model\"","url":"modules/_change_handlers_model_.html","classes":"tsd-kind-external-module"},{"id":1,"kind":256,"name":"ChangeHandlers","url":"interfaces/_change_handlers_model_.changehandlers.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"change-handlers.model\""},{"id":2,"kind":1,"name":"\"context.model\"","url":"modules/_context_model_.html","classes":"tsd-kind-external-module"},{"id":3,"kind":256,"name":"Context","url":"interfaces/_context_model_.context.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"context.model\""},{"id":4,"kind":1024,"name":"logger","url":"interfaces/_context_model_.context.html#logger","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"context.model\".Context"},{"id":5,"kind":65536,"name":"__type","url":"interfaces/_context_model_.context.html#logger.__type","classes":"tsd-kind-type-literal tsd-parent-kind-property tsd-is-not-exported","parent":"\"context.model\".Context.logger"},{"id":6,"kind":1024,"name":"cachePath","url":"interfaces/_context_model_.context.html#cachepath","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"context.model\".Context"},{"id":7,"kind":1024,"name":"maxDbSizeMB","url":"interfaces/_context_model_.context.html#maxdbsizemb","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"\"context.model\".Context"},{"id":8,"kind":1,"name":"\"database.model\"","url":"modules/_database_model_.html","classes":"tsd-kind-external-module"},{"id":9,"kind":256,"name":"DatabaseInterface","url":"interfaces/_database_model_.databaseinterface.html","classes":"tsd-kind-interface tsd-parent-kind-external-module","parent":"\"database.model\""},{"id":10,"kind":2048,"name":"init","url":"interfaces/_database_model_.databaseinterface.html#init","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":11,"kind":2048,"name":"read","url":"interfaces/_database_model_.databaseinterface.html#read","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":12,"kind":2048,"name":"subscribe","url":"interfaces/_database_model_.databaseinterface.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":13,"kind":2048,"name":"write","url":"interfaces/_database_model_.databaseinterface.html#write","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":14,"kind":2048,"name":"remove","url":"interfaces/_database_model_.databaseinterface.html#remove","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":15,"kind":2048,"name":"flush","url":"interfaces/_database_model_.databaseinterface.html#flush","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":16,"kind":2048,"name":"toString","url":"interfaces/_database_model_.databaseinterface.html#tostring","classes":"tsd-kind-method tsd-parent-kind-interface","parent":"\"database.model\".DatabaseInterface"},{"id":17,"kind":1,"name":"\"error.model\"","url":"modules/_error_model_.html","classes":"tsd-kind-external-module"},{"id":18,"kind":4,"name":"NaiveErrorCode","url":"enums/_error_model_.naiveerrorcode.html","classes":"tsd-kind-enum tsd-parent-kind-external-module","parent":"\"error.model\""},{"id":19,"kind":16,"name":"UNCAUGHT","url":"enums/_error_model_.naiveerrorcode.html#uncaught","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"\"error.model\".NaiveErrorCode"},{"id":20,"kind":16,"name":"OUT_OF_SPACE","url":"enums/_error_model_.naiveerrorcode.html#out_of_space","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"\"error.model\".NaiveErrorCode"},{"id":21,"kind":128,"name":"NaiveError","url":"classes/_error_model_.naiveerror.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"error.model\""},{"id":22,"kind":512,"name":"constructor","url":"classes/_error_model_.naiveerror.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"error.model\".NaiveError"},{"id":23,"kind":1024,"name":"code","url":"classes/_error_model_.naiveerror.html#code","classes":"tsd-kind-property tsd-parent-kind-class","parent":"\"error.model\".NaiveError"},{"id":24,"kind":1024,"name":"name","url":"classes/_error_model_.naiveerror.html#name","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"\"error.model\".NaiveError"},{"id":25,"kind":1024,"name":"message","url":"classes/_error_model_.naiveerror.html#message","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-inherited","parent":"\"error.model\".NaiveError"},{"id":26,"kind":1024,"name":"stack","url":"classes/_error_model_.naiveerror.html#stack","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited","parent":"\"error.model\".NaiveError"},{"id":27,"kind":1024,"name":"Error","url":"classes/_error_model_.naiveerror.html#error","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-static","parent":"\"error.model\".NaiveError"},{"id":28,"kind":32,"name":"e","url":"modules/_error_model_.html#e","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"error.model\""},{"id":29,"kind":64,"name":"lookupMsg","url":"modules/_error_model_.html#lookupmsg","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"error.model\""},{"id":30,"kind":1,"name":"\"util\"","url":"modules/_util_.html","classes":"tsd-kind-external-module"},{"id":31,"kind":64,"name":"last","url":"modules/_util_.html#last","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter","parent":"\"util\""},{"id":32,"kind":64,"name":"getKey","url":"modules/_util_.html#getkey","classes":"tsd-kind-function tsd-parent-kind-external-module","parent":"\"util\""},{"id":33,"kind":1,"name":"\"database\"","url":"modules/_database_.html","classes":"tsd-kind-external-module"},{"id":34,"kind":128,"name":"Database","url":"classes/_database_.database.html","classes":"tsd-kind-class tsd-parent-kind-external-module","parent":"\"database\""},{"id":35,"kind":1024,"name":"buff","url":"classes/_database_.database.html#buff","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":36,"kind":1024,"name":"changeHandlers","url":"classes/_database_.database.html#changehandlers","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":37,"kind":512,"name":"constructor","url":"classes/_database_.database.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"\"database\".Database"},{"id":38,"kind":1024,"name":"ctx","url":"classes/_database_.database.html#ctx","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":39,"kind":2048,"name":"init","url":"classes/_database_.database.html#init","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":40,"kind":2048,"name":"read","url":"classes/_database_.database.html#read","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":41,"kind":2048,"name":"write","url":"classes/_database_.database.html#write","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":42,"kind":2048,"name":"runChangeHandlers","url":"classes/_database_.database.html#runchangehandlers","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":43,"kind":2048,"name":"subscribe","url":"classes/_database_.database.html#subscribe","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":44,"kind":2048,"name":"unsubscribe","url":"classes/_database_.database.html#unsubscribe","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":45,"kind":2048,"name":"remove","url":"classes/_database_.database.html#remove","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":46,"kind":2048,"name":"flush","url":"classes/_database_.database.html#flush","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":47,"kind":2048,"name":"toString","url":"classes/_database_.database.html#tostring","classes":"tsd-kind-method tsd-parent-kind-class","parent":"\"database\".Database"},{"id":48,"kind":2048,"name":"resolve","url":"classes/_database_.database.html#resolve","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":49,"kind":2048,"name":"serialize","url":"classes/_database_.database.html#serialize","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":50,"kind":2048,"name":"hasSpace","url":"classes/_database_.database.html#hasspace","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"\"database\".Database"},{"id":51,"kind":64,"name":"splitPath","url":"modules/_database_.html#splitpath","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":52,"kind":64,"name":"isRootNode","url":"modules/_database_.html#isrootnode","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":53,"kind":64,"name":"isChildOrMatch","url":"modules/_database_.html#ischildormatch","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":54,"kind":32,"name":"write","url":"modules/_database_.html#write","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":55,"kind":32,"name":"read","url":"modules/_database_.html#read","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database\""},{"id":56,"kind":2097152,"name":"DEFAULT_CTX","url":"modules/_database_.html#default_ctx","classes":"tsd-kind-object-literal tsd-parent-kind-external-module","parent":"\"database\""},{"id":57,"kind":32,"name":"logger","url":"modules/_database_.html#default_ctx.logger","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"database\".DEFAULT_CTX"},{"id":58,"kind":32,"name":"cachePath","url":"modules/_database_.html#default_ctx.cachepath","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"database\".DEFAULT_CTX"},{"id":59,"kind":32,"name":"maxDbSizeMB","url":"modules/_database_.html#default_ctx.maxdbsizemb","classes":"tsd-kind-variable tsd-parent-kind-object-literal","parent":"\"database\".DEFAULT_CTX"},{"id":60,"kind":1,"name":"\"database.test\"","url":"modules/_database_test_.html","classes":"tsd-kind-external-module"},{"id":61,"kind":64,"name":"generateString","url":"modules/_database_test_.html#generatestring","classes":"tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database.test\""},{"id":62,"kind":32,"name":"maxDbSizeMB","url":"modules/_database_test_.html#maxdbsizemb","classes":"tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported","parent":"\"database.test\""}]}; \ No newline at end of file diff --git a/docs/classes/_database_.database.html b/docs/classes/_database_.database.html index f0acbcf..2a3a45f 100644 --- a/docs/classes/_database_.database.html +++ b/docs/classes/_database_.database.html @@ -109,6 +109,7 @@

Properties

@@ -121,8 +122,11 @@
  • read
  • remove
  • resolve
    • +
  • runChangeHandlers
  • serialize
    • +
  • subscribe
  • toString
    • +
  • unsubscribe
  • write
    • @@ -141,7 +145,7 @@

  • Parameters

    @@ -163,9 +167,31 @@
    buff: any
    +
    +
    +

    In memory buffer to read/write data

    +
    +
    + +
    + +

    Private changeHandlers

    +
    changeHandlers: ChangeHandlers
    + +
    +
    +

    An array of callback functions that are alerted + when the database changes (mostly want to use this + for some type of pubsub functionality on-top)

    +
    +
    @@ -173,7 +199,7 @@
    ctx: Context
    @@ -191,7 +217,7 @@

    Returns Promise<void>

    @@ -208,7 +234,7 @@

  • Returns boolean

    @@ -226,7 +252,7 @@

    Returns Promise<void>

    @@ -244,7 +270,7 @@

    Parameters

    @@ -268,7 +294,7 @@

    Parameters

    @@ -291,7 +317,7 @@
  • @@ -322,6 +348,32 @@
    • +
    + +

    Private runChangeHandlers

    + + +

    Private serialize

    @@ -332,7 +384,7 @@
  • @@ -348,6 +400,62 @@
    • +
    + +

    subscribe

    + + +

    toString

    @@ -359,13 +467,36 @@

    Returns string

    +
    + +

    Private unsubscribe

    + + +

    write

    @@ -376,7 +507,7 @@

  • Parameters

    @@ -400,6 +531,9 @@
  • Globals
    • +
  • + "change-handlers.model" +
  • "context.model"
    • @@ -433,6 +567,9 @@
  • buff
    • +
  • + changeHandlers +
  • ctx
    • @@ -454,12 +591,21 @@
  • resolve
    • +
  • + runChangeHandlers +
  • serialize
    • +
  • + subscribe +
  • toString
    • +
  • + unsubscribe +
  • write
    • @@ -473,6 +619,9 @@
  • write
    • +
  • + isChildOrMatch +
  • isRootNode
    • diff --git a/docs/classes/_error_model_.naiveerror.html b/docs/classes/_error_model_.naiveerror.html index feca681..8cf95cf 100644 --- a/docs/classes/_error_model_.naiveerror.html +++ b/docs/classes/_error_model_.naiveerror.html @@ -117,7 +117,7 @@

  • Parameters

    @@ -139,7 +139,7 @@
    code: NaiveErrorCode
    • @@ -195,6 +195,9 @@
  • Globals
    • +
  • + "change-handlers.model" +
  • "context.model"
    • diff --git a/docs/enums/_error_model_.naiveerrorcode.html b/docs/enums/_error_model_.naiveerrorcode.html index fb1c051..f4f143a 100644 --- a/docs/enums/_error_model_.naiveerrorcode.html +++ b/docs/enums/_error_model_.naiveerrorcode.html @@ -91,7 +91,7 @@
    OUT_OF_SPACE:
    @@ -101,7 +101,7 @@
    UNCAUGHT: = 0
    @@ -113,6 +113,9 @@
  • Globals
    • +
  • + "change-handlers.model" +
  • "context.model"
    • diff --git a/docs/globals.html b/docs/globals.html index 3feb345..7c43aee 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -70,6 +70,7 @@

    External modules

    @@ -110,9 +115,17 @@
    logger: function
    +
    +
    +

    Method used to log.

    +
    +

    console.log is usually supplied + but it may be handy to pipe it elsewhere + later

    +

    Type declaration

    @@ -153,6 +171,9 @@
  • Globals
    • +
  • + "change-handlers.model" +
  • "context.model"
    • diff --git a/docs/interfaces/_database_model_.databaseinterface.html b/docs/interfaces/_database_model_.databaseinterface.html index 031c8ab..fe0cc31 100644 --- a/docs/interfaces/_database_model_.databaseinterface.html +++ b/docs/interfaces/_database_model_.databaseinterface.html @@ -94,6 +94,7 @@
  • init
  • read
  • remove
    • +
  • subscribe
  • toString
  • write
    • @@ -113,7 +114,7 @@
  • @@ -135,7 +136,7 @@
  • @@ -161,7 +162,7 @@
  • @@ -192,7 +193,7 @@
  • @@ -210,6 +211,67 @@
    • +
    + +

    subscribe

    + + +

    toString

    @@ -220,7 +282,7 @@
  • @@ -242,7 +304,7 @@
  • @@ -275,6 +337,9 @@
  • Globals
    • +
  • + "change-handlers.model" +
  • "context.model"
    • @@ -314,6 +379,9 @@
  • remove
    • +
  • + subscribe +
  • toString
    • diff --git a/docs/modules/_change_handlers_model_.html b/docs/modules/_change_handlers_model_.html new file mode 100644 index 0000000..2a535b5 --- /dev/null +++ b/docs/modules/_change_handlers_model_.html @@ -0,0 +1,188 @@ + + + + + + "change-handlers.model" | naive + + + + + +
    +
    +
    +
    + +
    +
    + Options +
    +
    + All +
      +
    • Public
      • +
    • Public/Protected
      • +
    • All
      • +
    +
    + + + + + + +
    +
    + Menu +
    +
    +
    +
    +
    +
    + +

    External module "change-handlers.model"

    +
    +
    +
    +
    +
    +
    +
    +

    Index

    +
    +
    +
    +

    Interfaces

    + +
    +
    +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +

    Legend

    +
    +
      +
    • Module
      • +
    • Object literal
      • +
    • Variable
      • +
    • Function
      • +
    • Function with type parameter
      • +
    • Index signature
      • +
    • Type alias
      • +
    +
      +
    • Enumeration
      • +
    • Enumeration member
      • +
    • Property
      • +
    • Method
      • +
    +
      +
    • Interface
      • +
    • Interface with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Index signature
      • +
    +
      +
    • Class
      • +
    • Class with type parameter
      • +
    • Constructor
      • +
    • Property
      • +
    • Method
      • +
    • Accessor
      • +
    • Index signature
      • +
    +
      +
    • Inherited constructor
      • +
    • Inherited property
      • +
    • Inherited method
      • +
    • Inherited accessor
      • +
    +
      +
    • Protected property
      • +
    • Protected method
      • +
    • Protected accessor
      • +
    +
      +
    • Private property
      • +
    • Private method
      • +
    • Private accessor
      • +
    +
      +
    • Static property
      • +
    • Static method
      • +
    +
    +
    +
    +
    +

    Generated using TypeDoc

    +
    +
    + + + + \ No newline at end of file diff --git a/docs/modules/_context_model_.html b/docs/modules/_context_model_.html index 6fe45c5..68ecf78 100644 --- a/docs/modules/_context_model_.html +++ b/docs/modules/_context_model_.html @@ -86,6 +86,9 @@
  • Globals
    • +
  • + "change-handlers.model" +
  • "context.model"
    • diff --git a/docs/modules/_database_.html b/docs/modules/_database_.html index 5b0ed26..1364c5b 100644 --- a/docs/modules/_database_.html +++ b/docs/modules/_database_.html @@ -86,6 +86,7 @@

    Functions

    @@ -107,7 +108,7 @@
    read: __promisify__ = promisify(readFile)
    @@ -117,13 +118,46 @@
    write: __promisify__ = promisify(writeFile)

    Functions

    +
    + +

    Const isChildOrMatch

    +
      +
    • isChildOrMatch(child: string, parent: string): boolean
      • +
    + +

    Const isRootNode

    @@ -134,7 +168,7 @@
  • @@ -162,7 +196,7 @@
  • @@ -189,7 +223,7 @@
    DEFAULT_CTX: object
    @@ -198,7 +232,7 @@
    cachePath: string = `${__dirname}/db.json`
    @@ -208,7 +242,7 @@
    logger: log = console.log
    • @@ -218,7 +252,7 @@
    maxDbSizeMB: number = 6
    @@ -231,6 +265,9 @@
  • Globals
    • +
  • + "change-handlers.model" +
  • "context.model"
    • @@ -262,6 +299,9 @@
  • write
    • +
  • + isChildOrMatch +
  • isRootNode
    • diff --git a/docs/modules/_database_model_.html b/docs/modules/_database_model_.html index c99da41..4a395d3 100644 --- a/docs/modules/_database_model_.html +++ b/docs/modules/_database_model_.html @@ -86,6 +86,9 @@
  • Globals
    • +
  • + "change-handlers.model" +
  • "context.model"
    • diff --git a/docs/modules/_database_test_.html b/docs/modules/_database_test_.html index 77a7bbe..c02eaff 100644 --- a/docs/modules/_database_test_.html +++ b/docs/modules/_database_test_.html @@ -93,7 +93,7 @@
    maxDbSizeMB: 0.1 = 0.1
    @@ -110,7 +110,7 @@

  • Parameters

    @@ -131,6 +131,9 @@
  • Globals
    • +
  • + "change-handlers.model" +
  • "context.model"
    • diff --git a/docs/modules/_error_model_.html b/docs/modules/_error_model_.html index 01b7a8d..9375a8d 100644 --- a/docs/modules/_error_model_.html +++ b/docs/modules/_error_model_.html @@ -105,7 +105,7 @@
    e: NaiveErrorCode = NaiveErrorCode
    @@ -122,7 +122,7 @@

  • Parameters

    @@ -146,6 +146,9 @@
  • Globals
    • +
  • + "change-handlers.model" +
  • "context.model"
    • diff --git a/docs/modules/_util_.html b/docs/modules/_util_.html index 6ca5f8a..47c53f6 100644 --- a/docs/modules/_util_.html +++ b/docs/modules/_util_.html @@ -73,6 +73,7 @@

    Functions

    @@ -81,6 +82,34 @@

    Functions

    +
    + +

    Const getKey

    +
      +
    • getKey(seed: string): string
      • +
    +
      +
    • + +
      +
      +

      Generate a random key with a seed

      +
      +
      +

      Parameters

      +
        +
      • +
        seed: string
        +
        • +
      +

      Returns string

      +
      • +
    +

    Const last

    @@ -91,7 +120,7 @@
  • @@ -123,6 +152,9 @@
  • Globals
    • +
  • + "change-handlers.model" +
  • "context.model"
    • @@ -145,6 +177,9 @@