asNumeric()

README.md

@@ -39,6 +39,7 @@ composer require std-library/type-guard
 ## Usage
 
 - [`as`](#as)
+- [`asNumeric()`](#asnumeric)
 - [`asInt()`](#asint)
 - [`asFloat()`](#asfloat)
 - [`asString()`](#asstring)
@@ -52,6 +53,14 @@ Asserts and narrows down the type of the given variable to a more specific type.
 $variable = type($variable)->as(User::class);
 ```
 
+### `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.

src/Type.php

@@ -56,6 +56,20 @@ public function asString(): string
         return $this->variable;
     }
 
+    /**
+     * Asserts and narrow down the type to numeric.
+     *
+     * @phpstan-assert-if-true int|float|numeric-string $this->variable
+     */
+    public function asNumeric(): int|float|string
+    {
+        if (! is_numeric($this->variable)) {
+            throw new TypeError('Variable is not a numeric.');
+        }
+
+        return $this->variable;
+    }
+
     /**
      * Asserts and narrow down the type to integer.
      *

tests/AsNumericTest.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+test('numeric type', function ($variable): void {
+    $value = type($variable)->asNumeric();
+
+    expect($value)->toBeNumeric();
+})->with([
+    7415541,
+    7415.541,
+    '7415541',
+    0b01100110,
+    0x66,
+]);
+
+test('not numeric type', function (): void {
+    $variable = 'string';
+
+    type($variable)->asNumeric();
+})->with([
+    '',
+    'not numeric',
+    null,
+    [],
+])->throws(TypeError::class, 'Variable is not a numeric.');

types/AsNumericTest.php

@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+use function PHPStan\Testing\assertType;
+
+$variable = random_int(0, 1) !== 0 ? '7415541' : 'not numeric';
+assertType('float|int|string', type($variable)->asNumeric());