# @types/arrive

> TypeScript definitions for arrive

Latest version **2.4.4** (published 2023-11-06) · MIT license · 0 weekly downloads

## Install

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

## 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 | 2.4.4 |
| Published | 2023-11-06 |
| First published | 2020-11-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51419 |
| Maintainers | types |

## Links

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

## Recent versions

- 2.4.4 (latest) — 2023-11-06
- 2.4.1 (ts3.6) — 2021-07-07
- 2.4.0 (ts3.2) — 2020-11-11
- 2.4.3 — 2023-10-17
- 2.4.2 — 2023-09-22

## README

# Installation
> `npm install --save @types/arrive`

# Summary
This package contains type definitions for arrive (https://github.com/uzairfarooq/arrive).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/arrive.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/arrive/index.d.ts)
````ts
// required for declare global to work
export {};

interface Options {
    fireOnAttributesModification?: boolean | undefined;
    onceOnly?: boolean | undefined;
    existing?: boolean | undefined;
}

type ArriveSignature = (
    element: string,
    handlerOrOptions: ((this: Element, element: Element) => void) | Options,
    handler?: (this: Element, element: Element) => void,
) => void;
type UnbindArriveSignature = (
    elementOrHandler?: string | ((this: Element, element: Element) => void),
    handler?: (this: Element, element: Element) => void,
) => void;
type LeaveSignature = (
    element: string,
    handlerOrOptions: ((this: Element, element: Element) => void) | Options,
    handler?: (this: Element) => void,
) => void;
type UnbindLeaveSignature = (
    elementOrHandler?: string | ((this: Element, element: Element) => void),
    handler?: (this: Element, element: Element) => void,
) => void;

declare global {
    // tslint:disable-next-line no-unnecessary-class
    class Arrive {
        static unbindAllArrive: () => void;
        static unbindAllLeave: () => void;
    }

    interface Document {
        arrive: ArriveSignature;
        unbindArrive: UnbindArriveSignature;
        leave: LeaveSignature;
        unbindLeave: UnbindLeaveSignature;
    }

    interface JQuery {
        arrive: ArriveSignature;
        unbindArrive: UnbindArriveSignature;
        leave: LeaveSignature;
        unbindLeave: UnbindLeaveSignature;
    }

    interface Window {
        arrive: ArriveSignature;
        unbindArrive: UnbindArriveSignature;
        leave: LeaveSignature;
        unbindLeave: UnbindLeaveSignature;
    }

    interface NodeList {
        arrive: ArriveSignature;
        unbindArrive: UnbindArriveSignature;
        leave: LeaveSignature;
        unbindLeave: UnbindLeaveSignature;
    }

    interface Element {
        arrive: ArriveSignature;
        unbindArrive: UnbindArriveSignature;
        leave: LeaveSignature;
        unbindLeave: UnbindLeaveSignature;
    }

    interface HTMLCollectionBase {
        arrive: ArriveSignature;
        unbindArrive: UnbindArriveSignature;
        leave: LeaveSignature;
        unbindLeave: UnbindLeaveSignature;
    }
}

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:04 GMT
 * Dependencies: none

# Credits
These definitions were written by [Vijay Pemmaraju](https://github.com/vijaypemmaraju).

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