[TypeInfo] Fix outdated README

mtarld · mtarld · commit 9afd7fbcc4f3 · 2024-12-09T16:32:42.000+01:00
diff --git a/src/Symfony/Component/TypeInfo/README.md b/src/Symfony/Component/TypeInfo/README.md
@@ -3,11 +3,6 @@ TypeInfo Component
 
 The TypeInfo component extracts PHP types information.
 
-**This Component is experimental**.
-[Experimental features](https://symfony.com/doc/current/contributing/code/experimental.html)
-are not covered by Symfony's
-[Backward Compatibility Promise](https://symfony.com/doc/current/contributing/code/bc.html).
-
 Getting Started
 ---------------
 
@@ -20,6 +15,7 @@ composer require phpstan/phpdoc-parser # to support raw string resolving
 <?php
 
 use Symfony\Component\TypeInfo\Type;
+use Symfony\Component\TypeInfo\TypeIdentifier;
 use Symfony\Component\TypeInfo\TypeResolver\TypeResolver;
 
 // Instantiate a new resolver
@@ -32,10 +28,21 @@ $typeResolver->resolve('bool'); // returns a "bool" Type instance
 // Types can be instantiated thanks to static factories
 $type = Type::list(Type::nullable(Type::bool()));
 
-// Type instances have several helper methods
-$type->getBaseType(); // returns an "array" Type instance
-$type->getCollectionKeyType(); // returns an "int" Type instance
-$type->getCollectionValueType()->isNullable(); // returns true
+// Type classes has their specific methods
+Type::object(FooClass::class)->getClassName();
+Type::enum(FooEnum::class, Type::int())->getBackingType();
+Type::list(Type::int())->isList();
+
+// Every type can be cast to string
+(string) Type::generic(Type::object(Collection::class), Type::int()) // returns "Collection<int>"
+
+// You can check that a type (or one of its wrapped/composed parts) is identified by one of some identifiers.
+$type->isIdentifiedBy(Foo::class, Bar::class);
+$type->isIdentifiedBy(TypeIdentifier::OBJECT);
+$type->isIdentifiedBy('float');
+
+// You can also check that a type satifies specific conditions
+$type->isSatisfiedBy(fn (Type $type): bool => !$type->isNullable() && $type->isIdentifiedBy(TypeIdentifier::INT));
 ```
 
 Resources
