Merge pull request #199 from GrahamCampbell/plugin-doc

dbu · web-flow · commit 75470e5f4b84 · 2020-07-07T07:44:02.000+02:00
More specific plugin type doc
diff --git a/src/Plugin.php b/src/Plugin.php
@@ -24,8 +24,8 @@ interface Plugin
      *
      * @see http://docs.php-http.org/en/latest/plugins/build-your-own.html
      *
-     * @param callable $next  Next middleware in the chain, the request is passed as the first argument
-     * @param callable $first First middleware in the chain, used to to restart a request
+     * @param callable(RequestInterface): Promise $next  Next middleware in the chain, the request is passed as the first argument
+     * @param callable(RequestInterface): Promise $first First middleware in the chain, used to to restart a request
      *
      * @return Promise Resolves a PSR-7 Response or fails with an Http\Client\Exception (The same as HttpAsyncClient)
      */

Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,8 @@ interface Plugin`
`24`	`24`	`*`
`25`	`25`	`* @see http://docs.php-http.org/en/latest/plugins/build-your-own.html`
`26`	`26`	`*`
`27`		`- * @param callable $next Next middleware in the chain, the request is passed as the first argument`
`28`		`- * @param callable $first First middleware in the chain, used to to restart a request`
	`27`	`+ * @param callable(RequestInterface): Promise $next Next middleware in the chain, the request is passed as the first argument`
	`28`	`+ * @param callable(RequestInterface): Promise $first First middleware in the chain, used to to restart a request`
`29`	`29`	`*`
`30`	`30`	`* @return Promise Resolves a PSR-7 Response or fails with an Http\Client\Exception (The same as HttpAsyncClient)`
`31`	`31`	`*/`