Merge pull request #29 from trieb-work/fix-readme

Fix: allign all config options to be camelcase (`redis_url` becomes `redisUrl`) + fix: readme test startup

Author: tilman

README.md

@@ -1,4 +1,5 @@
 # nextjs-turbo-redis-cache
+
 [![npm version](https://img.shields.io/npm/v/@trieb.work/nextjs-turbo-redis-cache.svg)](https://www.npmjs.com/package/@trieb.work/nextjs-turbo-redis-cache)
 ![Turbo redis cache image](https://github.com/user-attachments/assets/98e0dfd9-f38a-42ad-a355-9843740cc2d6)
 
@@ -118,7 +119,7 @@ A working example of above can be found in the `test/integration/next-app-custom
 
 | Option                 | Description                                                                                                       | Default Value                                                                                                                                                 |
 | ---------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| redis_url              | Redis connection url                                                                                              | `process.env.REDIS_URL? process.env.REDIS_URL : process.env.REDISHOST ? redis://${process.env.REDISHOST}:${process.env.REDISPORT} : 'redis://localhost:6379'` |
+| redisUrl               | Redis connection url                                                                                              | `process.env.REDIS_URL? process.env.REDIS_URL : process.env.REDISHOST ? redis://${process.env.REDISHOST}:${process.env.REDISPORT} : 'redis://localhost:6379'` |
 | database               | Redis database number to use. Uses DB 0 for production, DB 1 otherwise                                            | `process.env.VERCEL_ENV === 'production' ? 0 : 1`                                                                                                             |
 | keyPrefix              | Prefix added to all Redis keys                                                                                    | `process.env.VERCEL_URL    \|\| 'UNDEFINED_URL_'`                                                                                                             |
 | sharedTagsKey          | Key used to store shared tags hash map in Redis                                                                   | `'__sharedTags__'`                                                                                                                                            |
@@ -171,28 +172,26 @@ By accepting and tolerating this eventual consistency, the performance of the ca
 
 ## Testing
 
-Run `pnpm run-dev-server` to start the nextjs integration test project.
-
-To run all tests you can use the following command in a second terminal:
+To run all tests you can use the following command:
 
 ```bash
-pnpm test
+pnpm build && pnpm test
 ```
 
 ### Unit tests
 
 To run unit tests you can use the following command:
 
 ```bash
-pnpm test:unit
+pnpm build && pnpm test:unit
 ```
 
 ### Integration tests
 
 To run integration tests you can use the following command:
 
 ```bash
-pnpm test:integration
+pnpm build && pnpm test:integration
 ```
 
 The integration tests will start a Next.js server and test the caching handler. You can modify testing behavior by setting the following environment variables:

src/RedisStringsHandler.ts

@@ -14,12 +14,12 @@ export type CacheEntry = {
 };
 
 export type CreateRedisStringsHandlerOptions = {
-  /** Redis redis_url to use.
+  /** Redis redisUrl to use.
    * @default process.env.REDIS_URL? process.env.REDIS_URL : process.env.REDISHOST
           ? `redis://${process.env.REDISHOST}:${process.env.REDISPORT}`
           : 'redis://localhost:6379'
    */
-  redis_url?: string;
+  redisUrl?: string;
   /** Redis database number to use. Uses DB 0 for production, DB 1 otherwise
    * @default process.env.VERCEL_ENV === 'production' ? 0 : 1
    */
@@ -97,7 +97,7 @@ export default class RedisStringsHandler {
   private estimateExpireAge: (staleAge: number) => number;
 
   constructor({
-    redis_url = process.env.REDIS_URL
+    redisUrl = process.env.REDIS_URL
       ? process.env.REDIS_URL
       : process.env.REDISHOST
         ? `redis://${process.env.REDISHOST}:${process.env.REDISPORT}`
@@ -124,7 +124,7 @@ export default class RedisStringsHandler {
     try {
       this.client = createClient({
         ...(database !== 0 ? { database } : {}),
-        url: redis_url,
+        url: redisUrl,
       });
 
       this.client.on('error', (error) => {