Type Alias IDatabaseReaderSemaphoreTransaction

Type declaration

• findSemaphore:function

  • findSemaphore(key: string): Promise<null | IReaderSemaphoreData>

  • The findSemaphore returns the semaphore if it exists otherwise null is returned.

    Parameters

    • key: string

    Returns Promise<null | IReaderSemaphoreData>

• findSlots:function

  • findSlots(key: string): Promise<IReaderSemaphoreSlotData[]>

  • The findSlots returns the semaphore slot if it exists otherwise null is returned.

    Parameters

    • key: string

    Returns Promise<IReaderSemaphoreSlotData[]>

• removeAllSlots:function

  • removeAllSlots(key: string): Promise<IReaderSemaphoreSlotExpirationData[]>

  • The removeAllSlots removes all slots of the given semaphore.

    Parameters

    • key: string

    Returns Promise<IReaderSemaphoreSlotExpirationData[]>

    Returns the slot expiration.

• removeSlot:function

  • removeSlot(
        key: string,
        slotId: string,
    ): Promise<null | IReaderSemaphoreSlotExpirationData>

  • The removeSlot removes the specified slot.

    Parameters

    • key: string
    • slotId: string

    Returns Promise<null | IReaderSemaphoreSlotExpirationData>

    Returns the slot expiration.

• updateExpiration:function

  • updateExpiration(key: string, slotId: string, expiration: Date): Promise<number>

  • The updateExpiration updates the specified slot expiration as long as it is expireable and unexpired of the given semaphore.

    Parameters

    • key: string
    • slotId: string
    • expiration: Date

    Returns Promise<number>

    Returns a number greater than 0 if the slot expiration was updated, otherwise returns 0.

• upsertSemaphore:function

  • upsertSemaphore(key: string, limit: number): Promise<void>

  • The upsertSemaphore inserts a semaphore if it doesnt exist otherwise it will be updated.

    Parameters

    • key: string
    • limit: number

    Returns Promise<void>

• upsertSlot:function

  • upsertSlot(key: string, lockId: string, expiration: null | Date): Promise<void>

  • The upsertSlot inserts a semaphore slot if it doesnt exist otherwise it will be updated.

    Parameters

    • key: string
    • lockId: string
    • expiration: null | Date

    Returns Promise<void>