mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Documenting net module: various fixes.

Browse source
This commit is contained in:
ali.ibrahim 2016-10-20 13:57:08 +02:00
parent 9f15191280
commit 8c19d3b210
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/api/net.md
View file

@ -4,7 +4,7 @@
The `net` module is a client-side API for issuing HTTP(S) requests. It is The `net` module is a client-side API for issuing HTTP(S) requests. It is
similar to the [HTTP](https://nodejs.org/api/http.html) and similar to the [HTTP](https://nodejs.org/api/http.html) and
[HTTPS](https://nodejs.org/api/https.html) modules of Node.js but it uses [HTTPS](https://nodejs.org/api/https.html) modules of Node.js but uses
Chromium native networking library instead of the Node.js implementation Chromium native networking library instead of the Node.js implementation
offering therefore a much greater support regarding web proxies. offering therefore a much greater support regarding web proxies.
@ -18,7 +18,7 @@ negotiate authentication schemes.
* Support for traffic monitoring proxies: Fiddler-like proxies used for access * Support for traffic monitoring proxies: Fiddler-like proxies used for access
control and monitoring. control and monitoring.
The `net` module API has been specifically designed to mimic, as much closely as The `net` module API has been specifically designed to mimic, as closely as
possible, the familiar Node.js API. The API components including classes, possible, the familiar Node.js API. The API components including classes,
methods, properties and event names are similar to those commonly used in methods, properties and event names are similar to those commonly used in
Node.js. Node.js.
@ -49,6 +49,9 @@ By the way, it is almost identical to how you would normally use the
[HTTP](https://nodejs.org/api/http.html)/[HTTPS](https://nodejs.org/api/https.html) [HTTP](https://nodejs.org/api/http.html)/[HTTPS](https://nodejs.org/api/https.html)
modules of Node.js modules of Node.js
The `net` API can be used only after the application emits the `ready` event.
Trying to use the module before the `ready` event will throw an error.
## Methods ## Methods
The `net` module has the following methods: The `net` module has the following methods: