docs: update config example

worksome · Jun 20, 2024 · 16223d2 · 16223d2
1 parent 7479bdc
commit 16223d2
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -42,24 +42,48 @@ return [
                  * https://docs.launchdarkly.com/sdk/features/offline-mode
                  */
                 'offline' => env('LAUNCHDARKLY_OFFLINE', false)
-            ]
+            ],
+            /**
+             * @link https://docs.launchdarkly.com/home/account-security/api-access-tokens
+             */
+            'access-token' => env('FEATURE_FLAGS_API_ACCESS_TOKEN', null),
         ]
     ],
 
     /**
-     * Overrides all feature flags directly without hitting the provider.
-     * This is particularly useful for running things in the CI,
-     * e.g. Cypress tests.
+     * List of available overriders.
+     * Key is to be used to specify which overrider should be active.
      */
-    'override-all' => env('FEATURE_FLAGS_OVERRIDE_ALL'),
-
-    /**
-     * Override flags. If a feature flag is set inside an override,
-     * it will be used instead of the flag set in the provider.
-     *
-     * Usage: ['feature-flag-key' => true]
-     */
-    'overrides' => [],
+    'overriders' => [
+        'config' => [
+            /**
+             * Overrides all feature flags directly without hitting the provider.
+             * This is particularly useful for running things in the CI,
+             * e.g. Cypress tests.
+             *
+             * Be careful in setting a default value as said value will be applied to all flags.
+             * Use `null` value if needing the key to be present but act as if it was not
+             */
+            'override-all' => null,
+
+            /**
+             * Override flags. If a feature flag is set inside an override,
+             * it will be used instead of the flag set in the provider.
+             *
+             * Usage: ['feature-flag-key' => true]
+             *
+             * Be careful in setting a default value as it will be applied.
+             * Use `null` value if needing the key to be present but act as if it was not
+             *
+             */
+            'overrides' => [
+                // ...
+            ],
+        ],
+        'in-memory' => [
+            // ...
+        ]
+    ],
 ];
 ```
 

diff --git a/config/feature-flags.php b/config/feature-flags.php
@@ -36,8 +36,7 @@
 
     /**
      * List of available overriders.
-     * Key is to be used to specify which overrider should be active
-     *
+     * Key is to be used to specify which overrider should be active.
      */
     'overriders' => [
         'config' => [