js-conflux-sdk
Version:
JavaScript Conflux Software Development Kit
42 lines (41 loc) • 1.27 kB
TypeScript
export = providerFactory;
/**
* @param {object} options
* @param {string} options.url
* @param {boolean} [options.useWechatProvider] - Whether use wechat provider.
* @return {WebsocketProvider|HttpProvider|BaseProvider|WechatProvider}
*
* @example
* > providerFactory()
BaseProvider {
url: undefined,
timeout: 300000,
logger: { info: [Function: info], error: [Function: error] }
}
* @example
* > providerFactory({ url: 'http://localhost:12537' })
HttpProvider {
url: 'http://localhost:12537',
timeout: 300000,
logger: { info: [Function: info], error: [Function: error] }
}
* > providerFactory({
url: 'http://main.confluxrpc.org',
timeout: 60 * 60 * 1000,
logger: console,
}
HttpProvider {
url: 'http://main.confluxrpc.org',
timeout: 3600000,
logger: {...}
}
*/
declare function providerFactory({ url, useWechatProvider, ...rest }: {
url: string;
useWechatProvider?: boolean;
}): WebsocketProvider | HttpProvider | BaseProvider | WechatProvider;
import WebsocketProvider = require("./WebSocketProvider");
import HttpProvider = require("./HttpProvider");
import BaseProvider = require("./BaseProvider");
import WechatProvider = require("./WechatProvider");
//# sourceMappingURL=index.d.ts.map