documentation

pinkary-project · Mar 30, 2024 · f71b291 · f71b291
1 parent cd86cbc
commit f71b291
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -36,9 +36,18 @@ composer require std-library/type-guard
 
 ## Usage
 
+- [`asNumeric()`](#asnumeric)
 - [`asInt()`](#asint)
 - [`asString()`](#asstring)
 
+### `asNumeric()`
+
+Asserts and narrows down the type of the given variable to a numeric.
+
+```php
+$variable = type($variable)->asNumeric();
+```
+
 ### `asInt()`
 
 Asserts and narrows down the type of the given variable to an integer.