Fix JSDoc placements

src/compact/compact.ts

@@ -1,3 +1,5 @@
+type Falsy = undefined | null | false | 0 | ''
+
 /**
  * ### compact(array)
  *
@@ -9,8 +11,6 @@
  * ```
  */
 
-type Falsy = undefined | null | false | 0 | ''
-
 export function compact<T>(array: Array<T | Falsy>): Array<T> {
   return array.filter(Boolean) as Array<T>
 }

src/escapeRegExp/escapeRegExp.ts

@@ -9,8 +9,6 @@
  * ```
  */
 
-// The implementation of this function is taken from MDN:
-// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
 export function escapeRegExp(string: string): string {
   return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
 }

src/get/get.ts

@@ -1,6 +1,9 @@
 /* eslint-disable @typescript-eslint/ban-types */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
+const REPLACE_EMPTY_REGEX = /]|^\[/g
+const REPLACE_DOT_REGEX = /\.?\[/g
+
 /**
  * ### get(object, path, defaultValue?)
  *
@@ -25,9 +28,6 @@
  * ```
  */
 
-const REPLACE_EMPTY_REGEX = /]|^\[/g
-const REPLACE_DOT_REGEX = /\.?\[/g
-
 export function get(
   object: object | null | undefined,
   path: string | Array<string | number>,

src/memoize/memoize.ts

@@ -1,5 +1,15 @@
 import { TAnyFunction } from '../typeHelpers'
 
+interface MemoizeOptions {
+  strategy?: MemoizeStrategy
+  serializer?: MemoizeSerializer
+  ttl?: number
+}
+
+type MemoizeStrategy = 'monadic' | 'variadic'
+
+type MemoizeSerializer = (data: unknown) => string
+
 /**
  * ### memoize(func, options?)
  *
@@ -21,16 +31,6 @@ import { TAnyFunction } from '../typeHelpers'
  * </details>
  */
 
-interface MemoizeOptions {
-  strategy?: MemoizeStrategy
-  serializer?: MemoizeSerializer
-  ttl?: number
-}
-
-type MemoizeStrategy = 'monadic' | 'variadic'
-
-type MemoizeSerializer = (data: unknown) => string
-
 export function memoize<TThis, TReturn, TFunc extends TAnyFunction<TReturn>>(
   this: TThis,
   func: TFunc,

src/omit/omit.ts

@@ -1,5 +1,7 @@
 /* eslint-disable @typescript-eslint/ban-types */
 
+type Omit<T, K> = Pick<T, Exclude<keyof T, K>>
+
 /**
  * ### omit(object, keys)
  *
@@ -12,8 +14,6 @@
  * ```
  */
 
-type Omit<T, K> = Pick<T, Exclude<keyof T, K>>
-
 export function omit<T extends object, K extends keyof T>(object: T, keys: Array<K>): Omit<T, K> {
   const objectKeys = Object.keys(object) as Array<keyof T>
 

src/promisePool/promisePool.ts

@@ -1,3 +1,5 @@
+type PromiseFunction<T> = () => Promise<T>
+
 /**
  * ### promisePool(promiseFunctions, limit)
  *
@@ -14,8 +16,6 @@
  * ```
  */
 
-type PromiseFunction<T> = () => Promise<T>
-
 export async function promisePool<T>(
   promiseFunctions: Array<PromiseFunction<T>>,
   limit: number

src/randomString/randomString.ts

@@ -1,3 +1,5 @@
+const CHARACTERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
+
 /**
  * ### randomString(length)
  *
@@ -9,8 +11,6 @@
  * ```
  */
 
-const CHARACTERS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
-
 export function randomString(length: number): string {
   let string = ''
 

src/toMap/toMap.ts

@@ -1,5 +1,12 @@
 /* eslint-disable @typescript-eslint/ban-types */
 
+// Return all keys of an object that have value types we can use as a map key
+type MappableKeys<T> = NonNullable<
+  {
+    [K in keyof T]: T[K] extends string | number | undefined ? K : never
+  }[keyof T]
+>
+
 /**
  * ### toMap(array, key, target?)
  *
@@ -33,13 +40,6 @@
  * ```
  */
 
-// Return all keys of an object that have value types we can use as a map key
-type MappableKeys<T> = NonNullable<
-  {
-    [K in keyof T]: T[K] extends string | number | undefined ? K : never
-  }[keyof T]
->
-
 export function toMap<Element extends object, Key extends MappableKeys<Element>>(
   array: Array<Element>,
   key: Key