documentation

pinkary-project · Mar 30, 2024 · 62facef · 62facef
1 parent 57a718b
commit 62facef
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -37,6 +37,7 @@ composer require std-library/type-guard
 ## Usage
 
 - [`asInt()`](#asint)
+- [`asFloat()`](#asfloat)
 - [`asString()`](#asstring)
 
 ### `asInt()`
@@ -47,6 +48,14 @@ Asserts and narrows down the type of the given variable to an integer.
 $variable = type($variable)->asInt();
 ```
 
+### `asFloat()`
+
+Asserts and narrows down the type of the given variable to a float.
+
+```php
+$variable = type($variable)->asFloat();
+```
+
 ### `asString()`
 
 Asserts and narrows down the type of the given variable to an string.