better error handling and make tsc happy

Author: gaurishhs

README.md

@@ -2,9 +2,10 @@
 
 ![badge](https://github.com/gaurishhs/elysia-ip/actions/workflows/npm-publish.yml/badge.svg)
 
-Get the Client Ip Address in Elysia.
+Get the client ip address in Elysia.
+It works with Bun, Cloudflare, Fastly and other runtimes.
 
-It supports Cloudflare, Fastly and other runtimes as well.
+Please consider starring the repository to show your ❤️ and support.
 
 ## Installation
 
@@ -18,9 +19,7 @@ bun a elysia-ip
 
 ### Introduction
 
-This plugin let's you get client's ip address in Elysia.js
-
-It supports Multiple runtimes (Cloudflare, Fastly Edge, etc.)
+This plugin adds a `ip` property to the context object. It contains the client ip address.
 
 ### Usage
 
@@ -33,6 +32,8 @@ new Elysia().use(ip()).get("/", ({ ip }) => ip).listen(3000);
 
 ### How does it work?
 
+For Bun runtime, We use `server.requestIP` introduced in Bun v1.0.4 to get the client ip address and early return it.
+
 It relies on headers for runtimes other than Bun. 
 Cloudflare and other providers send back specific headers, containing the IP address. For example `CF-Connecting-IP` for Cloudflare and `Fastly-Client-IP` for Fastly.
 
@@ -54,7 +55,7 @@ Priority list:
 12. `true-client-ip` (Akamai and Cloudflare)
 13. `cf-pseudo-ipv4` (Cloudflare)
 
-You can even specify your own header or list of headers if you want to as following
+You can even specify your own headers if you want to as following
 
 ```ts
 import { Elysia } from "elysia";
@@ -72,9 +73,6 @@ import { ip } from "elysia-ip";
 new Elysia().use(ip({ checkHeaders: "X-Forwarded-For" })).get("/", ({ ip }) => ip).listen(3000);
 ```
 
-For Bun runtime, We use `server.requestIP` introduced in Bun v1.0.4
-
-
 ## License
 MIT
 

package.json

@@ -27,7 +27,7 @@
     "ip"
   ],
   "scripts": {
-    "build": "tsc --project tsconfig.esm.json",
+    "build": "tsc",
     "lint": "eslint . --ext .ts"
   },
   "license": "MIT",

src/index.ts

@@ -16,7 +16,7 @@ export const headersToCheck: IPHeaders[] = [
     'cf-pseudo-ipv4', // Cloudflare 
 ]
 
-const getIP = (headers: Headers, checkHeaders: IPHeaders[] = headersToCheck) => {
+export const getIP = (headers: Headers, checkHeaders: IPHeaders[] = headersToCheck) => {
     if (typeof checkHeaders === 'string' && headers.get(checkHeaders)) return headers.get(checkHeaders)
     // X-Forwarded-For is the de-facto standard header
     if (headers.get('x-forwarded-for')) return headers.get('x-forwarded-for')?.split(',')[0]
@@ -30,12 +30,19 @@ const getIP = (headers: Headers, checkHeaders: IPHeaders[] = headersToCheck) =>
 }
 
 export const ip = (config: {
+    /**
+     * Customize headers to check for IP address
+     * @default ['x-real-ip', 'x-client-ip', 'cf-connecting-ip', 'fastly-client-ip', 'x-cluster-client-ip', 'x-forwarded', 'forwarded-for', 'forwarded', 'x-forwarded', 'appengine-user-ip', 'true-client-ip', 'cf-pseudo-ipv4']
+     */
     checkHeaders?: IPHeaders[]
 } = {}) => (app: Elysia) => {
     return app.derive(({ request }) => {
-        if (globalThis.Bun) return {
-            ip: app.server!.requestIP(request)
-        } 
+        if (globalThis.Bun) {
+            if (!app.server) throw new Error(`Elysia server is not initialized. Make sure to call Elyisa.listen()`)
+            return {
+                ip: app.server.requestIP(request)
+            }
+        }
         const clientIP = getIP(request.headers, config.checkHeaders)
         return {
             ip: clientIP