processLock

Implements a global exclusive lock that works only in the current process. Useful for environments like React Native or other non-browser single-process (i.e. no concept of "tabs") environments.

Use {@link #navigatorLock} in browser environments.

@example

await processLock('migrate', 5000, async () => {
  await runMigration()
})

function processLock<R>(

name: string,

acquireTimeout: number,

fn: () => Promise<R>,

): Promise<R>;

processLock<R>(name: string, acquireTimeout: number, fn: () => Promise<R>): Promise<R>

[src]

§Type Parameters

[src]

§Parameters

name: string

[src]

Name of the lock to be acquired.

acquireTimeout: number

[src]

If negative, no timeout. If 0 an error is thrown if the lock can't be acquired without waiting. If positive, the lock acquire will time out after so many milliseconds. An error is a timeout if it has isAcquireTimeout set to true.

fn: () => Promise<R>

[src]

The operation to run once the lock is acquired.

§Return Type

Promise<R>

[src]