From ff2985a03766a462d4b6b2d1138575d7ae61f35d Mon Sep 17 00:00:00 2001 From: raldone01 Date: Fri, 8 Apr 2022 13:11:44 +0200 Subject: [PATCH] Update docs --- index.html | 12 +- libs/idb-mutex/docs/classes/IDBMutex.html | 4 +- libs/idb-mutex/docs/index.html | 51 +++++-- libs/ts-mutex/docs/classes/FakeMutex.html | 2 +- .../docs/classes/MutexFactoryProxy.html | 2 +- libs/ts-mutex/docs/classes/MutexProxy.html | 4 +- .../ts-mutex/docs/classes/NavigatorMutex.html | 4 +- libs/ts-mutex/docs/classes/RAMMutex.html | 4 +- libs/ts-mutex/docs/index.html | 125 +++++++++++++----- libs/ts-mutex/docs/interfaces/Mutex.html | 4 +- .../docs/interfaces/MutexFactory.html | 2 +- libs/ts-mutex/docs/modules.html | 2 +- 12 files changed, 156 insertions(+), 60 deletions(-) diff --git a/index.html b/index.html index 3848595..84f5400 100644 --- a/index.html +++ b/index.html @@ -19,7 +19,15 @@ - ts-mutex docs - idb-mutex docs +

Documentations

+

Libs

+ diff --git a/libs/idb-mutex/docs/classes/IDBMutex.html b/libs/idb-mutex/docs/classes/IDBMutex.html index 60b2860..e5eb1bd 100644 --- a/libs/idb-mutex/docs/classes/IDBMutex.html +++ b/libs/idb-mutex/docs/classes/IDBMutex.html @@ -1,3 +1,3 @@ -IDBMutex | @ink-feather-org/idb-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IDBMutex

Hierarchy

  • IDBMutex

Implements

  • Mutex

Index

Constructors

Methods

Constructors

constructor

  • new IDBMutex(db: IDBPDatabase<unknown>, storeName: string, identifier: string): IDBMutex
  • +IDBMutex | @ink-feather-org/idb-mutex
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Class IDBMutex

    Hierarchy

    • IDBMutex

    Implements

    • Mutex

    Index

    Constructors

    Methods

    Constructors

    constructor

    • new IDBMutex(db: IDBPDatabase<unknown>, storeName: string, identifier: string): IDBMutex

    • This expects the store to already exist.

      -

      Parameters

      • db: IDBPDatabase<unknown>
      • storeName: string
      • identifier: string

      Returns IDBMutex

    Methods

    has

    • has(): Promise<boolean>

    • Returns Promise<boolean>

    lock

    • lock(): Promise<boolean>

    • Returns Promise<boolean>

    release

    • release(force?: boolean): Promise<void>

    • Parameters

      • Optional force: boolean

      Returns Promise<void>

    Static factory

    • factory(db: IDBPDatabase<unknown>, storeName: string, identifier: string): MutexFactory<IDBMutex>

    • Parameters

      • db: IDBPDatabase<unknown>
      • storeName: string
      • identifier: string

      Returns MutexFactory<IDBMutex>

    Legend

    • Constructor
    • Method
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • db: IDBPDatabase<unknown>
    • storeName: string
    • identifier: string

    Returns IDBMutex

Methods

has

  • has(): Promise<boolean>

  • Returns Promise<boolean>

lock

  • lock(): Promise<boolean>

  • Returns Promise<boolean>

release

  • release(force?: boolean): Promise<void>

  • Parameters

    • Optional force: boolean

    Returns Promise<void>

Static factory

  • factory(db: IDBPDatabase<unknown>, storeName: string, identifier: string): MutexFactory<IDBMutex>

  • Parameters

    • db: IDBPDatabase<unknown>
    • storeName: string
    • identifier: string

    Returns MutexFactory<IDBMutex>

Generated using TypeDoc

\ No newline at end of file diff --git a/libs/idb-mutex/docs/index.html b/libs/idb-mutex/docs/index.html index 22bba89..94ed8c0 100644 --- a/libs/idb-mutex/docs/index.html +++ b/libs/idb-mutex/docs/index.html @@ -1,18 +1,41 @@ -@ink-feather-org/idb-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

@ink-feather-org/idb-mutex

= @ink-feather-org/idb-mutex -:icons: -:y: ✅ -:n: ❌

-

https://ink-feather-org.github.io/ts-mutex/[Typedoc]

+@ink-feather-org/idb-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

@ink-feather-org/idb-mutex

+
+
+

Typedoc

+
+

This repository provides an IDB-Mutex. See the @ink-feather-org/ts-mutex package different implementations with differing guarantees.

-

[cols="1,1,1"] -|=== -|Name |SameTab |Webworkers

-

|IDBMutex -|{y} -|{y} (probably) -|===

-

== IDBMutex

+
+ +++++ + + + + + + + + + + + + + + +
NameSameTabWebworkers

IDBMutex

✅

✅ (probably)

+
+
+
+

IDBMutex

+
+

The IDBMutex uses IndexedDb for its locking mechanism. It has external dependencies so its available as a standalone package @ink-feather-org/idb-mutex.

-

Legend

  • Constructor
  • Method
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +
+
+

Generated using TypeDoc

\ No newline at end of file diff --git a/libs/ts-mutex/docs/classes/FakeMutex.html b/libs/ts-mutex/docs/classes/FakeMutex.html index 74f34f9..43c9b61 100644 --- a/libs/ts-mutex/docs/classes/FakeMutex.html +++ b/libs/ts-mutex/docs/classes/FakeMutex.html @@ -1 +1 @@ -FakeMutex | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FakeMutex

Hierarchy

  • FakeMutex

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

has

  • has(): Promise<boolean>

lock

  • lock(): Promise<boolean>

release

  • release(force?: boolean): Promise<void>

Static factory

Generated using TypeDoc

\ No newline at end of file +FakeMutex | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FakeMutex

Hierarchy

  • FakeMutex

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

has

  • has(): Promise<boolean>

lock

  • lock(): Promise<boolean>

release

  • release(force?: boolean): Promise<void>

Static factory

Generated using TypeDoc

\ No newline at end of file diff --git a/libs/ts-mutex/docs/classes/MutexFactoryProxy.html b/libs/ts-mutex/docs/classes/MutexFactoryProxy.html index cb621f2..02cd5a4 100644 --- a/libs/ts-mutex/docs/classes/MutexFactoryProxy.html +++ b/libs/ts-mutex/docs/classes/MutexFactoryProxy.html @@ -1 +1 @@ -MutexFactoryProxy | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MutexFactoryProxy<RET>

Type parameters

Hierarchy

  • MutexFactoryProxy

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

createMutex

  • createMutex(): RET

Generated using TypeDoc

\ No newline at end of file +MutexFactoryProxy | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MutexFactoryProxy<RET>

Type parameters

Hierarchy

  • MutexFactoryProxy

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

createMutex

  • createMutex(): RET

Generated using TypeDoc

\ No newline at end of file diff --git a/libs/ts-mutex/docs/classes/MutexProxy.html b/libs/ts-mutex/docs/classes/MutexProxy.html index b03353f..a28f486 100644 --- a/libs/ts-mutex/docs/classes/MutexProxy.html +++ b/libs/ts-mutex/docs/classes/MutexProxy.html @@ -1,2 +1,2 @@ -MutexProxy | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MutexProxy

Hierarchy

  • MutexProxy

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

has

  • has(): Promise<boolean>

lock

  • lock(): Promise<boolean>

release

  • release(force?: boolean): Promise<void>

Generated using TypeDoc

\ No newline at end of file +MutexProxy | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MutexProxy

Hierarchy

  • MutexProxy

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

has

  • has(): Promise<boolean>

lock

  • lock(): Promise<boolean>

release

  • release(force?: boolean): Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/libs/ts-mutex/docs/classes/NavigatorMutex.html b/libs/ts-mutex/docs/classes/NavigatorMutex.html index 187de7d..81ec65c 100644 --- a/libs/ts-mutex/docs/classes/NavigatorMutex.html +++ b/libs/ts-mutex/docs/classes/NavigatorMutex.html @@ -1,2 +1,2 @@ -NavigatorMutex | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NavigatorMutex

Hierarchy

  • NavigatorMutex

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

has

  • has(): Promise<boolean>

lock

  • lock(): Promise<boolean>

release

  • release(force?: boolean): Promise<void>

Static available

  • available(): boolean

Static factory

Generated using TypeDoc

\ No newline at end of file +NavigatorMutex | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NavigatorMutex

Hierarchy

  • NavigatorMutex

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

has

  • has(): Promise<boolean>

lock

  • lock(): Promise<boolean>

release

  • release(force?: boolean): Promise<void>

Static available

  • available(): boolean

Static factory

Generated using TypeDoc

\ No newline at end of file diff --git a/libs/ts-mutex/docs/classes/RAMMutex.html b/libs/ts-mutex/docs/classes/RAMMutex.html index 14ad926..17f9a06 100644 --- a/libs/ts-mutex/docs/classes/RAMMutex.html +++ b/libs/ts-mutex/docs/classes/RAMMutex.html @@ -1,2 +1,2 @@ -RAMMutex | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RAMMutex

Hierarchy

  • RAMMutex

Implements

Index

Constructors

Methods

Constructors

constructor

  • new RAMMutex(identifier: string): RAMMutex

Methods

has

  • has(): Promise<boolean>

lock

  • lock(): Promise<boolean>

release

  • release(force?: boolean): Promise<void>

Static factory

Generated using TypeDoc

\ No newline at end of file +RAMMutex | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RAMMutex

Hierarchy

  • RAMMutex

Implements

Index

Constructors

Methods

Constructors

constructor

  • new RAMMutex(identifier: string): RAMMutex

Methods

has

  • has(): Promise<boolean>

lock

  • lock(): Promise<boolean>

release

  • release(force?: boolean): Promise<void>

Static factory

Generated using TypeDoc

\ No newline at end of file diff --git a/libs/ts-mutex/docs/index.html b/libs/ts-mutex/docs/index.html index 5d1c15f..e2251d2 100644 --- a/libs/ts-mutex/docs/index.html +++ b/libs/ts-mutex/docs/index.html @@ -1,39 +1,104 @@ -@ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

@ink-feather-org/ts-mutex

= @ink-feather-org/ts-mutex -:icons: -:y: ✅ -:n: ❌

-

https://ink-feather-org.github.io/ts-mutex/[Typedoc]

+@ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

@ink-feather-org/ts-mutex

+
+
+

Typedoc

+
+

This repository contains typescript mutex implementations that provide different guarantees.

-

== Mutex

+
+
+
+
+

Mutex

+
+

The Mutex interface. Provides locking/unlocking functions.

-

[cols="1,1,1"] -|=== -|Name |SameTab |Webworkers

-

|FakeMutex -|{n} -|{n} -|NavigatorMutex -|{y} -|? -|RAMMutex -|{y} -|{n} -|IDBMutex -|{y} -|{y} (probably) -|===

-

== FakeMutex

+
+ +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameSameTabWebworkers

FakeMutex

❌

❌

NavigatorMutex

✅

?

RAMMutex

✅

❌

IDBMutex

✅

✅ (probably)

+
+
+
+

FakeMutex

+
+

A Mutex implementation that provides NO guarantees.

-

== NavigatorMutex

-

A Mutex implementation that uses https://developer.mozilla.org/en-US/docs/Web/API/Navigator[the navigator api]. +

+
+
+
+

NavigatorMutex

+
+
+

A Mutex implementation that uses the navigator api. May not be available on all browsers.

-

== RAMMutex

+
+
+
+
+

RAMMutex

+
+

The RAMMutex stores its locks in static Map.

-

== IDBMutex

+
+
+
+
+

IDBMutex

+
+

The IDBMutex uses IndexedDb for its locking mechanism. It has external dependencies so its available as a standalone package @ink-feather-org/idb-mutex.

-

== MutexProxy

+
+
+
+
+

MutexProxy

+
+

Wraps a mutex implementation.

-

== MutexFactory & MutexFactoryProxy

+
+
+
+
+

MutexFactory & MutexFactoryProxy

+
+

Factory classes for mutex implementations.

-

Legend

  • Constructor
  • Method
  • Method
  • Static method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file +
+
+

Generated using TypeDoc

\ No newline at end of file diff --git a/libs/ts-mutex/docs/interfaces/Mutex.html b/libs/ts-mutex/docs/interfaces/Mutex.html index f413ee6..eeb46a5 100644 --- a/libs/ts-mutex/docs/interfaces/Mutex.html +++ b/libs/ts-mutex/docs/interfaces/Mutex.html @@ -1,2 +1,2 @@ -Mutex | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Mutex

Hierarchy

  • Mutex

Implemented by

Index

Methods

Methods

has

  • has(): Promise<boolean>

lock

  • lock(): Promise<boolean>

  • Returns Promise<boolean>

    true if this was the last holder

    -

release

  • release(force?: boolean): Promise<void>

  • Parameters

    • Optional force: boolean

    Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file +Mutex | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Mutex

Hierarchy

  • Mutex

Implemented by

Index

Methods

Methods

has

  • has(): Promise<boolean>

lock

  • lock(): Promise<boolean>

  • Returns Promise<boolean>

    true if this was the last holder

    +

release

  • release(force?: boolean): Promise<void>

  • Parameters

    • Optional force: boolean

    Returns Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/libs/ts-mutex/docs/interfaces/MutexFactory.html b/libs/ts-mutex/docs/interfaces/MutexFactory.html index f4b0d36..c5a56e5 100644 --- a/libs/ts-mutex/docs/interfaces/MutexFactory.html +++ b/libs/ts-mutex/docs/interfaces/MutexFactory.html @@ -1 +1 @@ -MutexFactory | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutexFactory<RET>

Type parameters

Hierarchy

  • MutexFactory

Implemented by

Index

Methods

Methods

createMutex

  • createMutex(): RET

Generated using TypeDoc

\ No newline at end of file +MutexFactory | @ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MutexFactory<RET>

Type parameters

Hierarchy

  • MutexFactory

Implemented by

Index

Methods

Methods

createMutex

  • createMutex(): RET

Generated using TypeDoc

\ No newline at end of file diff --git a/libs/ts-mutex/docs/modules.html b/libs/ts-mutex/docs/modules.html index 5671cf9..826eb95 100644 --- a/libs/ts-mutex/docs/modules.html +++ b/libs/ts-mutex/docs/modules.html @@ -1 +1 @@ -@ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

@ink-feather-org/ts-mutex

Index

Classes

Interfaces

Type aliases

Type aliases

MutexCreator

MutexCreator<ARGS, RET>: (...args: ARGS) => RET

Type parameters

Type declaration

    • (...args: ARGS): RET

    • Parameters

      • Rest ...args: ARGS

      Returns RET

Generated using TypeDoc

\ No newline at end of file +@ink-feather-org/ts-mutex
Options
All
  • Public
  • Public/Protected
  • All
Menu

@ink-feather-org/ts-mutex

Index

Classes

Interfaces

Type aliases

Type aliases

MutexCreator

MutexCreator<ARGS, RET>: (...args: ARGS) => RET

Type parameters

Type declaration

    • (...args: ARGS): RET

    • Parameters

      • Rest ...args: ARGS

      Returns RET

Generated using TypeDoc

\ No newline at end of file