Skip to content

Commit

Permalink
docs: reformat README.md (#241)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-bot committed Dec 20, 2023
1 parent 7c87f24 commit eb12705
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Expand Up @@ -20,6 +20,7 @@ yarn add @anthropic-ai/sdk

The full API of this library can be found in [api.md](https://www.github.com/anthropics/anthropic-sdk-typescript/blob/main/api.md).

<!-- prettier-ignore -->
```js
import Anthropic from '@anthropic-ai/sdk';

Expand Down Expand Up @@ -65,6 +66,7 @@ or call `stream.controller.abort()`.

This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:

<!-- prettier-ignore -->
```ts
import Anthropic from '@anthropic-ai/sdk';

Expand Down Expand Up @@ -134,6 +136,7 @@ When the library is unable to connect to the API,
or if the API returns a non-success status code (i.e., 4xx or 5xx response),
a subclass of `APIError` will be thrown:

<!-- prettier-ignore -->
```ts
async function main() {
const completion = await anthropic.completions
Expand Down Expand Up @@ -256,6 +259,7 @@ The "raw" `Response` returned by `fetch()` can be accessed through the `.asRespo

You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.

<!-- prettier-ignore -->
```ts
const anthropic = new Anthropic();

Expand All @@ -282,12 +286,11 @@ If you would prefer to use a global, web-standards-compliant `fetch` function ev
(for example, if you are running Node with `--experimental-fetch` or using NextJS which polyfills with `undici`),
add the following import before your first import `from "Anthropic"`:

<!-- prettier-ignore -->
```ts
// Tell TypeScript and the package to use the global web fetch instead of node-fetch.
// Note, despite the name, this does not add any polyfills, but expects them to be provided if needed.
import "@anthropic-ai/sdk/shims/web";
import Anthropic from "@anthropic-ai/sdk";
import '@anthropic-ai/sdk/shims/web';
import Anthropic from '@anthropic-ai/sdk';
```

To do the inverse, add `import "@anthropic-ai/sdk/shims/node"` (which does import polyfills).
Expand Down

0 comments on commit eb12705

Please sign in to comment.