@blackglory/wait-for/README.md

A module for waiting for things to happen.

# 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<void>
```

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

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

### waitForElementsMatchingSelectorAttached
```ts
function waitForElementsMatchingSelectorAttached(
  selector: string
): Promise<Element[]>
```

### waitForAllElementsMatchingSelectorDetached
```ts
function waitForAllElementsMatchingSelectorDetached(
  selector: string
): Promise<void>
```

### waitForEventTarget
```ts
function waitForEventTarget<T extends EventTarget>(
  target: T
, event: string
, signal?: AbortSignal
): Promise<Event>
```

### waitForEventEmitter
```ts
function waitForEventEmitter<T extends EventEmitter>(
  target: T
, event: string
, signal?: AbortSignal
): Promise<unknown[]>
```

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

### waitForDOMContentLoaded
```ts
function waitForDOMContentLoaded(): Promise<void>
```

### waitForLoad
```ts
function waitForLoad(): Promise<void>
```

### waitForComplete
```ts
function waitForComplete(): Promise<void>
```

### waitForInteractiveOrComplete
```ts
function waitForInteractiveOrComplete(): Promise<void>
```

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

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

### waitForSchedule
```ts
function waitForSchedule(timestamp: number, signal?: AbortSignal): Promise<void>
```

### waitForStateChanged
```ts
function waitForStateChanged(): Promise<void>
```

### waitForUrlChanged
```ts
function waitForUrlChanged(): Promise<void>
```

### waitForAllMacrotasksProcessed
```ts
function waitForAllMacrotasksProcessed(): Promise<void>
```

### waitForAllMicrotasksProcessed
```ts
function waitForAllMicrotasksProcessed(): Promise<void>
```

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

### waitForAnimationFrame
```ts
function waitForAnimationFrame(): Promise<DOMHighResTimeStamp>
```

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