Interface LockOpenListItem<T, Error>

interface LockOpenListItem<T, Error = string> {
    index: number;
    lockCount: number;
    lockers: readonly NamedLocker[];
    mapKey: string;
    openCount: number;
    openers: readonly NamedLocker[];
    closeLocked(opener: NamedLocker): void;
    equals(other: T): boolean;
    isLocked(ignoreOnlyLocker: undefined | NamedLocker): boolean;
    openLocked(opener: NamedLocker): void;
    tryLock(locker: NamedLocker): Promise<Result<void, Error>>;
    unlock(locker: NamedLocker): void;
}

Type Parameters

T
Error = string

Hierarchy (View Summary)

Mappable
IndexedRecord
- LockOpenListItem

Index

Properties

index lockCount lockers mapKey openCount openers

Methods

closeLocked equals isLocked openLocked tryLock unlock

Properties

index

index: number

`Readonly`lockCount

lockCount: number

`Readonly`lockers

lockers: readonly NamedLocker[]

`Readonly`mapKey

mapKey: string

`Readonly`openCount

openCount: number

`Readonly`openers

openers: readonly NamedLocker[]

Methods

closeLocked

closeLocked(opener: NamedLocker): void
Parameters
- opener: NamedLocker
Returns void

equals

equals(other: T): boolean
Parameters
- other: T
Returns boolean

isLocked

isLocked(ignoreOnlyLocker: undefined | NamedLocker): boolean
Parameters
- ignoreOnlyLocker: undefined | NamedLocker
Returns boolean

openLocked

openLocked(opener: NamedLocker): void
Parameters
- opener: NamedLocker
Returns void

tryLock

tryLock(locker: NamedLocker): Promise<Result<void, Error>>
Parameters
- locker: NamedLocker
Returns Promise<Result<void, Error>>

unlock

unlock(locker: NamedLocker): void
Parameters
- locker: NamedLocker
Returns void