Async

async.Async

ImplementsImplements

• IAsync

constructorconstructor

new Async(): Async

ReturnsReturns

Async

isDestructedisDestructed

isDestructed: boolean = false

Defined inDefined in

src/core/async/async.ts#492

delaydelay

delay(timeout): RejectablePromise<void>

ParametersParameters

ReturnsReturns

RejectablePromise<void>

Implementation ofImplementation of

IAsync.delay

Defined inDefined in

src/core/async/async.ts#39

setTimeoutsetTimeout

setTimeout(callback, timeout, ...args): number

ParametersParameters

ReturnsReturns

number

Implementation ofImplementation of

IAsync.setTimeout

Defined inDefined in

src/core/async/async.ts#43

updateTimeoutupdateTimeout

updateTimeout(label, timeout): Nullable<number>

ParametersParameters

ReturnsReturns

Nullable<number>

Implementation ofImplementation of

IAsync.updateTimeout

Defined inDefined in

src/core/async/async.ts#76

clearTimeoutclearTimeout

clearTimeout(timer): void

ParametersParameters

ReturnsReturns

void

Implementation ofImplementation of

IAsync.clearTimeout

Defined inDefined in

src/core/async/async.ts#96

clearTimeout(label): void

ParametersParameters

ReturnsReturns

void

Implementation ofImplementation of

IAsync.clearTimeout

Defined inDefined in

src/core/async/async.ts#97

debouncedebounce

debounce(fn, timeout, firstCallImmediately?): CallbackFunction<any>

Debouncing enforces that a function not be called again until a certain amount of time has passed without
it being called. As in "execute this function only if 100 milliseconds have passed without it being called."

ParametersParameters

ReturnsReturns

CallbackFunction<any>

Example

var jodit = Jodit.make('.editor');
jodit.e.on('mousemove', jodit.async.debounce(() => {
  // Do expensive things
}, 100));

Implementation ofImplementation of

IAsync.debounce

Defined inDefined in

src/core/async/async.ts#120

microDebouncemicroDebounce

microDebounce<T>(fn, firstCallImmediately?): T

Type parametersType parameters

ParametersParameters

ReturnsReturns

T

Implementation ofImplementation of

IAsync.microDebounce

Defined inDefined in

src/core/async/async.ts#190

throttlethrottle

throttle(fn, timeout, ignore?): CallbackFunction<any>

Throttling enforces a maximum number of times a function can be called over time.
As in "execute this function at most once every 100 milliseconds."

ParametersParameters

ReturnsReturns

CallbackFunction<any>

Example

var jodit = Jodit.make('.editor');
jodit.e.on(document.body, 'scroll', jodit.async.throttle(function() {
  // Do expensive things
}, 100));

Implementation ofImplementation of

IAsync.throttle

Defined inDefined in

src/core/async/async.ts#236

promisepromise

promise<T>(executor): RejectablePromise<T>

Type parametersType parameters

ParametersParameters

ReturnsReturns

RejectablePromise<T>

Implementation ofImplementation of

IAsync.promise

Defined inDefined in

src/core/async/async.ts#278

promiseStatepromiseState

promiseState(p): Promise<"pending" | "fulfilled" | "rejected">

Get Promise status

ParametersParameters

ReturnsReturns

Promise<"pending" | "fulfilled" | "rejected">

Implementation ofImplementation of

IAsync.promiseState

Defined inDefined in

src/core/async/async.ts#315

requestIdleCallbackrequestIdleCallback

requestIdleCallback(callback, options?): number

ParametersParameters

ReturnsReturns

number

Implementation ofImplementation of

IAsync.requestIdleCallback

Defined inDefined in

src/core/async/async.ts#376

requestIdlePromiserequestIdlePromise

requestIdlePromise(options?): RejectablePromise<number>

ParametersParameters

ReturnsReturns

RejectablePromise<number>

Implementation ofImplementation of

IAsync.requestIdlePromise

Defined inDefined in

src/core/async/async.ts#385

schedulerPostTaskschedulerPostTask

schedulerPostTask<T>(task, options?): Promise<T>

Try to use scheduler.postTask if it is available https://wicg.github.io/scheduling-apis/

Type parametersType parameters

ParametersParameters

ReturnsReturns

Promise<T>

Implementation ofImplementation of

IAsync.schedulerPostTask

Defined inDefined in

src/core/async/async.ts#399

schedulerYieldschedulerYield

schedulerYield(): Promise<void>

ReturnsReturns

Promise<void>

Implementation ofImplementation of

IAsync.schedulerYield

Defined inDefined in

src/core/async/async.ts#456

cancelIdleCallbackcancelIdleCallback

cancelIdleCallback(request): void

ParametersParameters

ReturnsReturns

void

Implementation ofImplementation of

IAsync.cancelIdleCallback

Defined inDefined in

src/core/async/async.ts#460

requestAnimationFramerequestAnimationFrame

requestAnimationFrame(callback): number

Smart wrapper for requestAnimationFrame

ParametersParameters

ReturnsReturns

number

Implementation ofImplementation of

IAsync.requestAnimationFrame

Defined inDefined in

src/core/async/async.ts#465

cancelAnimationFramecancelAnimationFrame

cancelAnimationFrame(request): void

Smart wrapper for cancelAnimationFrame

ParametersParameters

ReturnsReturns

void

Implementation ofImplementation of

IAsync.cancelAnimationFrame

Defined inDefined in

src/core/async/async.ts#471

clearclear

clear(): void

ReturnsReturns

void

Implementation ofImplementation of

IAsync.clear

Defined inDefined in

src/core/async/async.ts#476

destructdestruct

destruct(): any

ReturnsReturns

any

Implementation ofImplementation of

IAsync.destruct

Defined inDefined in

jodit/src/core/async/async.ts:494