Installation
Install the Brew SDK using your preferred package manager:Package Details
| Property | Value |
|---|---|
| Package Name | brew-sdk |
| Version | 0.1.0 |
| License | Apache-2.0 |
| Repository | github.com/GetBrew/brew-typescript-sdk |
Requirements
TypeScript Version
TypeScript 4.9 or higher is required.Runtime Support
The SDK supports the following JavaScript runtimes:| Runtime | Minimum Version |
|---|---|
| Node.js | 20 LTS or later (non-EOL versions) |
| Deno | 1.28.0 or higher |
| Bun | 1.0 or later |
| Web Browsers | Up-to-date Chrome, Firefox, Safari, Edge |
Edge Runtimes
The SDK also works with:- Cloudflare Workers
- Vercel Edge Runtime
- Nitro v2.6 or greater
Testing Frameworks
- Jest 28 or greater with the
"node"environment - Note:
"jsdom"environment is not currently supported
Basic Setup
After installation, import and initialize the client:Configuration Options
The client accepts these configuration options:ESM and CommonJS
The SDK supports both ESM and CommonJS imports:- ESM
- CommonJS
Deno Usage
For Deno, import from npm:TypeScript Configuration
For optimal TypeScript support, ensure yourtsconfig.json includes:
Verifying Installation
Verify the SDK is installed correctly:Environment Setup
For production applications, we recommend this project structure:src/lib/brew.ts):
Next Steps
Need Help?
Our team is ready to support you at every step of your journey with Brew. Choose the option that works best for you:- Self-Service Tools
- Talk to Our Team
Search Documentation
Type in the “Ask any question” search bar at the top left to instantly find relevant documentation pages.
ChatGPT/Claude Integration
Click “Open in ChatGPT” at the top right of any page to analyze documentation with ChatGPT or Claude for deeper insights.