vanilla-commons/index.d.ts at master · gugutz/vanilla-commons · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
declare module 'vanilla-commons' {
  export = commons;
}

declare namespace commons {
  interface DateDiff {
    milliseconds: number;
    seconds: number;
    minutes: number;
    hours: number;
    days: number;
    weeks: number;
    months: number;
    years: number;
  }

  function flattenArray(arr: any[][]): any[];

  function addDays(days: number): (date: Date) => Date;
  function addDays(days: number, date: Date): Date;

  function addHours(hours: number): (date: Date) => Date;
  function addHours(hours: number, date: Date): Date;

  function addMilliseconds(milliseconds: number): (date: Date) => Date;
  function addMilliseconds(milliseconds: number, date: Date): Date;

  function addMinutes(minutes: number): (date: Date) => Date;
  function addMinutes(minutes: number, date: Date): Date;

  function addMonths(months: number): (date: Date) => Date;
  function addMonths(months: number, date: Date): Date;

  function addSeconds(seconds: number): (date: Date) => Date;
  function addSeconds(seconds: number, date: Date): Date;

  function addWeeks(weeks: number): (date: Date) => Date;
  function addWeeks(weeks: number, date: Date): Date;

  function addYears(years: number): (date: Date) => Date;
  function addYears(years: number, date: Date): Date;

  function diffDate(firstDate: Date): (secondDate: Date) => DateDiff;
  function diffDate(firstDate: Date, secondDate: Date): DateDiff;

  function formatDate(format: string): (date: Date) => String;
  function formatDate(format: string, date: Date): string;

  function isValidDate(format: string): (dateStr: string) => boolean;
  function isValidDate(format: string, dateStr: string): boolean;

  function parseDate(format: string): (dateStr: string) => Date;
  function parseDate(format: string, dateStr: string): Date;

  function addClass(newClass: string | string[], element: HTMLElement): HTMLElement;
  function addClass(newClass: string | string[]): (element: HTMLElement) => HTMLElement;

  function clearEvents(element: HTMLElement): HTMLElement;

  function createElement(selector?: string, children?: any[]): HTMLElement;
  function createElement(selector?: string, props?: any, children?: any[]): HTMLElement;

  function getParents(element: HTMLElement): HTMLElement[];

  function hasClass(classToCheck: string | string[]): (element: HTMLElement) => boolean;
  function hasClass(classToCheck: string | string[], element: HTMLElement): boolean;

  function hideElement(elementToHide: HTMLElement | HTMLElement[]): HTMLElement | HTMLElement[];


  function insertElementAfter(referenceElement: HTMLElement): (newElement: HTMLElement) => HTMLElement;
  function insertElementAfter(referenceElement: HTMLElement, newElement: HTMLElement): HTMLElement;

  function insertElementBefore(referenceElement: HTMLElement): (newElement: HTMLElement) => HTMLElement;
  function insertElementBefore(referenceElement: HTMLElement, newElement: HTMLElement): HTMLElement;

  function killElement(elementToKill: HTMLElement | HTMLElement[]): void;

  function removeClass(classToRemove: string | string[]): (element: HTMLElement) => HTMLElement;
  function removeClass(classToRemove: string | string[], element: HTMLElement): HTMLElement;

  function replaceElement(originalElement: HTMLElement): (newElement: HTMLElement) => HTMLElement;
  function replaceElement(originalElement: HTMLElement, newElement: HTMLElement): HTMLElement;

  function showElement(elementToShow: HTMLElement | HTMLElement[]): HTMLElement | HTMLElement[];

  function toggleClass(classToToggle: string | string[]):  (element: HTMLElement) => HTMLElement;
  function toggleClass(classToToggle: string | string[], element: HTMLElement): HTMLElement;

  function compose(...fns: Function[]): Function;

  function curry(fn: Function): Function;

  function pipe(...fns: Function[]): Function;

  function throttle(limit: number, fn: Function): Function;

  function round(num: number): number;

  function mapKeys(fn: (key: any) => any, obj: any): any;

  function mapValues(fn: (value: any) => any, obj: any): any;

  function capitalize(str: string): string;

  function cleanUpString(str: string): string;
}