Skip to content

docs: fix typo and remove the weird line #2223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chronark merged 1 commit into from
Oct 6, 2024
Merged

docs: fix typo and remove the weird line #2223

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions apps/docs/libraries/ts/sdk/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Always keep your root key safe and reset it `if` you suspect it has been comprom

## Response format

Because forgetting to handle thrown errors properly in javascript is often forgotten, we have decided to explicitely return errors to be handled. Fortunately typescript helps us here and everything is typesafe.
Because forgetting to handle thrown errors properly in javascript is often forgotten, we have decided to explicitly return errors to be handled. Fortunately typescript helps us here and everything is typesafe.

Every method returns either an `error` or a `result` field, never both and never none.

Expand Down Expand Up @@ -109,10 +109,10 @@ The constructor accepts some options to customize the behavior:

### Base Url

Run all requests agaisnt your own instance of unkey hosted on your own infrastructure.
Run all requests against your own instance of unkey hosted on your own infrastructure.

<ParamField body="baseUrl" type="string" default="https://api.unkey.dev">
The age of the user. Cannot be less than 0

</ParamField>
```ts
const unkey = new Unkey({
Expand All @@ -125,7 +125,6 @@ const unkey = new Unkey({

By default the client will retry on network errors, you can customize this behavior:


<ParamField body="retry">
<Expandable defaultOpen>
<ParamField body="attempts" type="integer">
Expand Down