Async

async.Async

ImplementsImplementsImplements

• IAsync

constructorconstructorconstructor

new Async(): Async

ReturnsReturnsReturns

Async

isDestructedisDestructedisDestructed

isDestructed: boolean = false

Defined inDefined inDefined in

src/core/async/async.ts#425

delaydelaydelay

delay(timeout): RejectablePromise<void>

ParametersParametersParameters

ReturnsReturnsReturns

RejectablePromise<void>

Implementation ofImplementation ofImplementation of

IAsync.delay

Defined inDefined inDefined in

src/core/async/async.ts#39

setTimeoutsetTimeoutsetTimeout

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

ParametersParametersParameters

ReturnsReturnsReturns

number

Implementation ofImplementation ofImplementation of

IAsync.setTimeout

Defined inDefined inDefined in

src/core/async/async.ts#43

updateTimeoutupdateTimeoutupdateTimeout

updateTimeout(label, timeout): Nullable<number>

ParametersParametersParameters

ReturnsReturnsReturns

Nullable<number>

Implementation ofImplementation ofImplementation of

IAsync.updateTimeout

Defined inDefined inDefined in

src/core/async/async.ts#76

clearTimeoutclearTimeoutclearTimeout

clearTimeout(timer): void

ParametersParametersParameters

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IAsync.clearTimeout

Defined inDefined inDefined in

src/core/async/async.ts#96

clearTimeout(label): void

ParametersParametersParameters

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IAsync.clearTimeout

Defined inDefined inDefined in

src/core/async/async.ts#97

debouncedebouncedebounce

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."

ParametersParametersParameters

ReturnsReturnsReturns

CallbackFunction<any>

Example

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

Implementation ofImplementation ofImplementation of

IAsync.debounce

Defined inDefined inDefined in

src/core/async/async.ts#120

microDebouncemicroDebouncemicroDebounce

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

Type parametersType parametersType parameters

ParametersParametersParameters

ReturnsReturnsReturns

T

Implementation ofImplementation ofImplementation of

IAsync.microDebounce

Defined inDefined inDefined in

src/core/async/async.ts#190

throttlethrottlethrottle

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."

ParametersParametersParameters

ReturnsReturnsReturns

CallbackFunction<any>

Example

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

Implementation ofImplementation ofImplementation of

IAsync.throttle

Defined inDefined inDefined in

src/core/async/async.ts#236

promisepromisepromise

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

Type parametersType parametersType parameters

ParametersParametersParameters

ReturnsReturnsReturns

RejectablePromise<T>

Implementation ofImplementation ofImplementation of

IAsync.promise

Defined inDefined inDefined in

src/core/async/async.ts#278

promiseStatepromiseStatepromiseState

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

Get Promise status

ParametersParametersParameters

ReturnsReturnsReturns

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

Implementation ofImplementation ofImplementation of

IAsync.promiseState

Defined inDefined inDefined in

src/core/async/async.ts#315

requestIdleCallbackrequestIdleCallbackrequestIdleCallback

requestIdleCallback(callback, options?): number

ParametersParametersParameters

ReturnsReturnsReturns

number

Implementation ofImplementation ofImplementation of

IAsync.requestIdleCallback

Defined inDefined inDefined in

src/core/async/async.ts#375

requestIdlePromiserequestIdlePromiserequestIdlePromise

requestIdlePromise(options?): RejectablePromise<number>

ParametersParametersParameters

ReturnsReturnsReturns

RejectablePromise<number>

Implementation ofImplementation ofImplementation of

IAsync.requestIdlePromise

Defined inDefined inDefined in

src/core/async/async.ts#384

cancelIdleCallbackcancelIdleCallbackcancelIdleCallback

cancelIdleCallback(request): void

ParametersParametersParameters

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IAsync.cancelIdleCallback

Defined inDefined inDefined in

src/core/async/async.ts#395

requestAnimationFramerequestAnimationFramerequestAnimationFrame

requestAnimationFrame(callback): number

Smart wrapper for requestAnimationFrame

ParametersParametersParameters

ReturnsReturnsReturns

number

Implementation ofImplementation ofImplementation of

IAsync.requestAnimationFrame

Defined inDefined inDefined in

src/core/async/async.ts#400

cancelAnimationFramecancelAnimationFramecancelAnimationFrame

cancelAnimationFrame(request): void

Smart wrapper for cancelAnimationFrame

ParametersParametersParameters

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IAsync.cancelAnimationFrame

Defined inDefined inDefined in

src/core/async/async.ts#406

clearclearclear

clear(): void

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

IAsync.clear

Defined inDefined inDefined in

src/core/async/async.ts#411

destructdestructdestruct

destruct(): any

ReturnsReturnsReturns

any

Implementation ofImplementation ofImplementation of

IAsync.destruct

Defined inDefined inDefined in

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