From 37f0d9eac86cdb4c114276153fcba3e083dee189 Mon Sep 17 00:00:00 2001 From: Roger Qiu Date: Fri, 1 Apr 2022 16:06:38 +1100 Subject: [PATCH] Updated docs --- docs/assets/search.js | 2 +- docs/classes/Lock.html | 2 +- docs/classes/RWLockReader.html | 2 +- docs/classes/RWLockWriter.html | 2 +- docs/classes/errors.ErrorAsyncLocks.html | 6 ++++++ docs/classes/errors.ErrorAsyncLocksTimeout.html | 6 ++++++ docs/index.html | 2 +- docs/modules.html | 4 +++- docs/modules/errors.html | 1 + docs/modules/utils.html | 1 + 10 files changed, 22 insertions(+), 6 deletions(-) create mode 100644 docs/classes/errors.ErrorAsyncLocks.html create mode 100644 docs/classes/errors.ErrorAsyncLocksTimeout.html create mode 100644 docs/modules/errors.html create mode 100644 docs/modules/utils.html diff --git a/docs/assets/search.js b/docs/assets/search.js index df164c4..5f074ef 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"128\":\"Class\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"262144\":\"Accessor\"},\"rows\":[{\"id\":0,\"kind\":128,\"name\":\"Lock\",\"url\":\"classes/Lock.html\",\"classes\":\"tsd-kind-class\"},{\"id\":1,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Lock.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Lock\"},{\"id\":2,\"kind\":1024,\"name\":\"lock\",\"url\":\"classes/Lock.html#lock\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Lock\"},{\"id\":3,\"kind\":1024,\"name\":\"release\",\"url\":\"classes/Lock.html#release\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Lock\"},{\"id\":4,\"kind\":1024,\"name\":\"_count\",\"url\":\"classes/Lock.html#_count\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Lock\"},{\"id\":5,\"kind\":1024,\"name\":\"acquire\",\"url\":\"classes/Lock.html#acquire\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"Lock\"},{\"id\":6,\"kind\":262144,\"name\":\"count\",\"url\":\"classes/Lock.html#count\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"Lock\"},{\"id\":7,\"kind\":2048,\"name\":\"isLocked\",\"url\":\"classes/Lock.html#isLocked\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Lock\"},{\"id\":8,\"kind\":2048,\"name\":\"waitForUnlock\",\"url\":\"classes/Lock.html#waitForUnlock\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Lock\"},{\"id\":9,\"kind\":2048,\"name\":\"withF\",\"url\":\"classes/Lock.html#withF\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"Lock\"},{\"id\":10,\"kind\":2048,\"name\":\"withG\",\"url\":\"classes/Lock.html#withG\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"Lock\"},{\"id\":11,\"kind\":128,\"name\":\"RWLockReader\",\"url\":\"classes/RWLockReader.html\",\"classes\":\"tsd-kind-class\"},{\"id\":12,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/RWLockReader.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":13,\"kind\":1024,\"name\":\"_readerCount\",\"url\":\"classes/RWLockReader.html#_readerCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockReader\"},{\"id\":14,\"kind\":1024,\"name\":\"_writerCount\",\"url\":\"classes/RWLockReader.html#_writerCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockReader\"},{\"id\":15,\"kind\":1024,\"name\":\"lock\",\"url\":\"classes/RWLockReader.html#lock\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockReader\"},{\"id\":16,\"kind\":1024,\"name\":\"release\",\"url\":\"classes/RWLockReader.html#release\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockReader\"},{\"id\":17,\"kind\":1024,\"name\":\"acquireRead\",\"url\":\"classes/RWLockReader.html#acquireRead\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":18,\"kind\":1024,\"name\":\"acquireWrite\",\"url\":\"classes/RWLockReader.html#acquireWrite\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":19,\"kind\":262144,\"name\":\"readerCount\",\"url\":\"classes/RWLockReader.html#readerCount\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":20,\"kind\":262144,\"name\":\"writerCount\",\"url\":\"classes/RWLockReader.html#writerCount\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":21,\"kind\":2048,\"name\":\"isLocked\",\"url\":\"classes/RWLockReader.html#isLocked\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":22,\"kind\":2048,\"name\":\"waitForUnlock\",\"url\":\"classes/RWLockReader.html#waitForUnlock\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":23,\"kind\":2048,\"name\":\"withReadF\",\"url\":\"classes/RWLockReader.html#withReadF\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockReader\"},{\"id\":24,\"kind\":2048,\"name\":\"withWriteF\",\"url\":\"classes/RWLockReader.html#withWriteF\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockReader\"},{\"id\":25,\"kind\":2048,\"name\":\"withReadG\",\"url\":\"classes/RWLockReader.html#withReadG\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockReader\"},{\"id\":26,\"kind\":2048,\"name\":\"withWriteG\",\"url\":\"classes/RWLockReader.html#withWriteG\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockReader\"},{\"id\":27,\"kind\":128,\"name\":\"RWLockWriter\",\"url\":\"classes/RWLockWriter.html\",\"classes\":\"tsd-kind-class\"},{\"id\":28,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/RWLockWriter.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":29,\"kind\":1024,\"name\":\"readersLock\",\"url\":\"classes/RWLockWriter.html#readersLock\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockWriter\"},{\"id\":30,\"kind\":1024,\"name\":\"writersLock\",\"url\":\"classes/RWLockWriter.html#writersLock\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockWriter\"},{\"id\":31,\"kind\":1024,\"name\":\"readersRelease\",\"url\":\"classes/RWLockWriter.html#readersRelease\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockWriter\"},{\"id\":32,\"kind\":1024,\"name\":\"readerCountBlocked\",\"url\":\"classes/RWLockWriter.html#readerCountBlocked\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockWriter\"},{\"id\":33,\"kind\":1024,\"name\":\"_readerCount\",\"url\":\"classes/RWLockWriter.html#_readerCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockWriter\"},{\"id\":34,\"kind\":1024,\"name\":\"_writerCount\",\"url\":\"classes/RWLockWriter.html#_writerCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockWriter\"},{\"id\":35,\"kind\":1024,\"name\":\"acquireRead\",\"url\":\"classes/RWLockWriter.html#acquireRead\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":36,\"kind\":1024,\"name\":\"acquireWrite\",\"url\":\"classes/RWLockWriter.html#acquireWrite\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":37,\"kind\":262144,\"name\":\"readerCount\",\"url\":\"classes/RWLockWriter.html#readerCount\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":38,\"kind\":262144,\"name\":\"writerCount\",\"url\":\"classes/RWLockWriter.html#writerCount\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":39,\"kind\":2048,\"name\":\"isLocked\",\"url\":\"classes/RWLockWriter.html#isLocked\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":40,\"kind\":2048,\"name\":\"waitForUnlock\",\"url\":\"classes/RWLockWriter.html#waitForUnlock\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":41,\"kind\":2048,\"name\":\"withReadF\",\"url\":\"classes/RWLockWriter.html#withReadF\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockWriter\"},{\"id\":42,\"kind\":2048,\"name\":\"withWriteF\",\"url\":\"classes/RWLockWriter.html#withWriteF\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockWriter\"},{\"id\":43,\"kind\":2048,\"name\":\"withReadG\",\"url\":\"classes/RWLockWriter.html#withReadG\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockWriter\"},{\"id\":44,\"kind\":2048,\"name\":\"withWriteG\",\"url\":\"classes/RWLockWriter.html#withWriteG\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockWriter\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,12.26]],[\"parent/0\",[]],[\"name/1\",[1,25.759]],[\"parent/1\",[0,1.191]],[\"name/2\",[0,12.26]],[\"parent/2\",[0,1.191]],[\"name/3\",[2,29.124]],[\"parent/3\",[0,1.191]],[\"name/4\",[3,34.232]],[\"parent/4\",[0,1.191]],[\"name/5\",[4,34.232]],[\"parent/5\",[0,1.191]],[\"name/6\",[5,34.232]],[\"parent/6\",[0,1.191]],[\"name/7\",[6,25.759]],[\"parent/7\",[0,1.191]],[\"name/8\",[7,25.759]],[\"parent/8\",[0,1.191]],[\"name/9\",[8,34.232]],[\"parent/9\",[0,1.191]],[\"name/10\",[9,34.232]],[\"parent/10\",[0,1.191]],[\"name/11\",[10,10.253]],[\"parent/11\",[]],[\"name/12\",[1,25.759]],[\"parent/12\",[10,0.996]],[\"name/13\",[11,29.124]],[\"parent/13\",[10,0.996]],[\"name/14\",[12,29.124]],[\"parent/14\",[10,0.996]],[\"name/15\",[0,12.26]],[\"parent/15\",[10,0.996]],[\"name/16\",[2,29.124]],[\"parent/16\",[10,0.996]],[\"name/17\",[13,29.124]],[\"parent/17\",[10,0.996]],[\"name/18\",[14,29.124]],[\"parent/18\",[10,0.996]],[\"name/19\",[15,29.124]],[\"parent/19\",[10,0.996]],[\"name/20\",[16,29.124]],[\"parent/20\",[10,0.996]],[\"name/21\",[6,25.759]],[\"parent/21\",[10,0.996]],[\"name/22\",[7,25.759]],[\"parent/22\",[10,0.996]],[\"name/23\",[17,29.124]],[\"parent/23\",[10,0.996]],[\"name/24\",[18,29.124]],[\"parent/24\",[10,0.996]],[\"name/25\",[19,29.124]],[\"parent/25\",[10,0.996]],[\"name/26\",[20,29.124]],[\"parent/26\",[10,0.996]],[\"name/27\",[21,9.109]],[\"parent/27\",[]],[\"name/28\",[1,25.759]],[\"parent/28\",[21,0.885]],[\"name/29\",[22,34.232]],[\"parent/29\",[21,0.885]],[\"name/30\",[23,34.232]],[\"parent/30\",[21,0.885]],[\"name/31\",[24,34.232]],[\"parent/31\",[21,0.885]],[\"name/32\",[25,34.232]],[\"parent/32\",[21,0.885]],[\"name/33\",[11,29.124]],[\"parent/33\",[21,0.885]],[\"name/34\",[12,29.124]],[\"parent/34\",[21,0.885]],[\"name/35\",[13,29.124]],[\"parent/35\",[21,0.885]],[\"name/36\",[14,29.124]],[\"parent/36\",[21,0.885]],[\"name/37\",[15,29.124]],[\"parent/37\",[21,0.885]],[\"name/38\",[16,29.124]],[\"parent/38\",[21,0.885]],[\"name/39\",[6,25.759]],[\"parent/39\",[21,0.885]],[\"name/40\",[7,25.759]],[\"parent/40\",[21,0.885]],[\"name/41\",[17,29.124]],[\"parent/41\",[21,0.885]],[\"name/42\",[18,29.124]],[\"parent/42\",[21,0.885]],[\"name/43\",[19,29.124]],[\"parent/43\",[21,0.885]],[\"name/44\",[20,29.124]],[\"parent/44\",[21,0.885]]],\"invertedIndex\":[[\"_count\",{\"_index\":3,\"name\":{\"4\":{}},\"parent\":{}}],[\"_readercount\",{\"_index\":11,\"name\":{\"13\":{},\"33\":{}},\"parent\":{}}],[\"_writercount\",{\"_index\":12,\"name\":{\"14\":{},\"34\":{}},\"parent\":{}}],[\"acquire\",{\"_index\":4,\"name\":{\"5\":{}},\"parent\":{}}],[\"acquireread\",{\"_index\":13,\"name\":{\"17\":{},\"35\":{}},\"parent\":{}}],[\"acquirewrite\",{\"_index\":14,\"name\":{\"18\":{},\"36\":{}},\"parent\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"12\":{},\"28\":{}},\"parent\":{}}],[\"count\",{\"_index\":5,\"name\":{\"6\":{}},\"parent\":{}}],[\"islocked\",{\"_index\":6,\"name\":{\"7\":{},\"21\":{},\"39\":{}},\"parent\":{}}],[\"lock\",{\"_index\":0,\"name\":{\"0\":{},\"2\":{},\"15\":{}},\"parent\":{\"1\":{},\"2\":{},\"3\":{},\"4\":{},\"5\":{},\"6\":{},\"7\":{},\"8\":{},\"9\":{},\"10\":{}}}],[\"readercount\",{\"_index\":15,\"name\":{\"19\":{},\"37\":{}},\"parent\":{}}],[\"readercountblocked\",{\"_index\":25,\"name\":{\"32\":{}},\"parent\":{}}],[\"readerslock\",{\"_index\":22,\"name\":{\"29\":{}},\"parent\":{}}],[\"readersrelease\",{\"_index\":24,\"name\":{\"31\":{}},\"parent\":{}}],[\"release\",{\"_index\":2,\"name\":{\"3\":{},\"16\":{}},\"parent\":{}}],[\"rwlockreader\",{\"_index\":10,\"name\":{\"11\":{}},\"parent\":{\"12\":{},\"13\":{},\"14\":{},\"15\":{},\"16\":{},\"17\":{},\"18\":{},\"19\":{},\"20\":{},\"21\":{},\"22\":{},\"23\":{},\"24\":{},\"25\":{},\"26\":{}}}],[\"rwlockwriter\",{\"_index\":21,\"name\":{\"27\":{}},\"parent\":{\"28\":{},\"29\":{},\"30\":{},\"31\":{},\"32\":{},\"33\":{},\"34\":{},\"35\":{},\"36\":{},\"37\":{},\"38\":{},\"39\":{},\"40\":{},\"41\":{},\"42\":{},\"43\":{},\"44\":{}}}],[\"waitforunlock\",{\"_index\":7,\"name\":{\"8\":{},\"22\":{},\"40\":{}},\"parent\":{}}],[\"withf\",{\"_index\":8,\"name\":{\"9\":{}},\"parent\":{}}],[\"withg\",{\"_index\":9,\"name\":{\"10\":{}},\"parent\":{}}],[\"withreadf\",{\"_index\":17,\"name\":{\"23\":{},\"41\":{}},\"parent\":{}}],[\"withreadg\",{\"_index\":19,\"name\":{\"25\":{},\"43\":{}},\"parent\":{}}],[\"withwritef\",{\"_index\":18,\"name\":{\"24\":{},\"42\":{}},\"parent\":{}}],[\"withwriteg\",{\"_index\":20,\"name\":{\"26\":{},\"44\":{}},\"parent\":{}}],[\"writercount\",{\"_index\":16,\"name\":{\"20\":{},\"38\":{}},\"parent\":{}}],[\"writerslock\",{\"_index\":23,\"name\":{\"30\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = JSON.parse("{\"kinds\":{\"4\":\"Namespace\",\"64\":\"Function\",\"128\":\"Class\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"262144\":\"Accessor\",\"4194304\":\"Type alias\"},\"rows\":[{\"id\":0,\"kind\":128,\"name\":\"Lock\",\"url\":\"classes/Lock.html\",\"classes\":\"tsd-kind-class\"},{\"id\":1,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/Lock.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"Lock\"},{\"id\":2,\"kind\":1024,\"name\":\"_lock\",\"url\":\"classes/Lock.html#_lock\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Lock\"},{\"id\":3,\"kind\":1024,\"name\":\"_count\",\"url\":\"classes/Lock.html#_count\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"Lock\"},{\"id\":4,\"kind\":2048,\"name\":\"lock\",\"url\":\"classes/Lock.html#lock\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Lock\"},{\"id\":5,\"kind\":262144,\"name\":\"count\",\"url\":\"classes/Lock.html#count\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"Lock\"},{\"id\":6,\"kind\":2048,\"name\":\"isLocked\",\"url\":\"classes/Lock.html#isLocked\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Lock\"},{\"id\":7,\"kind\":2048,\"name\":\"waitForUnlock\",\"url\":\"classes/Lock.html#waitForUnlock\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"Lock\"},{\"id\":8,\"kind\":2048,\"name\":\"withF\",\"url\":\"classes/Lock.html#withF\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"Lock\"},{\"id\":9,\"kind\":2048,\"name\":\"withG\",\"url\":\"classes/Lock.html#withG\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"Lock\"},{\"id\":10,\"kind\":128,\"name\":\"RWLockReader\",\"url\":\"classes/RWLockReader.html\",\"classes\":\"tsd-kind-class\"},{\"id\":11,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/RWLockReader.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":12,\"kind\":1024,\"name\":\"_readerCount\",\"url\":\"classes/RWLockReader.html#_readerCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockReader\"},{\"id\":13,\"kind\":1024,\"name\":\"_writerCount\",\"url\":\"classes/RWLockReader.html#_writerCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockReader\"},{\"id\":14,\"kind\":1024,\"name\":\"lock\",\"url\":\"classes/RWLockReader.html#lock\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockReader\"},{\"id\":15,\"kind\":1024,\"name\":\"release\",\"url\":\"classes/RWLockReader.html#release\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockReader\"},{\"id\":16,\"kind\":2048,\"name\":\"read\",\"url\":\"classes/RWLockReader.html#read\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":17,\"kind\":2048,\"name\":\"write\",\"url\":\"classes/RWLockReader.html#write\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":18,\"kind\":262144,\"name\":\"readerCount\",\"url\":\"classes/RWLockReader.html#readerCount\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":19,\"kind\":262144,\"name\":\"writerCount\",\"url\":\"classes/RWLockReader.html#writerCount\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":20,\"kind\":2048,\"name\":\"isLocked\",\"url\":\"classes/RWLockReader.html#isLocked\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":21,\"kind\":2048,\"name\":\"waitForUnlock\",\"url\":\"classes/RWLockReader.html#waitForUnlock\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RWLockReader\"},{\"id\":22,\"kind\":2048,\"name\":\"withReadF\",\"url\":\"classes/RWLockReader.html#withReadF\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockReader\"},{\"id\":23,\"kind\":2048,\"name\":\"withWriteF\",\"url\":\"classes/RWLockReader.html#withWriteF\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockReader\"},{\"id\":24,\"kind\":2048,\"name\":\"withReadG\",\"url\":\"classes/RWLockReader.html#withReadG\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockReader\"},{\"id\":25,\"kind\":2048,\"name\":\"withWriteG\",\"url\":\"classes/RWLockReader.html#withWriteG\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockReader\"},{\"id\":26,\"kind\":128,\"name\":\"RWLockWriter\",\"url\":\"classes/RWLockWriter.html\",\"classes\":\"tsd-kind-class\"},{\"id\":27,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/RWLockWriter.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":28,\"kind\":1024,\"name\":\"readersLock\",\"url\":\"classes/RWLockWriter.html#readersLock\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockWriter\"},{\"id\":29,\"kind\":1024,\"name\":\"writersLock\",\"url\":\"classes/RWLockWriter.html#writersLock\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockWriter\"},{\"id\":30,\"kind\":1024,\"name\":\"readersRelease\",\"url\":\"classes/RWLockWriter.html#readersRelease\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockWriter\"},{\"id\":31,\"kind\":1024,\"name\":\"readerCountBlocked\",\"url\":\"classes/RWLockWriter.html#readerCountBlocked\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockWriter\"},{\"id\":32,\"kind\":1024,\"name\":\"_readerCount\",\"url\":\"classes/RWLockWriter.html#_readerCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockWriter\"},{\"id\":33,\"kind\":1024,\"name\":\"_writerCount\",\"url\":\"classes/RWLockWriter.html#_writerCount\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-protected\",\"parent\":\"RWLockWriter\"},{\"id\":34,\"kind\":2048,\"name\":\"read\",\"url\":\"classes/RWLockWriter.html#read\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":35,\"kind\":2048,\"name\":\"write\",\"url\":\"classes/RWLockWriter.html#write\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":36,\"kind\":262144,\"name\":\"readerCount\",\"url\":\"classes/RWLockWriter.html#readerCount\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":37,\"kind\":262144,\"name\":\"writerCount\",\"url\":\"classes/RWLockWriter.html#writerCount\",\"classes\":\"tsd-kind-get-signature tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":38,\"kind\":2048,\"name\":\"isLocked\",\"url\":\"classes/RWLockWriter.html#isLocked\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":39,\"kind\":2048,\"name\":\"waitForUnlock\",\"url\":\"classes/RWLockWriter.html#waitForUnlock\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"RWLockWriter\"},{\"id\":40,\"kind\":2048,\"name\":\"withReadF\",\"url\":\"classes/RWLockWriter.html#withReadF\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockWriter\"},{\"id\":41,\"kind\":2048,\"name\":\"withWriteF\",\"url\":\"classes/RWLockWriter.html#withWriteF\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockWriter\"},{\"id\":42,\"kind\":2048,\"name\":\"withReadG\",\"url\":\"classes/RWLockWriter.html#withReadG\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockWriter\"},{\"id\":43,\"kind\":2048,\"name\":\"withWriteG\",\"url\":\"classes/RWLockWriter.html#withWriteG\",\"classes\":\"tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter\",\"parent\":\"RWLockWriter\"},{\"id\":44,\"kind\":4,\"name\":\"utils\",\"url\":\"modules/utils.html\",\"classes\":\"tsd-kind-namespace\"},{\"id\":45,\"kind\":64,\"name\":\"sleep\",\"url\":\"modules/utils.html#sleep\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"utils\"},{\"id\":46,\"kind\":64,\"name\":\"yieldMicro\",\"url\":\"modules/utils.html#yieldMicro\",\"classes\":\"tsd-kind-function tsd-parent-kind-namespace\",\"parent\":\"utils\"},{\"id\":47,\"kind\":4,\"name\":\"errors\",\"url\":\"modules/errors.html\",\"classes\":\"tsd-kind-namespace\"},{\"id\":48,\"kind\":128,\"name\":\"ErrorAsyncLocks\",\"url\":\"classes/errors.ErrorAsyncLocks.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-namespace\",\"parent\":\"errors\"},{\"id\":49,\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/errors.ErrorAsyncLocks.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-class\",\"parent\":\"errors.ErrorAsyncLocks\"},{\"id\":50,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/errors.ErrorAsyncLocks.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite\",\"parent\":\"errors.ErrorAsyncLocks\"},{\"id\":51,\"kind\":1024,\"name\":\"data\",\"url\":\"classes/errors.ErrorAsyncLocks.html#data\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"errors.ErrorAsyncLocks\"},{\"id\":52,\"kind\":128,\"name\":\"ErrorAsyncLocksTimeout\",\"url\":\"classes/errors.ErrorAsyncLocksTimeout.html\",\"classes\":\"tsd-kind-class tsd-parent-kind-namespace\",\"parent\":\"errors\"},{\"id\":53,\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/errors.ErrorAsyncLocksTimeout.html#__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-class\",\"parent\":\"errors.ErrorAsyncLocksTimeout\"},{\"id\":54,\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/errors.ErrorAsyncLocksTimeout.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"errors.ErrorAsyncLocksTimeout\"},{\"id\":55,\"kind\":1024,\"name\":\"data\",\"url\":\"classes/errors.ErrorAsyncLocksTimeout.html#data\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-inherited\",\"parent\":\"errors.ErrorAsyncLocksTimeout\"},{\"id\":56,\"kind\":4194304,\"name\":\"POJO\",\"url\":\"modules.html#POJO\",\"classes\":\"tsd-kind-type-alias\"},{\"id\":57,\"kind\":65536,\"name\":\"__type\",\"url\":\"modules.html#POJO.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-type-alias\",\"parent\":\"POJO\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"parent\"],\"fieldVectors\":[[\"name/0\",[0,15.518]],[\"parent/0\",[]],[\"name/1\",[1,23.728]],[\"parent/1\",[0,1.482]],[\"name/2\",[2,36.721]],[\"parent/2\",[0,1.482]],[\"name/3\",[3,36.721]],[\"parent/3\",[0,1.482]],[\"name/4\",[0,15.518]],[\"parent/4\",[0,1.482]],[\"name/5\",[4,36.721]],[\"parent/5\",[0,1.482]],[\"name/6\",[5,28.248]],[\"parent/6\",[0,1.482]],[\"name/7\",[6,28.248]],[\"parent/7\",[0,1.482]],[\"name/8\",[7,36.721]],[\"parent/8\",[0,1.482]],[\"name/9\",[8,36.721]],[\"parent/9\",[0,1.482]],[\"name/10\",[9,12.742]],[\"parent/10\",[]],[\"name/11\",[1,23.728]],[\"parent/11\",[9,1.217]],[\"name/12\",[10,31.612]],[\"parent/12\",[9,1.217]],[\"name/13\",[11,31.612]],[\"parent/13\",[9,1.217]],[\"name/14\",[0,15.518]],[\"parent/14\",[9,1.217]],[\"name/15\",[12,36.721]],[\"parent/15\",[9,1.217]],[\"name/16\",[13,31.612]],[\"parent/16\",[9,1.217]],[\"name/17\",[14,31.612]],[\"parent/17\",[9,1.217]],[\"name/18\",[15,31.612]],[\"parent/18\",[9,1.217]],[\"name/19\",[16,31.612]],[\"parent/19\",[9,1.217]],[\"name/20\",[5,28.248]],[\"parent/20\",[9,1.217]],[\"name/21\",[6,28.248]],[\"parent/21\",[9,1.217]],[\"name/22\",[17,31.612]],[\"parent/22\",[9,1.217]],[\"name/23\",[18,31.612]],[\"parent/23\",[9,1.217]],[\"name/24\",[19,31.612]],[\"parent/24\",[9,1.217]],[\"name/25\",[20,31.612]],[\"parent/25\",[9,1.217]],[\"name/26\",[21,11.598]],[\"parent/26\",[]],[\"name/27\",[1,23.728]],[\"parent/27\",[21,1.107]],[\"name/28\",[22,36.721]],[\"parent/28\",[21,1.107]],[\"name/29\",[23,36.721]],[\"parent/29\",[21,1.107]],[\"name/30\",[24,36.721]],[\"parent/30\",[21,1.107]],[\"name/31\",[25,36.721]],[\"parent/31\",[21,1.107]],[\"name/32\",[10,31.612]],[\"parent/32\",[21,1.107]],[\"name/33\",[11,31.612]],[\"parent/33\",[21,1.107]],[\"name/34\",[13,31.612]],[\"parent/34\",[21,1.107]],[\"name/35\",[14,31.612]],[\"parent/35\",[21,1.107]],[\"name/36\",[15,31.612]],[\"parent/36\",[21,1.107]],[\"name/37\",[16,31.612]],[\"parent/37\",[21,1.107]],[\"name/38\",[5,28.248]],[\"parent/38\",[21,1.107]],[\"name/39\",[6,28.248]],[\"parent/39\",[21,1.107]],[\"name/40\",[17,31.612]],[\"parent/40\",[21,1.107]],[\"name/41\",[18,31.612]],[\"parent/41\",[21,1.107]],[\"name/42\",[19,31.612]],[\"parent/42\",[21,1.107]],[\"name/43\",[20,31.612]],[\"parent/43\",[21,1.107]],[\"name/44\",[26,28.248]],[\"parent/44\",[]],[\"name/45\",[27,36.721]],[\"parent/45\",[26,2.697]],[\"name/46\",[28,36.721]],[\"parent/46\",[26,2.697]],[\"name/47\",[29,28.248]],[\"parent/47\",[]],[\"name/48\",[30,36.721]],[\"parent/48\",[29,2.697]],[\"name/49\",[31,28.248]],[\"parent/49\",[32,2.697]],[\"name/50\",[1,23.728]],[\"parent/50\",[32,2.697]],[\"name/51\",[33,31.612]],[\"parent/51\",[32,2.697]],[\"name/52\",[34,36.721]],[\"parent/52\",[29,2.697]],[\"name/53\",[31,28.248]],[\"parent/53\",[35,2.697]],[\"name/54\",[1,23.728]],[\"parent/54\",[35,2.697]],[\"name/55\",[33,31.612]],[\"parent/55\",[35,2.697]],[\"name/56\",[36,31.612]],[\"parent/56\",[]],[\"name/57\",[31,28.248]],[\"parent/57\",[36,3.019]]],\"invertedIndex\":[[\"__type\",{\"_index\":31,\"name\":{\"49\":{},\"53\":{},\"57\":{}},\"parent\":{}}],[\"_count\",{\"_index\":3,\"name\":{\"3\":{}},\"parent\":{}}],[\"_lock\",{\"_index\":2,\"name\":{\"2\":{}},\"parent\":{}}],[\"_readercount\",{\"_index\":10,\"name\":{\"12\":{},\"32\":{}},\"parent\":{}}],[\"_writercount\",{\"_index\":11,\"name\":{\"13\":{},\"33\":{}},\"parent\":{}}],[\"constructor\",{\"_index\":1,\"name\":{\"1\":{},\"11\":{},\"27\":{},\"50\":{},\"54\":{}},\"parent\":{}}],[\"count\",{\"_index\":4,\"name\":{\"5\":{}},\"parent\":{}}],[\"data\",{\"_index\":33,\"name\":{\"51\":{},\"55\":{}},\"parent\":{}}],[\"errorasynclocks\",{\"_index\":30,\"name\":{\"48\":{}},\"parent\":{}}],[\"errorasynclockstimeout\",{\"_index\":34,\"name\":{\"52\":{}},\"parent\":{}}],[\"errors\",{\"_index\":29,\"name\":{\"47\":{}},\"parent\":{\"48\":{},\"52\":{}}}],[\"errors.errorasynclocks\",{\"_index\":32,\"name\":{},\"parent\":{\"49\":{},\"50\":{},\"51\":{}}}],[\"errors.errorasynclockstimeout\",{\"_index\":35,\"name\":{},\"parent\":{\"53\":{},\"54\":{},\"55\":{}}}],[\"islocked\",{\"_index\":5,\"name\":{\"6\":{},\"20\":{},\"38\":{}},\"parent\":{}}],[\"lock\",{\"_index\":0,\"name\":{\"0\":{},\"4\":{},\"14\":{}},\"parent\":{\"1\":{},\"2\":{},\"3\":{},\"4\":{},\"5\":{},\"6\":{},\"7\":{},\"8\":{},\"9\":{}}}],[\"pojo\",{\"_index\":36,\"name\":{\"56\":{}},\"parent\":{\"57\":{}}}],[\"read\",{\"_index\":13,\"name\":{\"16\":{},\"34\":{}},\"parent\":{}}],[\"readercount\",{\"_index\":15,\"name\":{\"18\":{},\"36\":{}},\"parent\":{}}],[\"readercountblocked\",{\"_index\":25,\"name\":{\"31\":{}},\"parent\":{}}],[\"readerslock\",{\"_index\":22,\"name\":{\"28\":{}},\"parent\":{}}],[\"readersrelease\",{\"_index\":24,\"name\":{\"30\":{}},\"parent\":{}}],[\"release\",{\"_index\":12,\"name\":{\"15\":{}},\"parent\":{}}],[\"rwlockreader\",{\"_index\":9,\"name\":{\"10\":{}},\"parent\":{\"11\":{},\"12\":{},\"13\":{},\"14\":{},\"15\":{},\"16\":{},\"17\":{},\"18\":{},\"19\":{},\"20\":{},\"21\":{},\"22\":{},\"23\":{},\"24\":{},\"25\":{}}}],[\"rwlockwriter\",{\"_index\":21,\"name\":{\"26\":{}},\"parent\":{\"27\":{},\"28\":{},\"29\":{},\"30\":{},\"31\":{},\"32\":{},\"33\":{},\"34\":{},\"35\":{},\"36\":{},\"37\":{},\"38\":{},\"39\":{},\"40\":{},\"41\":{},\"42\":{},\"43\":{}}}],[\"sleep\",{\"_index\":27,\"name\":{\"45\":{}},\"parent\":{}}],[\"utils\",{\"_index\":26,\"name\":{\"44\":{}},\"parent\":{\"45\":{},\"46\":{}}}],[\"waitforunlock\",{\"_index\":6,\"name\":{\"7\":{},\"21\":{},\"39\":{}},\"parent\":{}}],[\"withf\",{\"_index\":7,\"name\":{\"8\":{}},\"parent\":{}}],[\"withg\",{\"_index\":8,\"name\":{\"9\":{}},\"parent\":{}}],[\"withreadf\",{\"_index\":17,\"name\":{\"22\":{},\"40\":{}},\"parent\":{}}],[\"withreadg\",{\"_index\":19,\"name\":{\"24\":{},\"42\":{}},\"parent\":{}}],[\"withwritef\",{\"_index\":18,\"name\":{\"23\":{},\"41\":{}},\"parent\":{}}],[\"withwriteg\",{\"_index\":20,\"name\":{\"25\":{},\"43\":{}},\"parent\":{}}],[\"write\",{\"_index\":14,\"name\":{\"17\":{},\"35\":{}},\"parent\":{}}],[\"writercount\",{\"_index\":16,\"name\":{\"19\":{},\"37\":{}},\"parent\":{}}],[\"writerslock\",{\"_index\":23,\"name\":{\"29\":{}},\"parent\":{}}],[\"yieldmicro\",{\"_index\":28,\"name\":{\"46\":{}},\"parent\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file diff --git a/docs/classes/Lock.html b/docs/classes/Lock.html index ba24e14..df25c53 100644 --- a/docs/classes/Lock.html +++ b/docs/classes/Lock.html @@ -1 +1 @@ -Lock | @matrixai/async-locks
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Lock

Hierarchy

  • Lock

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _count

_count: number = 0

acquire

acquire: ResourceAcquire<Lock> = ...

Protected lock

lock: Mutex = ...

Protected release

release: Releaser

Accessors

count

  • get count(): number

Methods

isLocked

  • isLocked(): boolean

waitForUnlock

  • waitForUnlock(): Promise<void>

withF

  • withF<T>(f: (resources: [Lock]) => Promise<T>): Promise<T>

  • Type parameters

    • T

    Parameters

    • f: (resources: [Lock]) => Promise<T>
        • (resources: [Lock]): Promise<T>

        • Parameters

          Returns Promise<T>

    Returns Promise<T>

withG

  • withG<T, TReturn, TNext>(g: (resources: [Lock]) => AsyncGenerator<T, TReturn, TNext>): AsyncGenerator<T, TReturn, TNext>

  • Type parameters

    • T

    • TReturn

    • TNext

    Parameters

    • g: (resources: [Lock]) => AsyncGenerator<T, TReturn, TNext>
        • (resources: [Lock]): AsyncGenerator<T, TReturn, TNext>

        • Parameters

          Returns AsyncGenerator<T, TReturn, TNext>

    Returns AsyncGenerator<T, TReturn, TNext>

Generated using TypeDoc

\ No newline at end of file +Lock | @matrixai/async-locks
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Lock

Hierarchy

  • Lock

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _count

_count: number = 0

Protected _lock

_lock: Mutex = ...

Accessors

count

  • get count(): number

Methods

isLocked

  • isLocked(): boolean

lock

  • lock(timeout?: number): ResourceAcquire<Lock>

waitForUnlock

  • waitForUnlock(timeout?: number): Promise<void>

  • Parameters

    • Optional timeout: number

    Returns Promise<void>

withF

  • withF<T>(f: (resources: [Lock]) => Promise<T>, timeout?: number): Promise<T>

  • Type parameters

    • T

    Parameters

    • f: (resources: [Lock]) => Promise<T>
        • (resources: [Lock]): Promise<T>

        • Parameters

          Returns Promise<T>

    • Optional timeout: number

    Returns Promise<T>

withG

  • withG<T, TReturn, TNext>(g: (resources: [Lock]) => AsyncGenerator<T, TReturn, TNext>, timeout?: number): AsyncGenerator<T, TReturn, TNext>

  • Type parameters

    • T

    • TReturn

    • TNext

    Parameters

    • g: (resources: [Lock]) => AsyncGenerator<T, TReturn, TNext>
        • (resources: [Lock]): AsyncGenerator<T, TReturn, TNext>

        • Parameters

          Returns AsyncGenerator<T, TReturn, TNext>

    • Optional timeout: number

    Returns AsyncGenerator<T, TReturn, TNext>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/RWLockReader.html b/docs/classes/RWLockReader.html index eea713f..307fed6 100644 --- a/docs/classes/RWLockReader.html +++ b/docs/classes/RWLockReader.html @@ -1,3 +1,3 @@ RWLockReader | @matrixai/async-locks
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RWLockReader

Read-preferring read write lock

-

Hierarchy

  • RWLockReader

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _readerCount

_readerCount: number = 0

Protected _writerCount

_writerCount: number = 0

acquireRead

acquireRead: ResourceAcquire<RWLockReader> = ...

acquireWrite

acquireWrite: ResourceAcquire<RWLockReader> = ...

Protected lock

lock: Mutex = ...

Protected release

release: Releaser

Accessors

readerCount

  • get readerCount(): number

writerCount

  • get writerCount(): number

Methods

isLocked

  • isLocked(): boolean

waitForUnlock

  • waitForUnlock(): Promise<void>

withReadF

  • withReadF<T>(f: (resources: [RWLockReader]) => Promise<T>): Promise<T>

withReadG

  • withReadG<T, TReturn, TNext>(g: (resources: [RWLockReader]) => AsyncGenerator<T, TReturn, TNext>): AsyncGenerator<T, TReturn, TNext>

  • Type parameters

    • T

    • TReturn

    • TNext

    Parameters

    • g: (resources: [RWLockReader]) => AsyncGenerator<T, TReturn, TNext>
        • (resources: [RWLockReader]): AsyncGenerator<T, TReturn, TNext>

        • Parameters

          Returns AsyncGenerator<T, TReturn, TNext>

    Returns AsyncGenerator<T, TReturn, TNext>

withWriteF

  • withWriteF<T>(f: (resources: [RWLockReader]) => Promise<T>): Promise<T>

withWriteG

  • withWriteG<T, TReturn, TNext>(g: (resources: [RWLockReader]) => AsyncGenerator<T, TReturn, TNext>): AsyncGenerator<T, TReturn, TNext>

  • Type parameters

    • T

    • TReturn

    • TNext

    Parameters

    • g: (resources: [RWLockReader]) => AsyncGenerator<T, TReturn, TNext>
        • (resources: [RWLockReader]): AsyncGenerator<T, TReturn, TNext>

        • Parameters

          Returns AsyncGenerator<T, TReturn, TNext>

    Returns AsyncGenerator<T, TReturn, TNext>

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _readerCount

_readerCount: number = 0

Protected _writerCount

_writerCount: number = 0

Protected lock

lock: Mutex = ...

Protected release

release: Releaser

Accessors

readerCount

  • get readerCount(): number

writerCount

  • get writerCount(): number

Methods

isLocked

  • isLocked(): boolean

read

waitForUnlock

  • waitForUnlock(timeout?: number): Promise<void>

withReadF

  • withReadF<T>(f: (resources: [RWLockReader]) => Promise<T>, timeout?: number): Promise<T>

withReadG

  • withReadG<T, TReturn, TNext>(g: (resources: [RWLockReader]) => AsyncGenerator<T, TReturn, TNext>, timeout?: number): AsyncGenerator<T, TReturn, TNext>

  • Type parameters

    • T

    • TReturn

    • TNext

    Parameters

    • g: (resources: [RWLockReader]) => AsyncGenerator<T, TReturn, TNext>
        • (resources: [RWLockReader]): AsyncGenerator<T, TReturn, TNext>

        • Parameters

          Returns AsyncGenerator<T, TReturn, TNext>

    • Optional timeout: number

    Returns AsyncGenerator<T, TReturn, TNext>

withWriteF

  • withWriteF<T>(f: (resources: [RWLockReader]) => Promise<T>, timeout?: number): Promise<T>

withWriteG

  • withWriteG<T, TReturn, TNext>(g: (resources: [RWLockReader]) => AsyncGenerator<T, TReturn, TNext>, timeout?: number): AsyncGenerator<T, TReturn, TNext>

  • Type parameters

    • T

    • TReturn

    • TNext

    Parameters

    • g: (resources: [RWLockReader]) => AsyncGenerator<T, TReturn, TNext>
        • (resources: [RWLockReader]): AsyncGenerator<T, TReturn, TNext>

        • Parameters

          Returns AsyncGenerator<T, TReturn, TNext>

    • Optional timeout: number

    Returns AsyncGenerator<T, TReturn, TNext>

write

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/RWLockWriter.html b/docs/classes/RWLockWriter.html index 5da3d98..7ba33bf 100644 --- a/docs/classes/RWLockWriter.html +++ b/docs/classes/RWLockWriter.html @@ -1,3 +1,3 @@ RWLockWriter | @matrixai/async-locks
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RWLockWriter

Write-preferring read write lock

-

Hierarchy

  • RWLockWriter

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _readerCount

_readerCount: number = 0

Protected _writerCount

_writerCount: number = 0

acquireRead

acquireRead: ResourceAcquire<RWLockWriter> = ...

acquireWrite

acquireWrite: ResourceAcquire<RWLockWriter> = ...

Protected readerCountBlocked

readerCountBlocked: number = 0

Protected readersLock

readersLock: Mutex = ...

Protected readersRelease

readersRelease: Releaser

Protected writersLock

writersLock: Mutex = ...

Accessors

readerCount

  • get readerCount(): number

writerCount

  • get writerCount(): number

Methods

isLocked

  • isLocked(): boolean

waitForUnlock

  • waitForUnlock(): Promise<void>

withReadF

  • withReadF<T>(f: (resources: [RWLockWriter]) => Promise<T>): Promise<T>

withReadG

  • withReadG<T, TReturn, TNext>(g: (resources: [RWLockWriter]) => AsyncGenerator<T, TReturn, TNext>): AsyncGenerator<T, TReturn, TNext>

  • Type parameters

    • T

    • TReturn

    • TNext

    Parameters

    • g: (resources: [RWLockWriter]) => AsyncGenerator<T, TReturn, TNext>
        • (resources: [RWLockWriter]): AsyncGenerator<T, TReturn, TNext>

        • Parameters

          Returns AsyncGenerator<T, TReturn, TNext>

    Returns AsyncGenerator<T, TReturn, TNext>

withWriteF

  • withWriteF<T>(f: (resources: [RWLockWriter]) => Promise<T>): Promise<T>

withWriteG

  • withWriteG<T, TReturn, TNext>(g: (resources: [RWLockWriter]) => AsyncGenerator<T, TReturn, TNext>): AsyncGenerator<T, TReturn, TNext>

  • Type parameters

    • T

    • TReturn

    • TNext

    Parameters

    • g: (resources: [RWLockWriter]) => AsyncGenerator<T, TReturn, TNext>
        • (resources: [RWLockWriter]): AsyncGenerator<T, TReturn, TNext>

        • Parameters

          Returns AsyncGenerator<T, TReturn, TNext>

    Returns AsyncGenerator<T, TReturn, TNext>

Generated using TypeDoc

\ No newline at end of file +

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _readerCount

_readerCount: number = 0

Protected _writerCount

_writerCount: number = 0

Protected readerCountBlocked

readerCountBlocked: number = 0

Protected readersLock

readersLock: Mutex = ...

Protected readersRelease

readersRelease: Releaser

Protected writersLock

writersLock: Mutex = ...

Accessors

readerCount

  • get readerCount(): number

writerCount

  • get writerCount(): number

Methods

isLocked

  • isLocked(): boolean

read

waitForUnlock

  • waitForUnlock(timeout?: number): Promise<void>

withReadF

  • withReadF<T>(f: (resources: [RWLockWriter]) => Promise<T>, timeout?: number): Promise<T>

withReadG

  • withReadG<T, TReturn, TNext>(g: (resources: [RWLockWriter]) => AsyncGenerator<T, TReturn, TNext>, timeout?: number): AsyncGenerator<T, TReturn, TNext>

  • Type parameters

    • T

    • TReturn

    • TNext

    Parameters

    • g: (resources: [RWLockWriter]) => AsyncGenerator<T, TReturn, TNext>
        • (resources: [RWLockWriter]): AsyncGenerator<T, TReturn, TNext>

        • Parameters

          Returns AsyncGenerator<T, TReturn, TNext>

    • Optional timeout: number

    Returns AsyncGenerator<T, TReturn, TNext>

withWriteF

  • withWriteF<T>(f: (resources: [RWLockWriter]) => Promise<T>, timeout?: number): Promise<T>

withWriteG

  • withWriteG<T, TReturn, TNext>(g: (resources: [RWLockWriter]) => AsyncGenerator<T, TReturn, TNext>, timeout?: number): AsyncGenerator<T, TReturn, TNext>

  • Type parameters

    • T

    • TReturn

    • TNext

    Parameters

    • g: (resources: [RWLockWriter]) => AsyncGenerator<T, TReturn, TNext>
        • (resources: [RWLockWriter]): AsyncGenerator<T, TReturn, TNext>

        • Parameters

          Returns AsyncGenerator<T, TReturn, TNext>

    • Optional timeout: number

    Returns AsyncGenerator<T, TReturn, TNext>

write

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/errors.ErrorAsyncLocks.html b/docs/classes/errors.ErrorAsyncLocks.html new file mode 100644 index 0000000..2d29fb6 --- /dev/null +++ b/docs/classes/errors.ErrorAsyncLocks.html @@ -0,0 +1,6 @@ +ErrorAsyncLocks | @matrixai/async-locks
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ErrorAsyncLocks

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

data

data: POJO

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void
  • +

    Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/errors.ErrorAsyncLocksTimeout.html b/docs/classes/errors.ErrorAsyncLocksTimeout.html new file mode 100644 index 0000000..df11cf9 --- /dev/null +++ b/docs/classes/errors.ErrorAsyncLocksTimeout.html @@ -0,0 +1,6 @@ +ErrorAsyncLocksTimeout | @matrixai/async-locks
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ErrorAsyncLocksTimeout

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

data

data: POJO

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void
  • +

    Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index d2460fe..b38d7f7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -30,4 +30,4 @@

Publishing

# npm login
npm version patch # major/minor/patch
npm run build
npm publish --access public
git push
git push --tags
-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index 7ac2560..ff863a6 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1,3 @@ -@matrixai/async-locks
Options
All
  • Public
  • Public/Protected
  • All
Menu

@matrixai/async-locks

Index

Classes

Generated using TypeDoc

\ No newline at end of file +@matrixai/async-locks
Options
All
  • Public
  • Public/Protected
  • All
Menu

@matrixai/async-locks

Index

Namespaces

Classes

Type aliases

Type aliases

POJO

POJO: {}
+

Plain data dictionary

+

Type declaration

  • [key: string]: any

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/errors.html b/docs/modules/errors.html new file mode 100644 index 0000000..16cfd72 --- /dev/null +++ b/docs/modules/errors.html @@ -0,0 +1 @@ +errors | @matrixai/async-locks
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace errors

Index

Classes

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules/utils.html b/docs/modules/utils.html new file mode 100644 index 0000000..3222105 --- /dev/null +++ b/docs/modules/utils.html @@ -0,0 +1 @@ +utils | @matrixai/async-locks
Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace utils

Index

Functions

Functions

sleep

  • sleep(ms: number): Promise<void>

yieldMicro

  • yieldMicro(): Promise<void>

Generated using TypeDoc

\ No newline at end of file