Skip to content

Commit 7b754a1

Browse files
committed
init: first commit
- added Readme - added basic linter - added editor config
0 parents  commit 7b754a1

File tree

9 files changed

+2889
-0
lines changed

9 files changed

+2889
-0
lines changed

.editorconfig

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# http://EditorConfig.org
2+
root = true
3+
4+
[*]
5+
end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
charset = utf-8
9+
10+
[*.{ts,ts.d}]
11+
indent_style = space
12+
indent_size = 2
13+
14+
# IntelliJ Specific
15+
ij_javascript_spaces_within_imports = true
16+
ij_typescript_spaces_within_imports = true
17+
ij_typescript_spaces_around_arrow_function_operator = true
18+
ij_javascript_spaces_around_arrow_function_operator = true

.gitignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.idea/
2+
*.iml
3+
dist/
4+
node_modules/
5+
.vscode
6+
coverage
7+
.env
8+
.venv
9+
test-results/
10+
.DS_Store
11+
/test/private-api-usage/node-*.json

.prettierrc.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"tabWidth": 2,
3+
"semi": true,
4+
"singleQuote": true,
5+
"printWidth": 120,
6+
"singleAttributePerLine": true,
7+
"bracketSameLine": false,
8+
"bracketSpacing": true
9+
}

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Local HTTP & WebSocket Proxy for SDK Testing
2+
3+
During SDK testing, it’s often useful to simulate real-world conditions or inspect communication between a client and a backend service. This lightweight local proxy helps developers spy on and inject both HTTP and WebSocket traffic for more effective debugging, experimentation, and test automation.
4+
5+
## ✨ Core Features
6+
7+
### 🔍 HTTP Inspection
8+
9+
- Spy on Outgoing HTTP Requests
10+
- Modify Incoming HTTP Responses
11+
12+
### 🔍 WebSocket Inspection
13+
14+
- Spy on Outgoing WebSocket Messages
15+
- Modify Incoming WebSocket Messages
16+
- Inject WebSocket Messages
17+
18+
### 📦 Use Cases
19+
20+
- Validate SDK behavior against specific message sequences.
21+
- Simulate dropped or malformed responses.
22+
- Replay server messages for automated or regression testing.
23+
- Monitor raw protocol-level activity to catch subtle bugs or race conditions.
24+
25+
🚀 Getting Started
26+
27+
Install npm dependency:
28+
29+
```bash
30+
npm i -D @ably-labs/local-proxy
31+
```
32+
33+
34+
35+

0 commit comments

Comments
 (0)