@replanejs/sdk 0.7.6 → 0.8.0

package/README.md

@@ -1,5 +1,9 @@
 # Replane JavaScript SDK
 
+[![npm](https://img.shields.io/npm/v/@replanejs/sdk)](https://www.npmjs.com/package/@replanejs/sdk)
+[![License](https://img.shields.io/github/license/replane-dev/replane-javascript)](https://github.com/replane-dev/replane-javascript/blob/main/LICENSE)
+[![Community](https://img.shields.io/badge/discussions-join-blue?logo=github)](https://github.com/orgs/replane-dev/discussions)
+
 Small TypeScript client for watching configuration values from a Replane API with realtime updates and context-based override evaluation.
 
 Part of the Replane project: [replane-dev/replane](https://github.com/replane-dev/replane).
@@ -114,13 +118,15 @@ Parameters:
 - `name` (K extends keyof T) – config name to fetch. TypeScript will enforce that this is a valid config name from your `Configs` interface.
 - `options` (object) – optional configuration:
   - `context` (object) – context merged with client-level context for override evaluation.
+  - `default` (T[K]) – default value to return if the config is not found. When provided, the method will not throw.
 
 Returns the config value of type `T[K]` (synchronous). The return type is automatically inferred from your `Configs` interface.
 
 Notes:
 
 - The Replane client receives realtime updates via SSE in the background.
-- If the config is not found, throws a `ReplaneError` with code `not_found`.
+- If the config is not found and no default is provided, throws a `ReplaneError` with code `not_found`.
+- If the config is not found and a default is provided, returns the default value without throwing.
 - Context-based overrides are evaluated automatically based on context.
 
 Example:
@@ -144,6 +150,9 @@ const userEnabled = replane.get("billing-enabled", {
   context: { userId: "user-123", plan: "premium" },
 });
 
+// Get value with default - won't throw if config doesn't exist
+const maxConnections = replane.get("max-connections", { default: 10 });
+
 // Clean up when done
 replane.close();
 ```
@@ -469,12 +478,10 @@ unsubscribeMaxUsers();
 replane.close();
 ```
 
-## Roadmap
+## Community
 
-- Config caching
-- Config invalidation
+Have questions or want to discuss Replane? Join the conversation in [GitHub Discussions](https://github.com/orgs/replane-dev/discussions).
 
 ## License
 
 MIT
-