-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
`caronte` is a from-scratch implementation of `http-proxy` and, as such | ||
brings some breaking changes to APIs. | ||
|
||
## Server creation | ||
|
||
Available through `.createServer()` or `.createProxyServer()`. | ||
Check the README.md for a more detailed explanation of the parameters. | ||
|
||
## Proxying | ||
|
||
Web proying is done by calling the `.web()` method on a Proxy instance. Websockets | ||
are proxied by the `.ws()` method. | ||
|
||
## Error Handling | ||
|
||
It is possible to listen globally on the `error` event on the server. In alternative, a | ||
callback passed to `.web()` or `.ws()` as last parameter is also accepted. | ||
|
||
## Dropped | ||
|
||
Since the API was rewritten to be extremely flexible we decided to drop some features | ||
which were in the core and delegate them to eventual "user-land" modules. | ||
|
||
- Middleware API | ||
- ProxyTable API | ||
|
db12f6c
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@yawnt Nice start. A good next step would be to flesh it out with code examples and more specific language. This is a great place to look: https://nodejs.org/api/stream.html#stream_compatibility_with_older_node_versions