Spaces:
Build error
Build error
File size: 2,815 Bytes
c211499 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
# 👋 Wondering what everything in here does?
`@anthropic-ai/sdk` supports a wide variety of runtime environments like Node.js, Deno, Bun, browsers, and various
edge runtimes, as well as both CommonJS (CJS) and EcmaScript Modules (ESM).
To do this, `@anthropic-ai/sdk` provides shims for either using `node-fetch` when in Node (because `fetch` is still experimental there) or the global `fetch` API built into the environment when not in Node.
It uses [conditional exports](https://nodejs.org/api/packages.html#conditional-exports) to
automatically select the correct shims for each environment. However, conditional exports are a fairly new
feature and not supported everywhere. For instance, the TypeScript `"moduleResolution": "node"`
setting doesn't consult the `exports` map, compared to `"moduleResolution": "nodeNext"`, which does.
Unfortunately that's still the default setting, and it can result in errors like
getting the wrong raw `Response` type from `.asResponse()`, for example.
The user can work around these issues by manually importing one of:
- `import '@anthropic-ai/sdk/shims/node'`
- `import '@anthropic-ai/sdk/shims/web'`
All of the code here in `_shims` handles selecting the automatic default shims or manual overrides.
### How it works - Runtime
Runtime shims get installed by calling `setShims` exported by `@anthropic-ai/sdk/_shims/registry`.
Manually importing `@anthropic-ai/sdk/shims/node` or `@anthropic-ai/sdk/shims/web`, calls `setShims` with the respective runtime shims.
All client code imports shims from `@anthropic-ai/sdk/_shims/index`, which:
- checks if shims have been set manually
- if not, calls `setShims` with the shims from `@anthropic-ai/sdk/_shims/auto/runtime`
- re-exports the installed shims from `@anthropic-ai/sdk/_shims/registry`.
`@anthropic-ai/sdk/_shims/auto/runtime` exports web runtime shims.
If the `node` export condition is set, the export map replaces it with `@anthropic-ai/sdk/_shims/auto/runtime-node`.
### How it works - Type time
All client code imports shim types from `@anthropic-ai/sdk/_shims/index`, which selects the manual types from `@anthropic-ai/sdk/_shims/manual-types` if they have been declared, otherwise it exports the auto types from `@anthropic-ai/sdk/_shims/auto/types`.
`@anthropic-ai/sdk/_shims/manual-types` exports an empty namespace.
Manually importing `@anthropic-ai/sdk/shims/node` or `@anthropic-ai/sdk/shims/web` merges declarations into this empty namespace, so they get picked up by `@anthropic-ai/sdk/_shims/index`.
`@anthropic-ai/sdk/_shims/auto/types` exports web type definitions.
If the `node` export condition is set, the export map replaces it with `@anthropic-ai/sdk/_shims/auto/types-node`, though TS only picks this up if `"moduleResolution": "nodenext"` or `"moduleResolution": "bundler"`.
|