Files
api/docs/rpc-provider/classes/_ws_index_.wsprovider.html
T
2019-02-22 12:38:17 +00:00

3256 lines
93 KiB
HTML

<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>WsProvider · Polkadot API Book</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="GitBook 3.2.3">
<link rel="stylesheet" href="../../gitbook/style.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-insert-logo-link/plugin.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-sunlight-highlighter/sunlight.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="../../gitbook/gitbook-plugin-fontsettings/website.css">
<link rel="stylesheet" href="../../styles/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../../gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="../../gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="../../types/" />
<link rel="prev" href="_http_index_.httpprovider.html" />
</head>
<body>
<div class="book">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="header">Packages</li>
<li class="chapter " data-level="1.1" data-path="../../">
<a href="../../">
Introduction
</a>
</li>
<li class="chapter " data-level="1.2" data-path="../../api/">
<a href="../../api/">
api
</a>
<ul class="articles">
<li class="chapter " data-level="1.2.1" data-path="../../api/classes/_promise_index_.apipromise.html">
<a href="../../api/classes/_promise_index_.apipromise.html">
ApiPromise
</a>
</li>
<li class="chapter " data-level="1.2.2" data-path="../../api/classes/_rx_index_.apirx.html">
<a href="../../api/classes/_rx_index_.apirx.html">
ApiRx
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.3" data-path="../">
<a href="../">
rpc-provider
</a>
<ul class="articles">
<li class="chapter " data-level="1.3.1" data-path="_http_index_.httpprovider.html">
<a href="_http_index_.httpprovider.html">
HttpProvider
</a>
</li>
<li class="chapter active" data-level="1.3.2" data-path="_ws_index_.wsprovider.html">
<a href="_ws_index_.wsprovider.html">
WsProvider
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="1.4" data-path="../../types/">
<a href="../../types/">
types (codec implementation)
</a>
</li>
<li class="header">Interfaces</li>
<li class="chapter " data-level="2.1" data-path="../../METHODS_RPC.html">
<a href="../../METHODS_RPC.html">
RPC
</a>
</li>
<li class="chapter " data-level="2.2" data-path="../../METHODS_STORAGE.html">
<a href="../../METHODS_STORAGE.html">
Chain state (runtime)
</a>
</li>
<li class="chapter " data-level="2.3" data-path="../../METHODS_EXTRINSICS.html">
<a href="../../METHODS_EXTRINSICS.html">
Extrinsics (runtime)
</a>
</li>
<li class="chapter " data-level="2.4" data-path="../../METHODS_EVENTS.html">
<a href="../../METHODS_EVENTS.html">
Events (runtime)
</a>
</li>
<li class="header">Examples</li>
<li class="chapter " data-level="3.1" data-path="../../examples/promise/">
<a href="../../examples/promise/">
ApiPromise
</a>
<ul class="articles">
<li class="chapter " data-level="3.1.1" data-path="../../examples/promise/01_simple_connect/">
<a href="../../examples/promise/01_simple_connect/">
Simple connect
</a>
</li>
<li class="chapter " data-level="3.1.2" data-path="../../examples/promise/02_listen_to_blocks/">
<a href="../../examples/promise/02_listen_to_blocks/">
Listen to blocks
</a>
</li>
<li class="chapter " data-level="3.1.3" data-path="../../examples/promise/03_listen_to_balance_change/">
<a href="../../examples/promise/03_listen_to_balance_change/">
Listen to balance change
</a>
</li>
<li class="chapter " data-level="3.1.4" data-path="../../examples/promise/04_unsubscribe/">
<a href="../../examples/promise/04_unsubscribe/">
Unsubscribe from listening
</a>
</li>
<li class="chapter " data-level="3.1.5" data-path="../../examples/promise/05_read_storage/">
<a href="../../examples/promise/05_read_storage/">
Read chain state
</a>
</li>
<li class="chapter " data-level="3.1.6" data-path="../../examples/promise/06_make_transfer/">
<a href="../../examples/promise/06_make_transfer/">
Make a transfer
</a>
</li>
<li class="chapter " data-level="3.1.7" data-path="../../examples/promise/08_system_events/">
<a href="../../examples/promise/08_system_events/">
Display system events
</a>
</li>
<li class="chapter " data-level="3.1.8" data-path="../../examples/promise/09_transfer_events/">
<a href="../../examples/promise/09_transfer_events/">
Transaction with events
</a>
</li>
<li class="chapter " data-level="3.1.9" data-path="../../examples/promise/10_upgrade_chain/">
<a href="../../examples/promise/10_upgrade_chain/">
Upgrade via sudo
</a>
</li>
</ul>
</li>
<li class="chapter " data-level="3.2" data-path="../../examples/rx/">
<a href="../../examples/rx/">
ApiRx
</a>
<ul class="articles">
<li class="chapter " data-level="3.2.1" data-path="../../examples/rx/01_simple_connect/">
<a href="../../examples/rx/01_simple_connect/">
Simple connect
</a>
</li>
<li class="chapter " data-level="3.2.2" data-path="../../examples/rx/02_listen_to_blocks/">
<a href="../../examples/rx/02_listen_to_blocks/">
Listen to blocks
</a>
</li>
<li class="chapter " data-level="3.2.3" data-path="../../examples/rx/03_listen_to_balance_change/">
<a href="../../examples/rx/03_listen_to_balance_change/">
Listen to balance change
</a>
</li>
<li class="chapter " data-level="3.2.4" data-path="../../examples/rx/04_unsubscribe/">
<a href="../../examples/rx/04_unsubscribe/">
Unsubscribe from listening
</a>
</li>
<li class="chapter " data-level="3.2.5" data-path="../../examples/rx/05_read_storage/">
<a href="../../examples/rx/05_read_storage/">
Read chain state
</a>
</li>
<li class="chapter " data-level="3.2.6" data-path="../../examples/rx/06_make_transfer/">
<a href="../../examples/rx/06_make_transfer/">
Make a transfer
</a>
</li>
<li class="chapter " data-level="3.2.7" data-path="../../examples/rx/08_system_events/">
<a href="../../examples/rx/08_system_events/">
Display system events
</a>
</li>
<li class="chapter " data-level="3.2.8" data-path="../../examples/rx/09_transfer_events/">
<a href="../../examples/rx/09_transfer_events/">
Transaction with events
</a>
</li>
<li class="chapter " data-level="3.2.9" data-path="../../examples/rx/10_upgrade_chain/">
<a href="../../examples/rx/10_upgrade_chain/">
Upgrade via sudo
</a>
</li>
</ul>
</li>
<li class="divider"></li>
<li class="chapter " data-level="4.1" data-path="../../types/classes/_codec_base_.base.html">
<a href="../../types/classes/_codec_base_.base.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.2" data-path="../../types/classes/_codec_compact_.compact.html">
<a href="../../types/classes/_codec_compact_.compact.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.3" data-path="../../types/classes/_codec_enum_.enum.html">
<a href="../../types/classes/_codec_enum_.enum.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.4" data-path="../../types/classes/_codec_enumtype_.enumtype.html">
<a href="../../types/classes/_codec_enumtype_.enumtype.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.5" data-path="../../types/classes/_codec_int_.int.html">
<a href="../../types/classes/_codec_int_.int.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.6" data-path="../../types/classes/_codec_option_.option.html">
<a href="../../types/classes/_codec_option_.option.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.7" data-path="../../types/classes/_codec_set_.set.html">
<a href="../../types/classes/_codec_set_.set.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.8" data-path="../../types/classes/_codec_struct_.struct.html">
<a href="../../types/classes/_codec_struct_.struct.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.9" data-path="../../types/classes/_codec_tuple_.tuple.html">
<a href="../../types/classes/_codec_tuple_.tuple.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.10" data-path="../../types/classes/_codec_typeregistry_.typeregistry.html">
<a href="../../types/classes/_codec_typeregistry_.typeregistry.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.11" data-path="../../types/classes/_codec_u8a_.u8a.html">
<a href="../../types/classes/_codec_u8a_.u8a.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.12" data-path="../../types/classes/_codec_u8afixed_.u8afixed.html">
<a href="../../types/classes/_codec_u8afixed_.u8afixed.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.13" data-path="../../types/classes/_codec_uint_.uint.html">
<a href="../../types/classes/_codec_uint_.uint.html">
hidden
</a>
</li>
<li class="chapter " data-level="4.14" data-path="../../types/classes/_codec_vector_.vector.html">
<a href="../../types/classes/_codec_vector_.vector.html">
hidden
</a>
</li>
<li class="divider"></li>
<li class="chapter " data-level="5.1" data-path="../../types/classes/_primitive_bool_.bool.html">
<a href="../../types/classes/_primitive_bool_.bool.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.2" data-path="../../types/classes/_primitive_bytes_.bytes.html">
<a href="../../types/classes/_primitive_bytes_.bytes.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.3" data-path="../../types/classes/_primitive_data_.data.html">
<a href="../../types/classes/_primitive_data_.data.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.4" data-path="../../types/classes/_primitive_h160_.h160.html">
<a href="../../types/classes/_primitive_h160_.h160.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.5" data-path="../../types/classes/_primitive_h256_.h256.html">
<a href="../../types/classes/_primitive_h256_.h256.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.6" data-path="../../types/classes/_primitive_h512_.h512.html">
<a href="../../types/classes/_primitive_h512_.h512.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.7" data-path="../../types/classes/_primitive_i128_.i128.html">
<a href="../../types/classes/_primitive_i128_.i128.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.8" data-path="../../types/classes/_primitive_i16_.i16.html">
<a href="../../types/classes/_primitive_i16_.i16.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.9" data-path="../../types/classes/_primitive_i256_.i256.html">
<a href="../../types/classes/_primitive_i256_.i256.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.10" data-path="../../types/classes/_primitive_i32_.i32.html">
<a href="../../types/classes/_primitive_i32_.i32.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.11" data-path="../../types/classes/_primitive_i64_.i64.html">
<a href="../../types/classes/_primitive_i64_.i64.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.12" data-path="../../types/classes/_primitive_i8_.i8.html">
<a href="../../types/classes/_primitive_i8_.i8.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.13" data-path="../../types/classes/_primitive_method_.method.html">
<a href="../../types/classes/_primitive_method_.method.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.14" data-path="../../types/classes/_primitive_method_.methodindex.html">
<a href="../../types/classes/_primitive_method_.methodindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.15" data-path="../../types/classes/_primitive_moment_.moment.html">
<a href="../../types/classes/_primitive_moment_.moment.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.16" data-path="../../types/classes/_primitive_null_.null.html">
<a href="../../types/classes/_primitive_null_.null.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.17" data-path="../../types/classes/_primitive_storagedata_.storagedata.html">
<a href="../../types/classes/_primitive_storagedata_.storagedata.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.18" data-path="../../types/classes/_primitive_storagekey_.storagekey.html">
<a href="../../types/classes/_primitive_storagekey_.storagekey.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.19" data-path="../../types/classes/_primitive_text_.text.html">
<a href="../../types/classes/_primitive_text_.text.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.20" data-path="../../types/classes/_primitive_type_.type.html">
<a href="../../types/classes/_primitive_type_.type.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.21" data-path="../../types/classes/_primitive_u128_.u128.html">
<a href="../../types/classes/_primitive_u128_.u128.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.22" data-path="../../types/classes/_primitive_u16_.u16.html">
<a href="../../types/classes/_primitive_u16_.u16.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.23" data-path="../../types/classes/_primitive_u256_.u256.html">
<a href="../../types/classes/_primitive_u256_.u256.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.24" data-path="../../types/classes/_primitive_u32_.u32.html">
<a href="../../types/classes/_primitive_u32_.u32.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.25" data-path="../../types/classes/_primitive_u64_.u64.html">
<a href="../../types/classes/_primitive_u64_.u64.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.26" data-path="../../types/classes/_primitive_u8_.u8.html">
<a href="../../types/classes/_primitive_u8_.u8.html">
hidden
</a>
</li>
<li class="chapter " data-level="5.27" data-path="../../types/classes/_primitive_usize_.usize.html">
<a href="../../types/classes/_primitive_usize_.usize.html">
hidden
</a>
</li>
<li class="divider"></li>
<li class="chapter " data-level="6.1" data-path="../../types/classes/_type_header_.headerextended.html">
<a href="../../types/classes/_type_header_.headerextended.html">
hidden
</a>
</li>
<li class="chapter " data-level="6.2" data-path="../../api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html">
<a href="../../api-derive/classes/_democracy_referenduminfo_.referenduminfoextended.html">
hidden
</a>
</li>
<li class="divider"></li>
<li class="chapter " data-level="7.1" data-path="../../types/classes/_metadata_index_.metadata.html">
<a href="../../types/classes/_metadata_index_.metadata.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.2" data-path="../../types/classes/_metadata_magicnumber_.magicnumber.html">
<a href="../../types/classes/_metadata_magicnumber_.magicnumber.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.3" data-path="../../types/classes/_metadata_metadataversioned_.metadataversioned.html">
<a href="../../types/classes/_metadata_metadataversioned_.metadataversioned.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.4" data-path="../../types/classes/_metadata_v0_calls_.outerdispatchcall.html">
<a href="../../types/classes/_metadata_v0_calls_.outerdispatchcall.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.5" data-path="../../types/classes/_metadata_v0_calls_.outerdispatchmetadata.html">
<a href="../../types/classes/_metadata_v0_calls_.outerdispatchmetadata.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.6" data-path="../../types/classes/_metadata_v0_events_.eventmetadata.html">
<a href="../../types/classes/_metadata_v0_events_.eventmetadata.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.7" data-path="../../types/classes/_metadata_v0_events_.outereventmetadata.html">
<a href="../../types/classes/_metadata_v0_events_.outereventmetadata.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.8" data-path="../../types/classes/_metadata_v0_events_.outereventmetadataevent.html">
<a href="../../types/classes/_metadata_v0_events_.outereventmetadataevent.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.9" data-path="../../types/classes/_metadata_v0_index_.metadatav0.html">
<a href="../../types/classes/_metadata_v0_index_.metadatav0.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.10" data-path="../../types/classes/_metadata_v0_modules_.callmetadata.html">
<a href="../../types/classes/_metadata_v0_modules_.callmetadata.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.11" data-path="../../types/classes/_metadata_v0_modules_.functionargumentmetadata.html">
<a href="../../types/classes/_metadata_v0_modules_.functionargumentmetadata.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.12" data-path="../../types/classes/_metadata_v0_modules_.functionmetadata.html">
<a href="../../types/classes/_metadata_v0_modules_.functionmetadata.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.13" data-path="../../types/classes/_metadata_v0_modules_.,maptype.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="7.14" data-path="../../types/classes/_metadata_v0_modules_.modulemetadata.html">
<a href="../../types/classes/_metadata_v0_modules_.modulemetadata.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.15" data-path="../../types/classes/_metadata_v0_modules_.runtimemodulemetadata.html">
<a href="../../types/classes/_metadata_v0_modules_.runtimemodulemetadata.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.16" data-path="../../types/classes/_metadata_v0_modules_.storagefunctionmetadata.html">
<a href="../../types/classes/_metadata_v0_modules_.storagefunctionmetadata.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.17" data-path="../../types/classes/_metadata_v0_modules_.storagefunctionmodifier.html">
<a href="../../types/classes/_metadata_v0_modules_.storagefunctionmodifier.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.18" data-path="../../types/classes/_metadata_v0_modules_.storagefunctiontype.html">
<a href="../../types/classes/_metadata_v0_modules_.storagefunctiontype.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.19" data-path="../../types/classes/_metadata_v0_modules_.storagefunctiontype_map.md">
<span>
hidden
</a>
</li>
<li class="chapter " data-level="7.20" data-path="../../types/classes/_metadata_v0_modules_.storagemetadata.html">
<a href="../../types/classes/_metadata_v0_modules_.storagemetadata.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.21" data-path="../../types/classes/_metadata_v1_calls_.metadatacall.html">
<a href="../../types/classes/_metadata_v1_calls_.metadatacall.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.22" data-path="../../types/classes/_metadata_v1_calls_.metadatacallarg.html">
<a href="../../types/classes/_metadata_v1_calls_.metadatacallarg.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.23" data-path="../../types/classes/_metadata_v1_events_.metadataevent.html">
<a href="../../types/classes/_metadata_v1_events_.metadataevent.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.24" data-path="../../types/classes/_metadata_v1_index_.metadatamodule.html">
<a href="../../types/classes/_metadata_v1_index_.metadatamodule.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.25" data-path="../../types/classes/_metadata_v1_index_.metadatav1.html">
<a href="../../types/classes/_metadata_v1_index_.metadatav1.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.26" data-path="../../types/classes/_metadata_v1_storage_.default.html">
<a href="../../types/classes/_metadata_v1_storage_.default.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.27" data-path="../../types/classes/_metadata_v1_storage_.maptype.html">
<a href="../../types/classes/_metadata_v1_storage_.maptype.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.28" data-path="../../types/classes/_metadata_v1_storage_.metadatastorage.html">
<a href="../../types/classes/_metadata_v1_storage_.metadatastorage.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.29" data-path="../../types/classes/_metadata_v1_storage_.metadatastoragemodifier.html">
<a href="../../types/classes/_metadata_v1_storage_.metadatastoragemodifier.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.30" data-path="../../types/classes/_metadata_v1_storage_.metadatastoragetype.html">
<a href="../../types/classes/_metadata_v1_storage_.metadatastoragetype.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.31" data-path="../../types/classes/_metadata_v1_storage_.optional.html">
<a href="../../types/classes/_metadata_v1_storage_.optional.html">
hidden
</a>
</li>
<li class="chapter " data-level="7.32" data-path="../../types/classes/_metadata_v1_storage_.plaintype.html">
<a href="../../types/classes/_metadata_v1_storage_.plaintype.html">
hidden
</a>
</li>
<li class="divider"></li>
<li class="chapter " data-level="8.1" data-path="../../types/classes/_type_accountid_.accountid.html">
<a href="../../types/classes/_type_accountid_.accountid.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.2" data-path="../../types/classes/_type_accountid_.accountidof.html">
<a href="../../types/classes/_type_accountid_.accountidof.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.3" data-path="../../types/classes/_type_accountindex_.accountindex.html">
<a href="../../types/classes/_type_accountindex_.accountindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.4" data-path="../../types/classes/_type_address_.address.html">
<a href="../../types/classes/_type_address_.address.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.5" data-path="../../types/classes/_type_amount_.amount.html">
<a href="../../types/classes/_type_amount_.amount.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.6" data-path="../../types/classes/_type_assetof_.assetof.html">
<a href="../../types/classes/_type_assetof_.assetof.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.7" data-path="../../types/classes/_type_attestedcandidate_.attestedcandidate.html">
<a href="../../types/classes/_type_attestedcandidate_.attestedcandidate.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.8" data-path="../../types/classes/_type_attestedcandidate_.availabilityvote.html">
<a href="../../types/classes/_type_attestedcandidate_.availabilityvote.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.9" data-path="../../types/classes/_type_attestedcandidate_.balanceupload.html">
<a href="../../types/classes/_type_attestedcandidate_.balanceupload.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.10" data-path="../../types/classes/_type_attestedcandidate_.candidatereceipt.html">
<a href="../../types/classes/_type_attestedcandidate_.candidatereceipt.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.11" data-path="../../types/classes/_type_attestedcandidate_.candidatesignature.html">
<a href="../../types/classes/_type_attestedcandidate_.candidatesignature.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.12" data-path="../../types/classes/_type_attestedcandidate_.egressqueueroot.html">
<a href="../../types/classes/_type_attestedcandidate_.egressqueueroot.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.13" data-path="../../types/classes/_type_attestedcandidate_.explicitcandidatesignature.html">
<a href="../../types/classes/_type_attestedcandidate_.explicitcandidatesignature.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.14" data-path="../../types/classes/_type_attestedcandidate_.headdata.html">
<a href="../../types/classes/_type_attestedcandidate_.headdata.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.15" data-path="../../types/classes/_type_attestedcandidate_.implicitcandidatesignature.html">
<a href="../../types/classes/_type_attestedcandidate_.implicitcandidatesignature.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.16" data-path="../../types/classes/_type_attestedcandidate_.validityattestation.html">
<a href="../../types/classes/_type_attestedcandidate_.validityattestation.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.17" data-path="../../types/classes/_type_attestedcandidate_.validityvote.html">
<a href="../../types/classes/_type_attestedcandidate_.validityvote.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.18" data-path="../../types/classes/_type_authorityid_.authorityid.html">
<a href="../../types/classes/_type_authorityid_.authorityid.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.19" data-path="../../types/classes/_type_balance_.balance.html">
<a href="../../types/classes/_type_balance_.balance.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.20" data-path="../../types/classes/_type_balance_.balanceof.html">
<a href="../../types/classes/_type_balance_.balanceof.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.21" data-path="../../types/classes/_type_bft_.bftauthoritysignature.html">
<a href="../../types/classes/_type_bft_.bftauthoritysignature.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.22" data-path="../../types/classes/_type_bft_.bfthashsignature.html">
<a href="../../types/classes/_type_bft_.bfthashsignature.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.23" data-path="../../types/classes/_type_block_.block.html">
<a href="../../types/classes/_type_block_.block.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.24" data-path="../../types/classes/_type_blocknumber_.blocknumber.html">
<a href="../../types/classes/_type_blocknumber_.blocknumber.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.25" data-path="../../types/classes/_type_chainproperties_.chainproperties.html">
<a href="../../types/classes/_type_chainproperties_.chainproperties.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.26" data-path="../../types/classes/_type_codehash_.codehash.html">
<a href="../../types/classes/_type_codehash_.codehash.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.27" data-path="../../types/classes/_type_digest_.authoritieschange.html">
<a href="../../types/classes/_type_digest_.authoritieschange.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.28" data-path="../../types/classes/_type_digest_.changestrieroot.html">
<a href="../../types/classes/_type_digest_.changestrieroot.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.29" data-path="../../types/classes/_type_digest_.digest.html">
<a href="../../types/classes/_type_digest_.digest.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.30" data-path="../../types/classes/_type_digest_.digestitem.html">
<a href="../../types/classes/_type_digest_.digestitem.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.31" data-path="../../types/classes/_type_digest_.other.html">
<a href="../../types/classes/_type_digest_.other.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.32" data-path="../../types/classes/_type_digest_.seal.html">
<a href="../../types/classes/_type_digest_.seal.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.33" data-path="../../types/classes/_type_event_.event.html">
<a href="../../types/classes/_type_event_.event.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.34" data-path="../../types/classes/_type_event_.eventdata.html">
<a href="../../types/classes/_type_event_.eventdata.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.35" data-path="../../types/classes/_type_event_.eventindex.html">
<a href="../../types/classes/_type_event_.eventindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.36" data-path="../../types/classes/_type_eventrecord_.applyextrinsic.html">
<a href="../../types/classes/_type_eventrecord_.applyextrinsic.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.37" data-path="../../types/classes/_type_eventrecord_.eventrecord.html">
<a href="../../types/classes/_type_eventrecord_.eventrecord.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.38" data-path="../../types/classes/_type_eventrecord_.finalization.html">
<a href="../../types/classes/_type_eventrecord_.finalization.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.39" data-path="../../types/classes/_type_eventrecord_.phase.html">
<a href="../../types/classes/_type_eventrecord_.phase.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.40" data-path="../../types/classes/_type_extrinsic_.extrinsic.html">
<a href="../../types/classes/_type_extrinsic_.extrinsic.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.41" data-path="../../types/classes/_type_extrinsicera_.extrinsicera.html">
<a href="../../types/classes/_type_extrinsicera_.extrinsicera.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.42" data-path="../../types/classes/_type_extrinsics_.extrinsics.html">
<a href="../../types/classes/_type_extrinsics_.extrinsics.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.43" data-path="../../types/classes/_type_extrinsicsignature_.extrinsicsignature.html">
<a href="../../types/classes/_type_extrinsicsignature_.extrinsicsignature.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.44" data-path="../../types/classes/_type_extrinsicstatus_.broadcast.html">
<a href="../../types/classes/_type_extrinsicstatus_.broadcast.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.45" data-path="../../types/classes/_type_extrinsicstatus_.dropped.html">
<a href="../../types/classes/_type_extrinsicstatus_.dropped.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.46" data-path="../../types/classes/_type_extrinsicstatus_.extrinsicstatus.html">
<a href="../../types/classes/_type_extrinsicstatus_.extrinsicstatus.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.47" data-path="../../types/classes/_type_extrinsicstatus_.finalised.html">
<a href="../../types/classes/_type_extrinsicstatus_.finalised.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.48" data-path="../../types/classes/_type_extrinsicstatus_.future.html">
<a href="../../types/classes/_type_extrinsicstatus_.future.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.49" data-path="../../types/classes/_type_extrinsicstatus_.invalid.html">
<a href="../../types/classes/_type_extrinsicstatus_.invalid.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.50" data-path="../../types/classes/_type_extrinsicstatus_.ready.html">
<a href="../../types/classes/_type_extrinsicstatus_.ready.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.51" data-path="../../types/classes/_type_extrinsicstatus_.usurped.html">
<a href="../../types/classes/_type_extrinsicstatus_.usurped.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.52" data-path="../../types/classes/_type_gas_.gas.html">
<a href="../../types/classes/_type_gas_.gas.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.53" data-path="../../types/classes/_type_hash_.hash.html">
<a href="../../types/classes/_type_hash_.hash.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.54" data-path="../../types/classes/_type_header_.header.html">
<a href="../../types/classes/_type_header_.header.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.55" data-path="../../types/classes/_type_health_.health.html">
<a href="../../types/classes/_type_health_.health.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.56" data-path="../../types/classes/_type_inherentofflinereport_.inherentofflinereport.html">
<a href="../../types/classes/_type_inherentofflinereport_.inherentofflinereport.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.57" data-path="../../types/classes/_type_justification_.justification.html">
<a href="../../types/classes/_type_justification_.justification.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.58" data-path="../../types/classes/_type_justification_.rhdjustification.html">
<a href="../../types/classes/_type_justification_.rhdjustification.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.59" data-path="../../types/classes/_type_keyvalue_.keyvalue.html">
<a href="../../types/classes/_type_keyvalue_.keyvalue.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.60" data-path="../../types/classes/_type_keyvalue_.keyvalueoption.html">
<a href="../../types/classes/_type_keyvalue_.keyvalueoption.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.61" data-path="../../types/classes/_type_lockperiods_.lockperiods.html">
<a href="../../types/classes/_type_lockperiods_.lockperiods.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.62" data-path="../../types/classes/_type_misbehaviorreport_.bftatreport.html">
<a href="../../types/classes/_type_misbehaviorreport_.bftatreport.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.63" data-path="../../types/classes/_type_misbehaviorreport_.bftdoublecommit.html">
<a href="../../types/classes/_type_misbehaviorreport_.bftdoublecommit.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.64" data-path="../../types/classes/_type_misbehaviorreport_.bftdoubleprepare.html">
<a href="../../types/classes/_type_misbehaviorreport_.bftdoubleprepare.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.65" data-path="../../types/classes/_type_misbehaviorreport_.bftdoublepropose.html">
<a href="../../types/classes/_type_misbehaviorreport_.bftdoublepropose.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.66" data-path="../../types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html">
<a href="../../types/classes/_type_misbehaviorreport_.bftproposeoutofturn.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.67" data-path="../../types/classes/_type_misbehaviorreport_.misbehaviorkind.html">
<a href="../../types/classes/_type_misbehaviorreport_.misbehaviorkind.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.68" data-path="../../types/classes/_type_misbehaviorreport_.misbehaviorreport.html">
<a href="../../types/classes/_type_misbehaviorreport_.misbehaviorreport.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.69" data-path="../../types/classes/_type_newaccountoutcome_.newaccountoutcome.html">
<a href="../../types/classes/_type_newaccountoutcome_.newaccountoutcome.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.70" data-path="../../types/classes/_type_nonce_.nonce.html">
<a href="../../types/classes/_type_nonce_.nonce.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.71" data-path="../../types/classes/_type_noncecompact_.noncecompact.html">
<a href="../../types/classes/_type_noncecompact_.noncecompact.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.72" data-path="../../types/classes/_type_origin_.origin.html">
<a href="../../types/classes/_type_origin_.origin.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.73" data-path="../../types/classes/_type_paraid_.paraid.html">
<a href="../../types/classes/_type_paraid_.paraid.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.74" data-path="../../types/classes/_type_peerinfo_.peerinfo.html">
<a href="../../types/classes/_type_peerinfo_.peerinfo.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.75" data-path="../../types/classes/_type_pendingextrinsics_.pendingextrinsics.html">
<a href="../../types/classes/_type_pendingextrinsics_.pendingextrinsics.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.76" data-path="../../types/classes/_type_perbill_.perbill.html">
<a href="../../types/classes/_type_perbill_.perbill.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.77" data-path="../../types/classes/_type_permill_.permill.html">
<a href="../../types/classes/_type_permill_.permill.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.78" data-path="../../types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html">
<a href="../../types/classes/_type_prefabwasmmodule_.prefabwasmmodule.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.79" data-path="../../types/classes/_type_propindex_.propindex.html">
<a href="../../types/classes/_type_propindex_.propindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.80" data-path="../../types/classes/_type_proposal_.proposal.html">
<a href="../../types/classes/_type_proposal_.proposal.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.81" data-path="../../types/classes/_type_proposalindex_.proposalindex.html">
<a href="../../types/classes/_type_proposalindex_.proposalindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.82" data-path="../../types/classes/_type_referendumindex_.referendumindex.html">
<a href="../../types/classes/_type_referendumindex_.referendumindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.83" data-path="../../types/classes/_type_referenduminfo_.referenduminfo.html">
<a href="../../types/classes/_type_referenduminfo_.referenduminfo.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.84" data-path="../../types/classes/_type_runtimeversion_.apiid.html">
<a href="../../types/classes/_type_runtimeversion_.apiid.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.85" data-path="../../types/classes/_type_runtimeversion_.runtimeversion.html">
<a href="../../types/classes/_type_runtimeversion_.runtimeversion.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.86" data-path="../../types/classes/_type_runtimeversion_.runtimeversionapi.html">
<a href="../../types/classes/_type_runtimeversion_.runtimeversionapi.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.87" data-path="../../types/classes/_type_schedule_.schedule.html">
<a href="../../types/classes/_type_schedule_.schedule.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.88" data-path="../../types/classes/_type_seedof_.seedof.html">
<a href="../../types/classes/_type_seedof_.seedof.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.89" data-path="../../types/classes/_type_sessionkey_.sessionkey.html">
<a href="../../types/classes/_type_sessionkey_.sessionkey.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.90" data-path="../../types/classes/_type_signature_.ed25519signature.html">
<a href="../../types/classes/_type_signature_.ed25519signature.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.91" data-path="../../types/classes/_type_signature_.signature.html">
<a href="../../types/classes/_type_signature_.signature.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.92" data-path="../../types/classes/_type_signature_.sr25519signature.html">
<a href="../../types/classes/_type_signature_.sr25519signature.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.93" data-path="../../types/classes/_type_signaturepayload_.signaturepayload.html">
<a href="../../types/classes/_type_signaturepayload_.signaturepayload.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.94" data-path="../../types/classes/_type_signedblock_.signedblock.html">
<a href="../../types/classes/_type_signedblock_.signedblock.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.95" data-path="../../types/classes/_type_storagechangeset_.storagechangeset.html">
<a href="../../types/classes/_type_storagechangeset_.storagechangeset.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.96" data-path="../../types/classes/_type_storedpendingchange_.nextauthority.html">
<a href="../../types/classes/_type_storedpendingchange_.nextauthority.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.97" data-path="../../types/classes/_type_storedpendingchange_.storedpendingchange.html">
<a href="../../types/classes/_type_storedpendingchange_.storedpendingchange.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.98" data-path="../../types/classes/_type_validatorprefs_.validatorprefs.html">
<a href="../../types/classes/_type_validatorprefs_.validatorprefs.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.99" data-path="../../types/classes/_type_vestingschedule_.vestingschedule.html">
<a href="../../types/classes/_type_vestingschedule_.vestingschedule.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.100" data-path="../../types/classes/_type_vote_.vote.html">
<a href="../../types/classes/_type_vote_.vote.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.101" data-path="../../types/classes/_type_voteindex_.voteindex.html">
<a href="../../types/classes/_type_voteindex_.voteindex.html">
hidden
</a>
</li>
<li class="chapter " data-level="8.102" data-path="../../types/classes/_type_votethreshold_.votethreshold.html">
<a href="../../types/classes/_type_votethreshold_.votethreshold.html">
hidden
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
Published with GitBook
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="../.." >WsProvider</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h1 id="polkadotrpc-providerws">@polkadot/rpc-provider/ws</h1>
<p><em><strong>name</strong></em>: WsProvider</p>
<p><em><strong>description</strong></em>: The WebSocket Provider allows sending requests using WebSocket to a WebSocket RPC server TCP port. Unlike the <a href="_http_index_.httpprovider.html">HttpProvider</a>, it does support subscriptions and allows listening to events such as new blocks or balance changes.</p>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">Api</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/api/promise&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">import</span>&#xA0;<span class="sunlight-ident">WsProvider</span>&#xA0;<span class="sunlight-ident">from</span>&#xA0;<span class="sunlight-string">&apos;@polkadot/rpc-provider/ws&apos;</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;ws://127.0.0.1:9944&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">api</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">Api</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">provider</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
</span></pre></div></div></code></pre>
<p><em><strong>see</strong></em>: <a href="_http_index_.httpprovider.html">HttpProvider</a></p>
<h1 id="hierarchy">Hierarchy</h1>
<p><strong>WsProvider</strong></p>
<h1 id="implements">Implements</h1>
<ul>
<li><code>WSProviderInterface</code></li>
</ul>
<h1 id="constructors">Constructors</h1>
<p><a id="constructor"></a></p>
<h2 id="constructor">constructor</h2>
<p>&#x2295; <strong>new WsProvider</strong>(endpoint?: <em><code>string</code></em>, autoConnect?: <em><code>boolean</code></em>): <a href="_ws_index_.wsprovider.html">WsProvider</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d86b9c8/packages/rpc-provider/src/ws/index.ts#L75" target="_blank">ws/index.ts:75</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Default value</code> endpoint</td>
<td><code>string</code></td>
<td>defaults.WS_URL</td>
<td>The endpoint url. Usually `ws://ip:9944` or `wss://ip:9944`</td>
</tr>
<tr>
<td><code>Default value</code> autoConnect</td>
<td><code>boolean</code></td>
<td>true</td>
<td>Whether to connect automatically or not.</td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <a href="_ws_index_.wsprovider.html">WsProvider</a></p>
<hr>
<h1 id="accessors">Accessors</h1>
<p><a id="hassubscriptions"></a></p>
<h2 id="hassubscriptions">hasSubscriptions</h2>
<p>gethasSubscriptions(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d86b9c8/packages/rpc-provider/src/ws/index.ts#L101" target="_blank">ws/index.ts:101</a></em></p>
<p><em><strong>summary</strong></em>: <code>true</code> when this provider supports subscriptions</p>
<p><strong>Returns:</strong> <code>boolean</code></p>
<hr>
<h1 id="methods">Methods</h1>
<p><a id="clone"></a></p>
<h2 id="clone">clone</h2>
<p>&#x25B8; <strong>clone</strong>(): <a href="_ws_index_.wsprovider.html">WsProvider</a></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d86b9c8/packages/rpc-provider/src/ws/index.ts#L108" target="_blank">ws/index.ts:108</a></em></p>
<p><em><strong>description</strong></em>: Returns a clone of the object</p>
<p><strong>Returns:</strong> <a href="_ws_index_.wsprovider.html">WsProvider</a></p>
<hr>
<p><a id="connect"></a></p>
<h2 id="connect">connect</h2>
<p>&#x25B8; <strong>connect</strong>(): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d86b9c8/packages/rpc-provider/src/ws/index.ts#L117" target="_blank">ws/index.ts:117</a></em></p>
<p><em><strong>summary</strong></em>: Manually connect</p>
<p><em><strong>description</strong></em>: The <a href="_ws_index_.wsprovider.html">WsProvider</a> connects automatically by default, however if you decided otherwise, you may connect manually using this method.</p>
<p><strong>Returns:</strong> <code>void</code></p>
<hr>
<p><a id="disconnect"></a></p>
<h2 id="disconnect">disconnect</h2>
<p>&#x25B8; <strong>disconnect</strong>(): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d86b9c8/packages/rpc-provider/src/ws/index.ts#L133" target="_blank">ws/index.ts:133</a></em></p>
<p><em><strong>description</strong></em>: Manually disconnect from the connection, clearing autoconnect logic</p>
<p><strong>Returns:</strong> <code>void</code></p>
<hr>
<p><a id="isconnected"></a></p>
<h2 id="isconnected">isConnected</h2>
<p>&#x25B8; <strong>isConnected</strong>(): <code>boolean</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d86b9c8/packages/rpc-provider/src/ws/index.ts#L150" target="_blank">ws/index.ts:150</a></em></p>
<p><em><strong>summary</strong></em>: Whether the node is connected or not.</p>
<p><strong>Returns:</strong> <code>boolean</code>
true if connected</p>
<hr>
<p><a id="on"></a></p>
<h2 id="on">on</h2>
<p>&#x25B8; <strong>on</strong>(type: <em><a href="../modules/_types_.md#providerinterface_emitted">ProviderInterface$Emitted</a></em>, sub: <em><a href="../modules/_types_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></em>): <code>void</code></p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d86b9c8/packages/rpc-provider/src/ws/index.ts#L159" target="_blank">ws/index.ts:159</a></em></p>
<p><em><strong>summary</strong></em>: Listens on events after having subscribed using the <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a> function.</p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td><a href="../modules/_types_.md#providerinterface_emitted">ProviderInterface$Emitted</a></td>
<td>Event</td>
</tr>
<tr>
<td>sub</td>
<td><a href="../modules/_types_.md#providerinterface_emitcb">ProviderInterface$EmitCb</a></td>
<td>Callback</td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <code>void</code></p>
<hr>
<p><a id="send"></a></p>
<h2 id="send">send</h2>
<p>&#x25B8; <strong>send</strong>(method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, subscription?: <em><code>SubscriptionHandler</code></em>): <code>Promise</code>&lt;<code>any</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d86b9c8/packages/rpc-provider/src/ws/index.ts#L169" target="_blank">ws/index.ts:169</a></em></p>
<p><em><strong>summary</strong></em>: Send JSON data using WebSockets to configured HTTP Endpoint or queue.</p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>method</td>
<td><code>string</code></td>
<td>The RPC methods to execute</td>
</tr>
<tr>
<td>params</td>
<td><code>Array</code>&lt;<code>any</code>&gt;</td>
<td>Encoded paramaters as appliucable for the method</td>
</tr>
<tr>
<td><code>Optional</code> subscription</td>
<td><code>SubscriptionHandler</code></td>
<td>Subscription details (internally used)</td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <code>Promise</code>&lt;<code>any</code>&gt;</p>
<hr>
<p><a id="subscribe"></a></p>
<h2 id="subscribe">subscribe</h2>
<p>&#x25B8; <strong>subscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, params: <em><code>Array</code>&lt;<code>any</code>&gt;</em>, callback: <em><a href="../modules/_types_.md#providerinterface_callback">ProviderInterface$Callback</a></em>): <code>Promise</code>&lt;<code>number</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d86b9c8/packages/rpc-provider/src/ws/index.ts#L223" target="_blank">ws/index.ts:223</a></em></p>
<p><em><strong>name</strong></em>: subscribe</p>
<p><em><strong>summary</strong></em>: Allows subscribing to a specific event.</p>
<p><em><strong>example</strong></em>: </p>
<pre><code class="lang-javascript"><div class="sunlight-container sunlight-theme-gitbook"><div class="sunlight-code-container"><pre class="sunlight-highlight-javascript sunlight-highlighted"><span class="sunlight-javascript"><span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">provider</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">WsProvider</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;ws://127.0.0.1:9944&apos;</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-reservedWord">const</span>&#xA0;<span class="sunlight-ident">rpc</span>&#xA0;<span class="sunlight-operator">=</span>&#xA0;<span class="sunlight-keyword">new</span>&#xA0;<span class="sunlight-ident">Rpc</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">provider</span><span class="sunlight-punctuation">)</span><span class="sunlight-punctuation">;</span>
<span class="sunlight-ident">rpc</span><span class="sunlight-operator">.</span><span class="sunlight-ident">state</span><span class="sunlight-operator">.</span><span class="sunlight-ident">subscribeStorage</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">[</span><span class="sunlight-punctuation">[</span><span class="sunlight-ident">storage</span><span class="sunlight-operator">.</span><span class="sunlight-ident">balances</span><span class="sunlight-operator">.</span><span class="sunlight-ident">freeBalance</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-operator">&lt;</span><span class="sunlight-ident">Address</span><span class="sunlight-operator">&gt;</span><span class="sunlight-punctuation">]</span><span class="sunlight-punctuation">]</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-punctuation">(</span><span class="sunlight-ident">_</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">values</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">values</span><span class="sunlight-punctuation">)</span>
<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span><span class="sunlight-operator">.</span><span class="sunlight-ident">then</span><span class="sunlight-punctuation">(</span><span class="sunlight-punctuation">(</span><span class="sunlight-ident">subscriptionId</span><span class="sunlight-punctuation">)</span>&#xA0;<span class="sunlight-operator">=</span><span class="sunlight-operator">&gt;</span>&#xA0;<span class="sunlight-punctuation">{</span>
&#xA0;&#xA0;<span class="sunlight-ident">console</span><span class="sunlight-operator">.</span><span class="sunlight-ident">log</span><span class="sunlight-punctuation">(</span><span class="sunlight-string">&apos;balance&#xA0;changes&#xA0;subscription&#xA0;id:&#xA0;&apos;</span><span class="sunlight-punctuation">,</span>&#xA0;<span class="sunlight-ident">subscriptionId</span><span class="sunlight-punctuation">)</span>
<span class="sunlight-punctuation">}</span><span class="sunlight-punctuation">)</span>
</span></pre></div></div></code></pre>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td><code>string</code></td>
<td>Subscription type</td>
</tr>
<tr>
<td>method</td>
<td><code>string</code></td>
<td>Subscription method</td>
</tr>
<tr>
<td>params</td>
<td><code>Array</code>&lt;<code>any</code>&gt;</td>
<td>Parameters</td>
</tr>
<tr>
<td>callback</td>
<td><a href="../modules/_types_.md#providerinterface_callback">ProviderInterface$Callback</a></td>
<td>Callback</td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <code>Promise</code>&lt;<code>number</code>&gt;
Promise resolving to the dd of the subscription you can use with [[unsubscribe]].</p>
<hr>
<p><a id="unsubscribe"></a></p>
<h2 id="unsubscribe">unsubscribe</h2>
<p>&#x25B8; <strong>unsubscribe</strong>(type: <em><code>string</code></em>, method: <em><code>string</code></em>, id: <em><code>number</code></em>): <code>Promise</code>&lt;<code>boolean</code>&gt;</p>
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/d86b9c8/packages/rpc-provider/src/ws/index.ts#L232" target="_blank">ws/index.ts:232</a></em></p>
<p><em><strong>summary</strong></em>: Allows unsubscribing to subscriptions made with <a href="_ws_index_.wsprovider.html#subscribe">subscribe</a>.</p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td><code>string</code></td>
</tr>
<tr>
<td>method</td>
<td><code>string</code></td>
</tr>
<tr>
<td>id</td>
<td><code>number</code></td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <code>Promise</code>&lt;<code>boolean</code>&gt;</p>
<hr>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="_http_index_.httpprovider.html" class="navigation navigation-prev " aria-label="Previous page: HttpProvider">
<i class="fa fa-angle-left"></i>
</a>
<a href="../../types/" class="navigation navigation-next " aria-label="Next page: types (codec implementation)">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"WsProvider","level":"1.3.2","depth":2,"next":{"title":"types (codec implementation)","level":"1.4","depth":1,"path":"types/README.md","ref":"types/README.md","articles":[]},"previous":{"title":"HttpProvider","level":"1.3.1","depth":2,"path":"rpc-provider/classes/_http_index_.httpprovider.md","ref":"rpc-provider/classes/_http_index_.httpprovider.md","articles":[]},"dir":"ltr"},"config":{"plugins":["include-codeblock","insert-logo-link","mermaid-gb3","-highlight","sunlight-highlighter"],"root":"docs","styles":{"website":"styles/website.css"},"pluginsConfig":{"insert-logo-link":{"src":"/api/logo.png","url":"https://polkadot.js.org"},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"mermaid-gb3":{},"include-codeblock":{"check":false,"edit":false,"lang":"","fixlang":false,"template":"default","theme":"chrome","unindent":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"sunlight-highlighter":{"theme":"gitbook","lineNumbers":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"rpc-provider/classes/_ws_index_.wsprovider.md","mtime":"2019-02-22T12:34:43.365Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-02-22T12:36:10.626Z"},"basePath":"../..","book":{"language":""}});
});
</script>
</div>
<script src="../../gitbook/gitbook.js"></script>
<script src="../../gitbook/theme.js"></script>
<script src="../../gitbook/gitbook-plugin-insert-logo-link/plugin.js"></script>
<script src="../../gitbook/gitbook-plugin-mermaid-gb3/book/plugin.js"></script>
<script src="../../gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="../../gitbook/gitbook-plugin-search/search.js"></script>
<script src="../../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="../../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="../../gitbook/gitbook-plugin-sharing/buttons.js"></script>
<script src="../../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
<script src="../../gitbook/gitbook-plugin-mermaid-gb3/mermaid/mermaid.min.js"></script>
</body>
</html>