Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
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;
}
}
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"version": "2.5.2",
"description": "arrive.js provides events to watch for DOM elements creation and removal. It makes use of Mutation Observers internally.",
"main": "src/arrive.js",
"types": "index.d.ts",
"directories": {
"test": "tests"
},
Expand Down