Make container setters method chainable

nyamsprod · nyamsprod · commit 781be7e3509b · 2022-03-26T14:18:13.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,7 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 
 ### Added
 
-- None
+- All containers `Dictionary`, `InnerList`, `OrderedList`, `Parameters` modifying methods are made chainable.
 
 ### Fixed
 
diff --git a/src/Dictionary.php b/src/Dictionary.php
@@ -222,9 +222,11 @@ public function pair(int $index): array
      * 1:array<string,Item|ByteSequence|Token|bool|int|float|string>
      * }|bool|int|float|string $member
      */
-    public function set(string $key, InnerList|Item|ByteSequence|Token|array|bool|int|float|string $member): void
+    public function set(string $key, InnerList|Item|ByteSequence|Token|array|bool|int|float|string $member): self
     {
         $this->members[self::filterKey($key)] = self::filterMember($member);
+
+        return $this;
     }
 
     /**
@@ -257,19 +259,23 @@ private static function filterMember(InnerList|Item|ByteSequence|Token|array|boo
     /**
      * Delete members associated with the list of submitted keys.
      */
-    public function delete(string ...$keys): void
+    public function delete(string ...$keys): self
     {
         foreach ($keys as $key) {
             unset($this->members[$key]);
         }
+
+        return $this;
     }
 
     /**
      * Remove all members from the instance.
      */
-    public function clear(): void
+    public function clear(): self
     {
         $this->members = [];
+
+        return $this;
     }
 
     /**
@@ -280,11 +286,13 @@ public function clear(): void
      * 1:array<string,Item|ByteSequence|Token|bool|int|float|string>
      * }|bool|int|float|string $member
      */
-    public function append(string $key, InnerList|Item|ByteSequence|Token|array|bool|int|float|string $member): void
+    public function append(string $key, InnerList|Item|ByteSequence|Token|array|bool|int|float|string $member): self
     {
         unset($this->members[$key]);
 
         $this->members[self::filterKey($key)] = self::filterMember($member);
+
+        return $this;
     }
 
     /**
@@ -295,11 +303,13 @@ public function append(string $key, InnerList|Item|ByteSequence|Token|array|bool
      * 1:array<string,Item|ByteSequence|Token|bool|int|float|string>
      * }|bool|int|float|string $member
      */
-    public function prepend(string $key, InnerList|Item|ByteSequence|Token|array|bool|int|float|string $member): void
+    public function prepend(string $key, InnerList|Item|ByteSequence|Token|array|bool|int|float|string $member): self
     {
         unset($this->members[$key]);
 
         $this->members = [...[self::filterKey($key) => self::filterMember($member)], ...$this->members];
+
+        return $this;
     }
 
     /**
@@ -310,10 +320,12 @@ public function prepend(string $key, InnerList|Item|ByteSequence|Token|array|boo
      * 1:array<string,Item|ByteSequence|Token|bool|int|float|string>
      * }|bool|int|float|string> ...$others
      */
-    public function merge(iterable ...$others): void
+    public function merge(iterable ...$others): self
     {
         foreach ($others as $other) {
             $this->members = [...$this->members, ...self::fromAssociative($other)->members];
         }
+
+        return $this;
     }
 }
diff --git a/src/InnerList.php b/src/InnerList.php
@@ -125,25 +125,29 @@ public function get(int $index): Item
     /**
      * Insert members at the beginning of the list.
      */
-    public function unshift(Item|ByteSequence|Token|bool|int|float|string ...$members): void
+    public function unshift(Item|ByteSequence|Token|bool|int|float|string ...$members): self
     {
         $this->members = [...array_map(self::filterMember(...), $members), ...$this->members];
+
+        return $this;
     }
 
     /**
      * Insert members at the end of the list.
      */
-    public function push(Item|ByteSequence|Token|bool|int|float|string ...$members): void
+    public function push(Item|ByteSequence|Token|bool|int|float|string ...$members): self
     {
         $this->members = [...$this->members, ...array_map(self::filterMember(...), $members)];
+
+        return $this;
     }
 
     /**
      * Replace the member associated with the index.
      *
      * @throws InvalidOffset If the index does not exist
      */
-    public function insert(int $index, Item|ByteSequence|Token|bool|int|float|string ...$members): void
+    public function insert(int $index, Item|ByteSequence|Token|bool|int|float|string ...$members): self
     {
         $offset = $this->filterIndex($index);
         match (true) {
@@ -152,21 +156,25 @@ public function insert(int $index, Item|ByteSequence|Token|bool|int|float|string
             count($this->members) === $offset => $this->push(...$members),
             default => array_splice($this->members, $offset, 0, array_map(self::filterMember(...), $members)),
         };
+
+        return $this;
     }
 
-    public function replace(int $index, Item|ByteSequence|Token|bool|int|float|string $member): void
+    public function replace(int $index, Item|ByteSequence|Token|bool|int|float|string $member): self
     {
         if (null === ($offset = $this->filterIndex($index))) {
             throw InvalidOffset::dueToIndexNotFound($index);
         }
 
         $this->members[$offset] = self::filterMember($member);
+
+        return $this;
     }
 
     /**
      * Delete members associated with the list of instance indexes.
      */
-    public function remove(int ...$indexes): void
+    public function remove(int ...$indexes): self
     {
         $offsets = array_filter(
             array_map(fn (int $index): int|null => $this->filterIndex($index), $indexes),
@@ -180,13 +188,17 @@ public function remove(int ...$indexes): void
         if ([] !== $offsets) {
             $this->members = array_values($this->members);
         }
+
+        return $this;
     }
 
     /**
      * Remove all members from the instance.
      */
-    public function clear(): void
+    public function clear(): self
     {
         $this->members = [];
+
+        return $this;
     }
 }
diff --git a/src/OrderedList.php b/src/OrderedList.php
@@ -145,9 +145,11 @@ public function get(int $index): Item|InnerList
      * 1:array<string,Item|ByteSequence|Token|bool|int|float|string>
      * }|bool|int|float|string ...$members
      */
-    public function unshift(InnerList|Item|ByteSequence|Token|array|bool|int|float|string ...$members): void
+    public function unshift(InnerList|Item|ByteSequence|Token|array|bool|int|float|string ...$members): self
     {
         $this->members = [...array_map(self::filterMember(...), $members), ...$this->members];
+
+        return $this;
     }
 
     /**
@@ -158,9 +160,11 @@ public function unshift(InnerList|Item|ByteSequence|Token|array|bool|int|float|s
      * 1:array<string,Item|ByteSequence|Token|bool|int|float|string>
      * }|bool|int|float|string ...$members
      */
-    public function push(InnerList|Item|ByteSequence|Token|array|bool|int|float|string ...$members): void
+    public function push(InnerList|Item|ByteSequence|Token|array|bool|int|float|string ...$members): self
     {
         $this->members = [...$this->members, ...array_map(self::filterMember(...), $members)];
+
+        return $this;
     }
 
     /**
@@ -176,14 +180,16 @@ public function push(InnerList|Item|ByteSequence|Token|array|bool|int|float|stri
     public function insert(
         int $index,
         InnerList|Item|ByteSequence|Token|array|bool|int|float|string ...$members
-    ): void {
+    ): self {
         $offset = $this->filterIndex($index);
         match (true) {
             null === $offset => throw InvalidOffset::dueToIndexNotFound($index),
             0 === $offset => $this->unshift(...$members),
             count($this->members) === $offset => $this->push(...$members),
             default => array_splice($this->members, $offset, 0, array_map(self::filterMember(...), $members)),
         };
+
+        return $this;
     }
 
     /**
@@ -196,19 +202,21 @@ public function insert(
      *
      * @throws InvalidOffset If the index does not exist
      */
-    public function replace(int $index, InnerList|Item|ByteSequence|Token|array|bool|int|float|string $member): void
+    public function replace(int $index, InnerList|Item|ByteSequence|Token|array|bool|int|float|string $member): self
     {
         if (null === ($offset = $this->filterIndex($index))) {
             throw InvalidOffset::dueToIndexNotFound($index);
         }
 
         $this->members[$offset] = self::filterMember($member);
+
+        return $this;
     }
 
     /**
      * Delete members associated with the list of instance indexes.
      */
-    public function remove(int ...$indexes): void
+    public function remove(int ...$indexes): self
     {
         $offsets = array_filter(
             array_map(fn (int $index): int|null => $this->filterIndex($index), $indexes),
@@ -222,13 +230,17 @@ public function remove(int ...$indexes): void
         if ([] !== $offsets) {
             $this->members = array_values($this->members);
         }
+
+        return $this;
     }
 
     /**
      * Remove all members from the instance.
      */
-    public function clear(): void
+    public function clear(): self
     {
         $this->members = [];
+
+        return $this;
     }
 }
diff --git a/src/Parameters.php b/src/Parameters.php
@@ -314,27 +314,33 @@ public function pair(int $index): array
      * @throws SyntaxError         If the string key is not a valid
      * @throws ForbiddenStateError if the found item is in invalid state
      */
-    public function set(string $key, Item|ByteSequence|Token|bool|int|float|string $member): void
+    public function set(string $key, Item|ByteSequence|Token|bool|int|float|string $member): self
     {
         $this->members[self::filterKey($key)] = self::formatMember($member);
+
+        return $this;
     }
 
     /**
      * Delete members associated with the list of submitted keys.
      */
-    public function delete(string ...$keys): void
+    public function delete(string ...$keys): self
     {
         foreach ($keys as $key) {
             unset($this->members[$key]);
         }
+
+        return $this;
     }
 
     /**
      * Remove all members from the instance.
      */
-    public function clear(): void
+    public function clear(): self
     {
         $this->members = [];
+
+        return $this;
     }
 
     /**
@@ -343,11 +349,13 @@ public function clear(): void
      * @throws SyntaxError         If the string key is not a valid
      * @throws ForbiddenStateError if the found item is in invalid state
      */
-    public function append(string $key, Item|ByteSequence|Token|bool|int|float|string $member): void
+    public function append(string $key, Item|ByteSequence|Token|bool|int|float|string $member): self
     {
         unset($this->members[$key]);
 
         $this->members[self::filterKey($key)] = self::formatMember($member);
+
+        return $this;
     }
 
     /**
@@ -356,11 +364,13 @@ public function append(string $key, Item|ByteSequence|Token|bool|int|float|strin
      * @throws SyntaxError         If the string key is not a valid
      * @throws ForbiddenStateError if the found item is in invalid state
      */
-    public function prepend(string $key, Item|ByteSequence|Token|bool|int|float|string $member): void
+    public function prepend(string $key, Item|ByteSequence|Token|bool|int|float|string $member): self
     {
         unset($this->members[$key]);
 
         $this->members = [...[self::filterKey($key) =>  self::formatMember($member)], ...$this->members];
+
+        return $this;
     }
 
     /**
@@ -369,10 +379,12 @@ public function prepend(string $key, Item|ByteSequence|Token|bool|int|float|stri
      * @param  iterable<array-key, Item|Token|ByteSequence|float|int|bool|string> ...$others
      * @throws ForbiddenStateError                                                if the found item is in invalid state
      */
-    public function merge(iterable ...$others): void
+    public function merge(iterable ...$others): self
     {
         foreach ($others as $other) {
             $this->members = [...$this->members, ...self::fromAssociative($other)->members];
         }
+
+        return $this;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -222,9 +222,11 @@ public function pair(int $index): array`
`222`	`222`	`* 1:array<string,Item\|ByteSequence\|Token\|bool\|int\|float\|string>`
`223`	`223`	`* }\|bool\|int\|float\|string $member`
`224`	`224`	`*/`
`225`		`- public function set(string $key, InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string $member): void`
	`225`	`+ public function set(string $key, InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string $member): self`
`226`	`226`	`{`
`227`	`227`	`$this->members[self::filterKey($key)] = self::filterMember($member);`
	`228`	`+`
	`229`	`+ return $this;`
`228`	`230`	`}`
`229`	`231`
`230`	`232`	`/**`
`@@ -257,19 +259,23 @@ private static function filterMember(InnerList\|Item\|ByteSequence\|Token\|array\|boo`
`257`	`259`	`/**`
`258`	`260`	`* Delete members associated with the list of submitted keys.`
`259`	`261`	`*/`
`260`		`- public function delete(string ...$keys): void`
	`262`	`+ public function delete(string ...$keys): self`
`261`	`263`	`{`
`262`	`264`	`foreach ($keys as $key) {`
`263`	`265`	`unset($this->members[$key]);`
`264`	`266`	`}`
	`267`	`+`
	`268`	`+ return $this;`
`265`	`269`	`}`
`266`	`270`
`267`	`271`	`/**`
`268`	`272`	`* Remove all members from the instance.`
`269`	`273`	`*/`
`270`		`- public function clear(): void`
	`274`	`+ public function clear(): self`
`271`	`275`	`{`
`272`	`276`	`$this->members = [];`
	`277`	`+`
	`278`	`+ return $this;`
`273`	`279`	`}`
`274`	`280`
`275`	`281`	`/**`
`@@ -280,11 +286,13 @@ public function clear(): void`
`280`	`286`	`* 1:array<string,Item\|ByteSequence\|Token\|bool\|int\|float\|string>`
`281`	`287`	`* }\|bool\|int\|float\|string $member`
`282`	`288`	`*/`
`283`		`- public function append(string $key, InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string $member): void`
	`289`	`+ public function append(string $key, InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string $member): self`
`284`	`290`	`{`
`285`	`291`	`unset($this->members[$key]);`
`286`	`292`
`287`	`293`	`$this->members[self::filterKey($key)] = self::filterMember($member);`
	`294`	`+`
	`295`	`+ return $this;`
`288`	`296`	`}`
`289`	`297`
`290`	`298`	`/**`
`@@ -295,11 +303,13 @@ public function append(string $key, InnerList\|Item\|ByteSequence\|Token\|array\|bool`
`295`	`303`	`* 1:array<string,Item\|ByteSequence\|Token\|bool\|int\|float\|string>`
`296`	`304`	`* }\|bool\|int\|float\|string $member`
`297`	`305`	`*/`
`298`		`- public function prepend(string $key, InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string $member): void`
	`306`	`+ public function prepend(string $key, InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string $member): self`
`299`	`307`	`{`
`300`	`308`	`unset($this->members[$key]);`
`301`	`309`
`302`	`310`	`$this->members = [...[self::filterKey($key) => self::filterMember($member)], ...$this->members];`
	`311`	`+`
	`312`	`+ return $this;`
`303`	`313`	`}`
`304`	`314`
`305`	`315`	`/**`
`@@ -310,10 +320,12 @@ public function prepend(string $key, InnerList\|Item\|ByteSequence\|Token\|array\|boo`
`310`	`320`	`* 1:array<string,Item\|ByteSequence\|Token\|bool\|int\|float\|string>`
`311`	`321`	`* }\|bool\|int\|float\|string> ...$others`
`312`	`322`	`*/`
`313`		`- public function merge(iterable ...$others): void`
	`323`	`+ public function merge(iterable ...$others): self`
`314`	`324`	`{`
`315`	`325`	`foreach ($others as $other) {`
`316`	`326`	`$this->members = [...$this->members, ...self::fromAssociative($other)->members];`
`317`	`327`	`}`
	`328`	`+`
	`329`	`+ return $this;`
`318`	`330`	`}`
`319`	`331`	`}`
Original file line number	Diff line number	Diff line change
`@@ -125,25 +125,29 @@ public function get(int $index): Item`
`125`	`125`	`/**`
`126`	`126`	`* Insert members at the beginning of the list.`
`127`	`127`	`*/`
`128`		`- public function unshift(Item\|ByteSequence\|Token\|bool\|int\|float\|string ...$members): void`
	`128`	`+ public function unshift(Item\|ByteSequence\|Token\|bool\|int\|float\|string ...$members): self`
`129`	`129`	`{`
`130`	`130`	`$this->members = [...array_map(self::filterMember(...), $members), ...$this->members];`
	`131`	`+`
	`132`	`+ return $this;`
`131`	`133`	`}`
`132`	`134`
`133`	`135`	`/**`
`134`	`136`	`* Insert members at the end of the list.`
`135`	`137`	`*/`
`136`		`- public function push(Item\|ByteSequence\|Token\|bool\|int\|float\|string ...$members): void`
	`138`	`+ public function push(Item\|ByteSequence\|Token\|bool\|int\|float\|string ...$members): self`
`137`	`139`	`{`
`138`	`140`	`$this->members = [...$this->members, ...array_map(self::filterMember(...), $members)];`
	`141`	`+`
	`142`	`+ return $this;`
`139`	`143`	`}`
`140`	`144`
`141`	`145`	`/**`
`142`	`146`	`* Replace the member associated with the index.`
`143`	`147`	`*`
`144`	`148`	`* @throws InvalidOffset If the index does not exist`
`145`	`149`	`*/`
`146`		`- public function insert(int $index, Item\|ByteSequence\|Token\|bool\|int\|float\|string ...$members): void`
	`150`	`+ public function insert(int $index, Item\|ByteSequence\|Token\|bool\|int\|float\|string ...$members): self`
`147`	`151`	`{`
`148`	`152`	`$offset = $this->filterIndex($index);`
`149`	`153`	`match (true) {`
`@@ -152,21 +156,25 @@ public function insert(int $index, Item\|ByteSequence\|Token\|bool\|int\|float\|string`
`152`	`156`	`count($this->members) === $offset => $this->push(...$members),`
`153`	`157`	`default => array_splice($this->members, $offset, 0, array_map(self::filterMember(...), $members)),`
`154`	`158`	`};`
	`159`	`+`
	`160`	`+ return $this;`
`155`	`161`	`}`
`156`	`162`
`157`		`- public function replace(int $index, Item\|ByteSequence\|Token\|bool\|int\|float\|string $member): void`
	`163`	`+ public function replace(int $index, Item\|ByteSequence\|Token\|bool\|int\|float\|string $member): self`
`158`	`164`	`{`
`159`	`165`	`if (null === ($offset = $this->filterIndex($index))) {`
`160`	`166`	`throw InvalidOffset::dueToIndexNotFound($index);`
`161`	`167`	`}`
`162`	`168`
`163`	`169`	`$this->members[$offset] = self::filterMember($member);`
	`170`	`+`
	`171`	`+ return $this;`
`164`	`172`	`}`
`165`	`173`
`166`	`174`	`/**`
`167`	`175`	`* Delete members associated with the list of instance indexes.`
`168`	`176`	`*/`
`169`		`- public function remove(int ...$indexes): void`
	`177`	`+ public function remove(int ...$indexes): self`
`170`	`178`	`{`
`171`	`179`	`$offsets = array_filter(`
`172`	`180`	`array_map(fn (int $index): int\|null => $this->filterIndex($index), $indexes),`
`@@ -180,13 +188,17 @@ public function remove(int ...$indexes): void`
`180`	`188`	`if ([] !== $offsets) {`
`181`	`189`	`$this->members = array_values($this->members);`
`182`	`190`	`}`
	`191`	`+`
	`192`	`+ return $this;`
`183`	`193`	`}`
`184`	`194`
`185`	`195`	`/**`
`186`	`196`	`* Remove all members from the instance.`
`187`	`197`	`*/`
`188`		`- public function clear(): void`
	`198`	`+ public function clear(): self`
`189`	`199`	`{`
`190`	`200`	`$this->members = [];`
	`201`	`+`
	`202`	`+ return $this;`
`191`	`203`	`}`
`192`	`204`	`}`
Original file line number	Diff line number	Diff line change
`@@ -145,9 +145,11 @@ public function get(int $index): Item\|InnerList`
`145`	`145`	`* 1:array<string,Item\|ByteSequence\|Token\|bool\|int\|float\|string>`
`146`	`146`	`* }\|bool\|int\|float\|string ...$members`
`147`	`147`	`*/`
`148`		`- public function unshift(InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string ...$members): void`
	`148`	`+ public function unshift(InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string ...$members): self`
`149`	`149`	`{`
`150`	`150`	`$this->members = [...array_map(self::filterMember(...), $members), ...$this->members];`
	`151`	`+`
	`152`	`+ return $this;`
`151`	`153`	`}`
`152`	`154`
`153`	`155`	`/**`
`@@ -158,9 +160,11 @@ public function unshift(InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|s`
`158`	`160`	`* 1:array<string,Item\|ByteSequence\|Token\|bool\|int\|float\|string>`
`159`	`161`	`* }\|bool\|int\|float\|string ...$members`
`160`	`162`	`*/`
`161`		`- public function push(InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string ...$members): void`
	`163`	`+ public function push(InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string ...$members): self`
`162`	`164`	`{`
`163`	`165`	`$this->members = [...$this->members, ...array_map(self::filterMember(...), $members)];`
	`166`	`+`
	`167`	`+ return $this;`
`164`	`168`	`}`
`165`	`169`
`166`	`170`	`/**`
`@@ -176,14 +180,16 @@ public function push(InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|stri`
`176`	`180`	`public function insert(`
`177`	`181`	`int $index,`
`178`	`182`	`InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string ...$members`
`179`		`- ): void {`
	`183`	`+ ): self {`
`180`	`184`	`$offset = $this->filterIndex($index);`
`181`	`185`	`match (true) {`
`182`	`186`	`null === $offset => throw InvalidOffset::dueToIndexNotFound($index),`
`183`	`187`	`0 === $offset => $this->unshift(...$members),`
`184`	`188`	`count($this->members) === $offset => $this->push(...$members),`
`185`	`189`	`default => array_splice($this->members, $offset, 0, array_map(self::filterMember(...), $members)),`
`186`	`190`	`};`
	`191`	`+`
	`192`	`+ return $this;`
`187`	`193`	`}`
`188`	`194`
`189`	`195`	`/**`
`@@ -196,19 +202,21 @@ public function insert(`
`196`	`202`	`*`
`197`	`203`	`* @throws InvalidOffset If the index does not exist`
`198`	`204`	`*/`
`199`		`- public function replace(int $index, InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string $member): void`
	`205`	`+ public function replace(int $index, InnerList\|Item\|ByteSequence\|Token\|array\|bool\|int\|float\|string $member): self`
`200`	`206`	`{`
`201`	`207`	`if (null === ($offset = $this->filterIndex($index))) {`
`202`	`208`	`throw InvalidOffset::dueToIndexNotFound($index);`
`203`	`209`	`}`
`204`	`210`
`205`	`211`	`$this->members[$offset] = self::filterMember($member);`
	`212`	`+`
	`213`	`+ return $this;`
`206`	`214`	`}`
`207`	`215`
`208`	`216`	`/**`
`209`	`217`	`* Delete members associated with the list of instance indexes.`
`210`	`218`	`*/`
`211`		`- public function remove(int ...$indexes): void`
	`219`	`+ public function remove(int ...$indexes): self`
`212`	`220`	`{`
`213`	`221`	`$offsets = array_filter(`
`214`	`222`	`array_map(fn (int $index): int\|null => $this->filterIndex($index), $indexes),`
`@@ -222,13 +230,17 @@ public function remove(int ...$indexes): void`
`222`	`230`	`if ([] !== $offsets) {`
`223`	`231`	`$this->members = array_values($this->members);`
`224`	`232`	`}`
	`233`	`+`
	`234`	`+ return $this;`
`225`	`235`	`}`
`226`	`236`
`227`	`237`	`/**`
`228`	`238`	`* Remove all members from the instance.`
`229`	`239`	`*/`
`230`		`- public function clear(): void`
	`240`	`+ public function clear(): self`
`231`	`241`	`{`
`232`	`242`	`$this->members = [];`
	`243`	`+`
	`244`	`+ return $this;`
`233`	`245`	`}`
`234`	`246`	`}`
Original file line number	Diff line number	Diff line change
`@@ -314,27 +314,33 @@ public function pair(int $index): array`
`314`	`314`	`* @throws SyntaxError If the string key is not a valid`
`315`	`315`	`* @throws ForbiddenStateError if the found item is in invalid state`
`316`	`316`	`*/`
`317`		`- public function set(string $key, Item\|ByteSequence\|Token\|bool\|int\|float\|string $member): void`
	`317`	`+ public function set(string $key, Item\|ByteSequence\|Token\|bool\|int\|float\|string $member): self`
`318`	`318`	`{`
`319`	`319`	`$this->members[self::filterKey($key)] = self::formatMember($member);`
	`320`	`+`
	`321`	`+ return $this;`
`320`	`322`	`}`
`321`	`323`
`322`	`324`	`/**`
`323`	`325`	`* Delete members associated with the list of submitted keys.`
`324`	`326`	`*/`
`325`		`- public function delete(string ...$keys): void`
	`327`	`+ public function delete(string ...$keys): self`
`326`	`328`	`{`
`327`	`329`	`foreach ($keys as $key) {`
`328`	`330`	`unset($this->members[$key]);`
`329`	`331`	`}`
	`332`	`+`
	`333`	`+ return $this;`
`330`	`334`	`}`
`331`	`335`
`332`	`336`	`/**`
`333`	`337`	`* Remove all members from the instance.`
`334`	`338`	`*/`
`335`		`- public function clear(): void`
	`339`	`+ public function clear(): self`
`336`	`340`	`{`
`337`	`341`	`$this->members = [];`
	`342`	`+`
	`343`	`+ return $this;`
`338`	`344`	`}`
`339`	`345`
`340`	`346`	`/**`
`@@ -343,11 +349,13 @@ public function clear(): void`
`343`	`349`	`* @throws SyntaxError If the string key is not a valid`
`344`	`350`	`* @throws ForbiddenStateError if the found item is in invalid state`
`345`	`351`	`*/`
`346`		`- public function append(string $key, Item\|ByteSequence\|Token\|bool\|int\|float\|string $member): void`
	`352`	`+ public function append(string $key, Item\|ByteSequence\|Token\|bool\|int\|float\|string $member): self`
`347`	`353`	`{`
`348`	`354`	`unset($this->members[$key]);`
`349`	`355`
`350`	`356`	`$this->members[self::filterKey($key)] = self::formatMember($member);`
	`357`	`+`
	`358`	`+ return $this;`
`351`	`359`	`}`
`352`	`360`
`353`	`361`	`/**`
`@@ -356,11 +364,13 @@ public function append(string $key, Item\|ByteSequence\|Token\|bool\|int\|float\|strin`
`356`	`364`	`* @throws SyntaxError If the string key is not a valid`
`357`	`365`	`* @throws ForbiddenStateError if the found item is in invalid state`
`358`	`366`	`*/`
`359`		`- public function prepend(string $key, Item\|ByteSequence\|Token\|bool\|int\|float\|string $member): void`
	`367`	`+ public function prepend(string $key, Item\|ByteSequence\|Token\|bool\|int\|float\|string $member): self`
`360`	`368`	`{`
`361`	`369`	`unset($this->members[$key]);`
`362`	`370`
`363`	`371`	`$this->members = [...[self::filterKey($key) => self::formatMember($member)], ...$this->members];`
	`372`	`+`
	`373`	`+ return $this;`
`364`	`374`	`}`
`365`	`375`
`366`	`376`	`/**`
`@@ -369,10 +379,12 @@ public function prepend(string $key, Item\|ByteSequence\|Token\|bool\|int\|float\|stri`
`369`	`379`	`* @param iterable<array-key, Item\|Token\|ByteSequence\|float\|int\|bool\|string> ...$others`
`370`	`380`	`* @throws ForbiddenStateError if the found item is in invalid state`
`371`	`381`	`*/`
`372`		`- public function merge(iterable ...$others): void`
	`382`	`+ public function merge(iterable ...$others): self`
`373`	`383`	`{`
`374`	`384`	`foreach ($others as $other) {`
`375`	`385`	`$this->members = [...$this->members, ...self::fromAssociative($other)->members];`
`376`	`386`	`}`
	`387`	`+`
	`388`	`+ return $this;`
`377`	`389`	`}`
`378`	`390`	`}`