appconfig-toggles - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "appconfig-toggles",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Make better use of Azure App Configuration with Node",
@@ -5,0 +5,0 @@ "main": "build/src/index.js",

README.md

@@ -31,3 +31,4 @@ # appconfig-toggles (ACT): a helper for Azure App Configuration toggles
   await act.init();
-  console.log(act.canUseToggle("SomeToggle"))
+  console.log(act.canUseToggle("SomeToggle"));
+  console.log(act.getToggleDescription("SomeToggle"));
 }
@@ -38,4 +39,18 @@
 
+## Available methods
+
+### `canUseToggle()`
+
+Check if a toggle is active. This check verifies group access, rollout for this group, and whether the toggle exists at all.
+
+Example: `act.canUseToggle("SomeToggle")`
+
+### `getToggleDescription()`
+
+Get the description for a named toggled. Good if you, for example, would want that to contain data an application can act on.
+
+Example: `act.getToggleDescription("SomeToggle")`
+
 ## Install
 
 Install ACT with `npm install appconfig-toggles -S` or `yarn add appconfig-toggles -S`.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

33276

increased by1.45%

Number of lines in readme file

55

increased by37.5%

No dependency changes