Skip to content

Commit

Permalink
docs(readme): change undocumented params wording (#363)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-bot committed Mar 30, 2024
1 parent 7aa2cc1 commit 4222e08
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 4222e08

Please sign in to comment.