From 3cd5957e98f5eb95e2cd23585790f4be75b9f1aa Mon Sep 17 00:00:00 2001 From: Stainless Bot <107565488+stainless-bot@users.noreply.github.com> Date: Sat, 30 Mar 2024 20:43:30 +0000 Subject: [PATCH] docs(readme): change undocumented params wording (#363) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21e98836..d8a840b4 100644 --- a/README.md +++ b/README.md @@ -293,7 +293,7 @@ await client.post('/some/path', { }); ``` -#### Undocumented params +#### Undocumented request params To make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you @@ -314,7 +314,7 @@ extra param in the body. If you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request options. -#### Undocumented properties +#### Undocumented response properties To access undocumented response properties, you may access the response object with `// @ts-expect-error` on the response object, or cast the response object to the requisite type. Like the request params, we do not