Interface PathLockRegistry

interface PathLockRegistry {
    add(lock: PathLock): PathLock;
    clear(): void;
    list(): readonly PathLock[];
    matches(path: string, principal: Principal): PathLock | null;
    remove(lock: PathLock): boolean;
}

Index

Methods

add clear list matches remove

Methods

add

add(lock: PathLock): PathLock
Add a lock. Returns the lock for the caller to keep a reference to.
Parameters
- lock: PathLock
Returns PathLock

clear

clear(): void

Drop every lock.

Returns void

list

list(): readonly PathLock[]

Snapshot of currently-active locks.

Returns readonly PathLock[]

matches

matches(path: string, principal: Principal): PathLock | null
Returns the matching lock if path is locked AND principal is not exempt.
Parameters
- path: string
- principal: Principal
Returns PathLock | null

remove

remove(lock: PathLock): boolean
Remove a previously-added lock.
Parameters
- lock: PathLock
Returns boolean