# @types/hark

> TypeScript definitions for hark

Latest version **1.2.5** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/hark
pnpm add @types/hark
yarn add @types/hark
bun add @types/hark
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.2.5 |
| Published | 2023-11-07 |
| First published | 2019-09-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51439 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/hark
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hark
- npm.io page: https://npm.io/package/@types/hark

## Recent versions

- 1.2.5 (latest) — 2023-11-07
- 1.2.2 (ts3.6) — 2021-07-08
- 1.2.1 (ts3.2) — 2020-10-19
- 1.2.0 (ts2.3) — 2019-09-25
- 1.2.4 — 2023-10-18
- 1.2.3 — 2023-09-16

## README

# Installation
> `npm install --save @types/hark`

# Summary
This package contains type definitions for hark (https://github.com/otalk/hark).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hark.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hark/index.d.ts)
````ts
export = hark;

declare function hark(stream: HTMLAudioElement | HTMLVideoElement | MediaStream, option?: hark.Option): hark.Harker;

declare namespace hark {
    interface Option {
        smoothing?: number | undefined;
        interval?: number | undefined;
        threshold?: number | undefined;
        play?: boolean | undefined;
        history?: number | undefined;
        audioContext?: AudioContext | undefined;
    }

    interface Harker {
        speaking: boolean;
        suspend(): Promise<void>;
        resume(): Promise<void>;
        readonly state: AudioContextState;
        setThreshold(t: number): void;
        setInterval(i: number): void;
        stop(): void;
        speakingHistory: number[];

        on(event: "speaking" | "stopped_speaking", listener: () => void): void;
        on(event: "volume_change", listener: (currentVolume: number, threshold: number) => void): void;
        on(event: "state_change", listener: (state: AudioContextState) => void): void;
    }
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: none

# Credits
These definitions were written by [baiyufei](https://github.com/baiyufei).

---
_Source: https://npm.io/package/@types/hark · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._