Skip to content

feat: add Webpack configuration and update README for browser usage #95

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
tiagosiebler merged 3 commits into from
Jan 15, 2026
Merged

feat: add Webpack configuration and update README for browser usage #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
68fda5a
feat: add Webpack configuration and update README for browser usage
JJ-Cro Jan 13, 2026
19b2e44
Merge branch 'master' into webpack
tiagosiebler Jan 15, 2026
aacbdae
Update webpack/webpack.config.cjs
tiagosiebler Jan 15, 2026
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
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ dist
coverage
localtest.sh
repomix.sh
doc

ws-private-spot-wsapi-performance.ts
ws-private-perp-futures-wsapi-readonly.ts
Expand All @@ -33,4 +34,4 @@ privatetest.ts
privaterepotracker
restClientRegex.ts

testfile.ts
testfile.ts
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ Updated & performant JavaScript & Node.js SDK for the Gate.com (gate.io) REST AP
- [Event Driven API](#event-driven-api)
- [REST-like API](#rest-like-api)
- [Customise Logging](#customise-logging)
- [Browser/Frontend Usage](#browserfrontend-usage)
- [Webpack](#webpack)
- [LLMs & AI](#use-with-llms--ai)
- [Used By](#used-by)
- [Contributions & Thanks](#contributions--thanks)
Expand Down Expand Up @@ -433,6 +435,18 @@ DefaultLogger.silly = () => {};
const ws = new WebsocketClient({ key: 'xxx', secret: 'yyy' }, DefaultLogger);
```

## Browser/Frontend Usage

### Webpack

Build a bundle using webpack:

- `npm install`
- `npm run build`
- `npm run pack`

The bundle can be found in `dist/`. Altough usage should be largely consistent, smaller differences will exist. Documentation is still TODO.

## Use with LLMs & AI

This SDK includes a bundled `llms.txt` file in the root of the repository. If you're developing with LLMs, use the included `llms.txt` with your LLM - it will significantly improve the LLMs understanding of how to correctly use this SDK.
Expand Down
Loading
Loading