Improve docblock

Author: nyamsprod

CHANGELOG.md

@@ -10,7 +10,7 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 - The `ParameterAccess` interface.
 - The `InvaludArgument` exception.
 - `OrderedList`, `InnerList` now implements the `MemberList` interface.
-- `Parameters` and `Dictionnary` now implements the PHP `MemberOrderedMap` interface.
+- `Parameters` and `Dictionnary` now implements the PHP `OrderedMap` interface.
 - `Token::value` is a readonly property.
 - `Item::value` method returns the decoded value of an Item (returns value can be `float|int|string|bool`).
 - `Item::fromToken`, `Item::fromDecodedByteSequence` , `Item::fromEncodedByteSequence` to ease specific string initiation 

src/OrderedList.php

@@ -15,7 +15,7 @@
 use function is_array;
 
 /**
- * @implements MemberList<int, Item|InnerList<int, Item>>
+ * @implements MemberList<int, Item|MemberList<int, Item>>
  */
 final class OrderedList implements MemberList
 {
@@ -27,13 +27,18 @@ private function __construct(Item|InnerList ...$members)
         $this->members = array_values($members);
     }
 
-    public static function from(InnerList|Item|ByteSequence|Token|bool|int|float|string ...$members): self
+    /**
+     * @param MemberList<int, Item>|Item|ByteSequence|Token|bool|int|float|string ...$members
+     *
+     * @return static
+     */
+    public static function from(MemberList|Item|ByteSequence|Token|bool|int|float|string ...$members): self
     {
         return self::fromList($members);
     }
 
     /**
-     * @param iterable<InnerList|Item|ByteSequence|Token|bool|int|float|string> $members
+     * @param iterable<MemberList<int, Item>|Item|ByteSequence|Token|bool|int|float|string> $members
      */
     public static function fromList(iterable $members = []): self
     {
@@ -102,7 +107,7 @@ public function hasMembers(): bool
     }
 
     /**
-     * @return Iterator<int, Item|InnerList<int, Item>>
+     * @return Iterator<int, Item|MemberList<int, Item>>
      */
     public function getIterator(): Iterator
     {
@@ -181,7 +186,7 @@ public function get(string|int $offset): Item|InnerList
     /**
      * Inserts members at the beginning of the list.
      */
-    public function unshift(StructuredField|ByteSequence|Token|bool|int|float|string ...$members): self
+    public function unshift(MemberList|StructuredField|ByteSequence|Token|bool|int|float|string ...$members): self
     {
         $this->members = [...array_map(self::filterMember(...), array_values($members)), ...$this->members];
 
@@ -191,7 +196,7 @@ public function unshift(StructuredField|ByteSequence|Token|bool|int|float|string
     /**
      * Inserts members at the end of the list.
      */
-    public function push(StructuredField|ByteSequence|Token|bool|int|float|string ...$members): self
+    public function push(MemberList|StructuredField|ByteSequence|Token|bool|int|float|string ...$members): self
     {
         $this->members = [...$this->members, ...array_map(self::filterMember(...), array_values($members))];
 
@@ -203,7 +208,7 @@ public function push(StructuredField|ByteSequence|Token|bool|int|float|string ..
      *
      * @throws InvalidOffset If the index does not exist
      */
-    public function insert(int $index, StructuredField|ByteSequence|Token|bool|int|float|string ...$members): self
+    public function insert(int $index, MemberList|StructuredField|ByteSequence|Token|bool|int|float|string ...$members): self
     {
         $offset = $this->filterIndex($index);
         match (true) {
@@ -281,12 +286,12 @@ public function offsetUnset($offset): void
 
     /**
      * @param int|null $offset
-     * @param InnerList<int, Item>|Item|ByteSequence|Token|bool|int|float|string $value  the member to add
+     * @param MemberList<int, Item>|Item|ByteSequence|Token|bool|int|float|string $value  the member to add
      *
      * @see ::push
      * @see ::replace
      */
-    public function offsetSet(mixed $offset, $value): void
+    public function offsetSet(mixed $offset, mixed $value): void
     {
         if (null !== $offset) {
             $this->replace($offset, $value);

src/OrderedListTest.php

@@ -122,7 +122,7 @@ public function test_it_can_generate_the_same_value(): void
     public function it_implements_the_array_access_interface(): void
     {
         $sequence = OrderedList::fromList();
-        $sequence[] = InnerList::from(42, 69); // @phpstan-ignore-line
+        $sequence[] = InnerList::from(42, 69);
 
         self::assertTrue(isset($sequence[0]));
         self::assertInstanceOf(InnerList::class, $sequence[0]);

src/ParametersTest.php

@@ -4,7 +4,6 @@
 
 namespace Bakame\Http\StructuredFields;
 
-use TypeError;
 use function iterator_to_array;
 
 /**
@@ -350,8 +349,8 @@ public function it_fails_to_fetch_an_value_using_an_integer(): void
     /** @test */
     public function it_throws_if_the_structured_field_is_not_supported(): void
     {
-        $this->expectException(TypeError::class);
+        $this->expectException(InvalidArgument::class);
 
-        Parameters::fromPairs(['foo', InnerList::from(42)]); // @phpstan-ignore-line
+        Parameters::fromPairs([['foo', InnerList::from(42)]]); // @phpstan-ignore-line
     }
 }