Add a missing docstring

matrix-org · Nov 8, 2024 · cdd1608 · cdd1608
1 parent 4e3c362
commit cdd1608
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/http-api/errors.ts b/src/http-api/errors.ts
@@ -157,6 +157,10 @@ export class MatrixError extends HTTPError {
         };
     }
 
+    /**
+     * @returns a new {@link MatrixError} from a JSON payload
+     * received from Widget API error responses.
+     */
     public static fromWidgetApiErrorData(data: IWidgetMatrixError): MatrixError {
         return new MatrixError(data.response, data.http_status, data.url, undefined, new Headers(data.http_headers));
     }