index.ts 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395
  1. export type AnyFunction = (...args: any[]) => any
  2. export type AnyAsyncFunction = (...args: any[]) => Promise<any>
  3. export type AnyClass = new (...args: any[]) => any
  4. export type PlainObject = Record<string | number | symbol, any>
  5. type TypeGuard<A, B extends A> = (payload: A) => payload is B
  6. /**
  7. * Returns the object type of the given payload
  8. *
  9. * @param {*} payload
  10. * @returns {string}
  11. */
  12. export function getType(payload: any): string {
  13. return Object.prototype.toString.call(payload).slice(8, -1)
  14. }
  15. /**
  16. * Returns whether the payload is undefined
  17. *
  18. * @param {*} payload
  19. * @returns {payload is undefined}
  20. */
  21. export function isUndefined(payload: any): payload is undefined {
  22. return getType(payload) === 'Undefined'
  23. }
  24. /**
  25. * Returns whether the payload is null
  26. *
  27. * @param {*} payload
  28. * @returns {payload is null}
  29. */
  30. export function isNull(payload: any): payload is null {
  31. return getType(payload) === 'Null'
  32. }
  33. /**
  34. * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
  35. *
  36. * @param {*} payload
  37. * @returns {payload is PlainObject}
  38. */
  39. export function isPlainObject(payload: any): payload is PlainObject {
  40. if (getType(payload) !== 'Object') return false
  41. return payload.constructor === Object && Object.getPrototypeOf(payload) === Object.prototype
  42. }
  43. /**
  44. * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
  45. *
  46. * @param {*} payload
  47. * @returns {payload is PlainObject}
  48. */
  49. export function isObject(payload: any): payload is PlainObject {
  50. return isPlainObject(payload)
  51. }
  52. /**
  53. * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
  54. *
  55. * @param {*} payload
  56. * @returns {payload is { [K in any]: never }}
  57. */
  58. export function isEmptyObject(payload: any): payload is { [K in any]: never } {
  59. return isPlainObject(payload) && Object.keys(payload).length === 0
  60. }
  61. /**
  62. * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
  63. *
  64. * @param {*} payload
  65. * @returns {payload is PlainObject}
  66. */
  67. export function isFullObject(payload: any): payload is PlainObject {
  68. return isPlainObject(payload) && Object.keys(payload).length > 0
  69. }
  70. /**
  71. * Returns whether the payload is an any kind of object (including special classes or objects with different prototypes)
  72. *
  73. * @param {*} payload
  74. * @returns {payload is PlainObject}
  75. */
  76. export function isAnyObject(payload: any): payload is PlainObject {
  77. return getType(payload) === 'Object'
  78. }
  79. /**
  80. * Returns whether the payload is an object like a type passed in < >
  81. *
  82. * Usage: isObjectLike<{id: any}>(payload) // will make sure it's an object and has an `id` prop.
  83. *
  84. * @template T this must be passed in < >
  85. * @param {*} payload
  86. * @returns {payload is T}
  87. */
  88. export function isObjectLike<T extends PlainObject>(payload: any): payload is T {
  89. return isAnyObject(payload)
  90. }
  91. /**
  92. * Returns whether the payload is a function (regular or async)
  93. *
  94. * @param {*} payload
  95. * @returns {payload is AnyFunction}
  96. */
  97. export function isFunction(payload: any): payload is AnyFunction {
  98. return typeof payload === 'function'
  99. }
  100. /**
  101. * Returns whether the payload is an array
  102. *
  103. * @param {any} payload
  104. * @returns {payload is any[]}
  105. */
  106. export function isArray(payload: any): payload is any[] {
  107. return getType(payload) === 'Array'
  108. }
  109. /**
  110. * Returns whether the payload is a an array with at least 1 item
  111. *
  112. * @param {*} payload
  113. * @returns {payload is any[]}
  114. */
  115. export function isFullArray(payload: any): payload is any[] {
  116. return isArray(payload) && payload.length > 0
  117. }
  118. /**
  119. * Returns whether the payload is a an empty array
  120. *
  121. * @param {*} payload
  122. * @returns {payload is []}
  123. */
  124. export function isEmptyArray(payload: any): payload is [] {
  125. return isArray(payload) && payload.length === 0
  126. }
  127. /**
  128. * Returns whether the payload is a string
  129. *
  130. * @param {*} payload
  131. * @returns {payload is string}
  132. */
  133. export function isString(payload: any): payload is string {
  134. return getType(payload) === 'String'
  135. }
  136. /**
  137. * Returns whether the payload is a string, BUT returns false for ''
  138. *
  139. * @param {*} payload
  140. * @returns {payload is string}
  141. */
  142. export function isFullString(payload: any): payload is string {
  143. return isString(payload) && payload !== ''
  144. }
  145. /**
  146. * Returns whether the payload is ''
  147. *
  148. * @param {*} payload
  149. * @returns {payload is string}
  150. */
  151. export function isEmptyString(payload: any): payload is string {
  152. return payload === ''
  153. }
  154. /**
  155. * Returns whether the payload is a number (but not NaN)
  156. *
  157. * This will return `false` for `NaN`!!
  158. *
  159. * @param {*} payload
  160. * @returns {payload is number}
  161. */
  162. export function isNumber(payload: any): payload is number {
  163. return getType(payload) === 'Number' && !isNaN(payload)
  164. }
  165. /**
  166. * Returns whether the payload is a boolean
  167. *
  168. * @param {*} payload
  169. * @returns {payload is boolean}
  170. */
  171. export function isBoolean(payload: any): payload is boolean {
  172. return getType(payload) === 'Boolean'
  173. }
  174. /**
  175. * Returns whether the payload is a regular expression (RegExp)
  176. *
  177. * @param {*} payload
  178. * @returns {payload is RegExp}
  179. */
  180. export function isRegExp(payload: any): payload is RegExp {
  181. return getType(payload) === 'RegExp'
  182. }
  183. /**
  184. * Returns whether the payload is a Map
  185. *
  186. * @param {*} payload
  187. * @returns {payload is Map<any, any>}
  188. */
  189. export function isMap(payload: any): payload is Map<any, any> {
  190. return getType(payload) === 'Map'
  191. }
  192. /**
  193. * Returns whether the payload is a WeakMap
  194. *
  195. * @param {*} payload
  196. * @returns {payload is WeakMap<any, any>}
  197. */
  198. export function isWeakMap(payload: any): payload is WeakMap<any, any> {
  199. return getType(payload) === 'WeakMap'
  200. }
  201. /**
  202. * Returns whether the payload is a Set
  203. *
  204. * @param {*} payload
  205. * @returns {payload is Set<any>}
  206. */
  207. export function isSet(payload: any): payload is Set<any> {
  208. return getType(payload) === 'Set'
  209. }
  210. /**
  211. * Returns whether the payload is a WeakSet
  212. *
  213. * @param {*} payload
  214. * @returns {payload is WeakSet<any>}
  215. */
  216. export function isWeakSet(payload: any): payload is WeakSet<any> {
  217. return getType(payload) === 'WeakSet'
  218. }
  219. /**
  220. * Returns whether the payload is a Symbol
  221. *
  222. * @param {*} payload
  223. * @returns {payload is symbol}
  224. */
  225. export function isSymbol(payload: any): payload is symbol {
  226. return getType(payload) === 'Symbol'
  227. }
  228. /**
  229. * Returns whether the payload is a Date, and that the date is valid
  230. *
  231. * @param {*} payload
  232. * @returns {payload is Date}
  233. */
  234. export function isDate(payload: any): payload is Date {
  235. return getType(payload) === 'Date' && !isNaN(payload)
  236. }
  237. /**
  238. * Returns whether the payload is a Blob
  239. *
  240. * @param {*} payload
  241. * @returns {payload is Blob}
  242. */
  243. export function isBlob(payload: any): payload is Blob {
  244. return getType(payload) === 'Blob'
  245. }
  246. /**
  247. * Returns whether the payload is a File
  248. *
  249. * @param {*} payload
  250. * @returns {payload is File}
  251. */
  252. export function isFile(payload: any): payload is File {
  253. return getType(payload) === 'File'
  254. }
  255. /**
  256. * Returns whether the payload is a Promise
  257. *
  258. * @param {*} payload
  259. * @returns {payload is Promise<any>}
  260. */
  261. export function isPromise(payload: any): payload is Promise<any> {
  262. return getType(payload) === 'Promise'
  263. }
  264. /**
  265. * Returns whether the payload is an Error
  266. *
  267. * @param {*} payload
  268. * @returns {payload is Error}
  269. */
  270. export function isError(payload: any): payload is Error {
  271. return getType(payload) === 'Error'
  272. }
  273. /**
  274. * Returns whether the payload is literally the value `NaN` (it's `NaN` and also a `number`)
  275. *
  276. * @param {*} payload
  277. * @returns {payload is typeof NaN}
  278. */
  279. export function isNaNValue(payload: any): payload is typeof NaN {
  280. return getType(payload) === 'Number' && isNaN(payload)
  281. }
  282. /**
  283. * Returns whether the payload is a primitive type (eg. Boolean | Null | Undefined | Number | String | Symbol)
  284. *
  285. * @param {*} payload
  286. * @returns {(payload is boolean | null | undefined | number | string | symbol)}
  287. */
  288. export function isPrimitive(
  289. payload: any
  290. ): payload is boolean | null | undefined | number | string | symbol {
  291. return (
  292. isBoolean(payload) ||
  293. isNull(payload) ||
  294. isUndefined(payload) ||
  295. isNumber(payload) ||
  296. isString(payload) ||
  297. isSymbol(payload)
  298. )
  299. }
  300. /**
  301. * Returns true whether the payload is null or undefined
  302. *
  303. * @param {*} payload
  304. * @returns {(payload is null | undefined)}
  305. */
  306. export const isNullOrUndefined = isOneOf(isNull, isUndefined)
  307. export function isOneOf<A, B extends A, C extends A>(
  308. a: TypeGuard<A, B>,
  309. b: TypeGuard<A, C>
  310. ): TypeGuard<A, B | C>
  311. export function isOneOf<A, B extends A, C extends A, D extends A>(
  312. a: TypeGuard<A, B>,
  313. b: TypeGuard<A, C>,
  314. c: TypeGuard<A, D>
  315. ): TypeGuard<A, B | C | D>
  316. export function isOneOf<A, B extends A, C extends A, D extends A, E extends A>(
  317. a: TypeGuard<A, B>,
  318. b: TypeGuard<A, C>,
  319. c: TypeGuard<A, D>,
  320. d: TypeGuard<A, E>
  321. ): TypeGuard<A, B | C | D | E>
  322. export function isOneOf<A, B extends A, C extends A, D extends A, E extends A, F extends A>(
  323. a: TypeGuard<A, B>,
  324. b: TypeGuard<A, C>,
  325. c: TypeGuard<A, D>,
  326. d: TypeGuard<A, E>,
  327. e: TypeGuard<A, F>
  328. ): TypeGuard<A, B | C | D | E | F>
  329. export function isOneOf(
  330. a: AnyFunction,
  331. b: AnyFunction,
  332. c?: AnyFunction,
  333. d?: AnyFunction,
  334. e?: AnyFunction
  335. ): (value: unknown) => boolean {
  336. return (value) =>
  337. a(value) || b(value) || (!!c && c(value)) || (!!d && d(value)) || (!!e && e(value))
  338. }
  339. /**
  340. * Does a generic check to check that the given payload is of a given type.
  341. * In cases like Number, it will return true for NaN as NaN is a Number (thanks javascript!);
  342. * It will, however, differentiate between object and null
  343. *
  344. * @template T
  345. * @param {*} payload
  346. * @param {T} type
  347. * @throws {TypeError} Will throw type error if type is an invalid type
  348. * @returns {payload is T}
  349. */
  350. export function isType<T extends AnyFunction | AnyClass>(payload: any, type: T): payload is T {
  351. if (!(type instanceof Function)) {
  352. throw new TypeError('Type must be a function')
  353. }
  354. if (!Object.prototype.hasOwnProperty.call(type, 'prototype')) {
  355. throw new TypeError('Type is not a class')
  356. }
  357. // Classes usually have names (as functions usually have names)
  358. const name: string | undefined | null = (type as any).name
  359. return getType(payload) === name || Boolean(payload && payload.constructor === type)
  360. }