helpers/index.d.ts at main · formidablejs/helpers · 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
import HelpersServiceResolver from "./types/HelpersServiceResolver";
import Response from "@formidablejs/framework/types/Http/Response/Response";
import ViewResponse from "@formidablejs/framework/types/Http/Response/ViewResponse";

declare global {
  /**
   * Convert custom object into a js object.
   */
  function asObject(object: any): Object;

  /**
   * Get a config value using dot notation.
   */
  function config(notation: String, default$?: any): any;

  /**
   * Decrypt an encrypted string.
   */
  function decrypt(hash: String, unserialize?: Boolean): any;

  /**
   * Use dot notation to get a value from an object.
   * @alias dot
   */
  function dotNotation(object: Object, key: String): any;

  /**
   * Use dot notation to get a value from an object.
   */
  function dot(object: Object, key: String): any;

  /**
   * Encrypt a value.
   */
  function encrypt(value: any, serialize?: Boolean): String;

  /**
   * Get a value from the environment variables.
   */
  function env(key: String, default$?: any): any;

  /**
   * Create expiration date for Redis.
   */
  function expiresIn(time: String): String;

  /**
   * Check if an object is an Array.
   */
  function isArray(object: any): Boolean;

  /**
   * Check if an object is a Boolean.
   */
  function isBoolean(object: any): Boolean;

  /**
   * Check if an object is a Class.
   */
  function isClass(object: any): Boolean;

  /**
   * Check if an object is empty.
   */
  function isEmpty(value: any): Boolean;

  /**
   * Check if an object is a Function.
   */
  function isFunction(object: any): Boolean;

  /**
   * Check if a value is an Integer.
   */
  function isNumber(object: any): Boolean;

  /**
   * Check if an object is an Object.
   */
  function isObject(object: any): Boolean;

  /**
   * Check if an object is a String.
   */
  function isString(object: any): Boolean;

  /**
   * Get current timestamp.
   */
  function now(): String;

  /**
   * Return a response object.
   */
  function response(data?: Object, statusCode?: number): Response;

  /**
   * Convert string into a slug.
   */
  function slug(value: String, separator?: String): String;

  /**
   * Generate a random string.
   */
  function strRandom(length?: number): String;

  /**
   * Convert value into a Boolean.
   */
  function toBoolean(value: any): Boolean;

  /**
   * Application version.
   */
  function version(): String;

  /**
   * Return view response.
   */
  function view(view: Function, data?: Object | null): ViewResponse;

  /**
   * Check if a string matches the supplied pattern.
   */
  function wildcard(value: String, match: String): Boolean;

  /**
   * Return an object without specific keys.
   */
  function without(object: Object, exclude: String[]): Object;
}

export {
  HelpersServiceResolver
}