From 12bdb5f5509c205a7a868e02964ed25d10f4b000 Mon Sep 17 00:00:00 2001 From: Marek Kotewicz Date: Wed, 14 Jan 2015 12:01:11 +0100 Subject: providers documentation --- lib/autoprovider.js | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) (limited to 'lib/autoprovider.js') diff --git a/lib/autoprovider.js b/lib/autoprovider.js index 8460a144f..a2c265ccb 100644 --- a/lib/autoprovider.js +++ b/lib/autoprovider.js @@ -33,13 +33,16 @@ if (process.env.NODE_ENV !== 'build') { var web3 = require('./web3'); // jshint ignore:line } -/// Automatically tries to setup correct provider -/// First it checkes if we are ethereum browser (if navigator.qt object is available) -/// if yes, we are using QtProvider -/// if no, we check if it is possible to establish websockets connection with ethereum (ws://localhost:40404/eth is default) -/// if it's not possible, we are using httprpc provider (http://localhost:8080) -/// The constructor allows you to specify uris on which we are trying to connect over http or websockets -/// You can do that by passing objects with fields httrpc and websockets +/** + * AutoProvider object prototype is implementing 'provider protocol' + * Automatically tries to setup correct provider(Qt, WebSockets or HttpRpc) + * First it checkes if we are ethereum browser (if navigator.qt object is available) + * if yes, we are using QtProvider + * if no, we check if it is possible to establish websockets connection with ethereum (ws://localhost:40404/eth is default) + * if it's not possible, we are using httprpc provider (http://localhost:8080) + * The constructor allows you to specify uris on which we are trying to connect over http or websockets + * You can do that by passing objects with fields httrpc and websockets + */ var AutoProvider = function (userOptions) { if (web3.haveProvider()) { return; -- cgit v1.2.3