lockMutex | WebHare Platform SDK

Function lockMutex

Lock the requested mutex

The name of the mutex to lock

timeout optional timeout in milliseconds. If not specified, the mutex will be waited for indefinitely

A locked mutex, or null if locking failed due to a timeout

lockMutex(name: string): Promise<Mutex>
Parameters
- name: string
Returns Promise<Mutex>
- Defined in jssdk/services/src/mutex.ts:90
lockMutex(
name: string,
options: { __skipNameCheck?: boolean; timeout: WaitPeriod },
): Promise<null | Mutex>
Parameters
- name: string
- options: { __skipNameCheck?: boolean; timeout: WaitPeriod }
Returns Promise<null | Mutex>
- Defined in jssdk/services/src/mutex.ts:91
lockMutex(name: string, options: { __skipNameCheck?: boolean }): Promise<Mutex>
Parameters
- name: string
- options: { __skipNameCheck?: boolean }
Returns Promise<Mutex>
- Defined in jssdk/services/src/mutex.ts:92