An open API service indexing awesome lists of open source software.

https://github.com/blackglory/wait-for

🌲 A module for waiting for things to happen.
https://github.com/blackglory/wait-for

browser esm library npm-package typescript

Last synced: 11 months ago
JSON representation

🌲 A module for waiting for things to happen.

Awesome Lists containing this project

README

          

# wait-for
A module for waiting for things to happen.

## Install
```sh
npm install --save @blackglory/wait-for
# or
yarn add @blackglory/wait-for
```

## API
### waitForDOMChanged
```ts
function waitForDOMChanged(): Promies
```

### waitForAttached
```ts
function waitForAttached(...nodes: Node[]): Promise
```

### waitForDetached
```ts
function waitForDetached(...nodes: Node[]): Promise
```

### waitForElementsMatchingSelectorAttached
```ts
function waitForElementsMatchingSelectorAttached(
selector: string
): Promise
```

### waitForAllElementsMatchingSelectorDetached
```ts
function waitForAllElementsMatchingSelectorDetached(
selector: string
): Promise
```

### waitForEventTarget
```ts
function waitForEventTarget(
target: T
, event: string
, signal?: AbortSignal
): Promise
```

### waitForEventEmitter
```ts
function waitForEventEmitter(
target: T
, event: string
, signal?: AbortSignal
): Promise
```

### waitForEmitter
```ts
function waitForEmitter<
EventToArgs extends Record
, Event extends keyof EventToArgs
>(
target: Emitter
, event: Event
, signal?: AbortSignal
): Promise
```

### waitForDOMContentLoaded
```ts
function waitForDOMContentLoaded(): Promise
```

### waitForLoad
```ts
function waitForLoad(): Promise
```

### waitForComplete
```ts
function waitForComplete(): Promise
```

### waitForInteractiveOrComplete
```ts
function waitForInteractiveOrComplete(): Promise
```

### waitForFunction
```ts
function waitForFunction(
fn: () => T | PromiseLike
, interval: number = 0
): Promise
```

### waitForTimeout
```ts
function waitForTimeout(ms: number, signal?: AbortSignal): Promise
```

### waitForStateChanged
```ts
function waitForStateChanged(): Promise
```

### waitForUrlChanged
```ts
function waitForUrlChanged(): Promise
```

### waitForAllMacrotasksProcessed
```ts
function waitForAllMacrotasksProcessed(): Promise
```

### waitForAllMicrotasksProcessed
```ts
function waitForAllMicrotasksProcessed(): Promise
```

### waitForIdleCallback
```ts
function waitForIdleCallback(options?: IdleRequestOptions): Promise
```

### waitForAnimationFrame
```ts
function waitForAnimationFrame(): Promise
```

### waitForVideoFrameCallback
```ts
function waitForVideoFrameCallback(
video: HTMLVideoElement
): Promise>
```