Skip to content

RunWithTimeoutParams<Result>

Options for runWithTimeout.

Import:

import type { RunWithTimeoutParams } from 'obsidian-dev-utils/async';

Signature:

export interface RunWithTimeoutParams<Result>

Properties

PropertyTypeDescription
context?unknownThe context of the function.
operationName?stringThe name of the operation.
stackTrace?string | undefinedThe stack trace of the source function.
timeoutInMillisecondsnumberThe maximum time to wait in milliseconds.

Methods

MethodReturnsDescription
onTimeout(this, context)voidThe function to handle the timeout.
operationFn(this, abortSignal)Promisable<Result>The operation function to execute.

Links to this page: