UNPKG

glitter-sdk-js

Version:

A light client which talks to your Glitter over Http

150 lines (135 loc) 7.75 kB
<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Welcome to glitter-sdk-js’s documentation! &mdash; glitter-sdk-js documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="_static/tabs.css" type="text/css" /> <!--[if lt IE 9]> <script src="_static/js/html5shiv.min.js"></script> <![endif]--> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/jquery.js"></script> <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> <script src="_static/js/theme.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Installation" href="install.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="#" class="icon icon-home"> glitter-sdk-js </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul> <li class="toctree-l1"><a class="reference external" href="https://glitterprotocol.io/">← glitternetwork</a></li> <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li> <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li> <li class="toctree-l1"><a class="reference internal" href="libref.html">Library Reference</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="#">glitter-sdk-js</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="#" class="icon icon-home"></a> &raquo;</li> <li>Welcome to glitter-sdk-js’s documentation!</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="welcome-to-glitter-sdk-js-s-documentation"> <h1>Welcome to glitter-sdk-js’s documentation!<a class="headerlink" href="#welcome-to-glitter-sdk-js-s-documentation" title="Permalink to this heading"></a></h1> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference external" href="https://glitterprotocol.io/">← glitternetwork</a></li> <li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul> <li class="toctree-l2"><a class="reference internal" href="install.html#installing-with-npm">Installing with NPM</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a><ul> <li class="toctree-l2"><a class="reference internal" href="quickstart.html#connection">1.Connection</a></li> <li class="toctree-l2"><a class="reference internal" href="quickstart.html#data-model">2.Data model</a></li> <li class="toctree-l2"><a class="reference internal" href="quickstart.html#put-doc">3.Put doc</a></li> <li class="toctree-l2"><a class="reference internal" href="quickstart.html#search">4.Search</a></li> <li class="toctree-l2"><a class="reference internal" href="quickstart.html#another-search-example">5.Another search example</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul> <li class="toctree-l2"><a class="reference internal" href="examples.html#getting-started">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#create-schema">Create Schema</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#show-schema">Show Schema</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#list-all-schema">List All Schema</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#put-document-to-glitter">Put Document to Glitter</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#check-whether-the-document-exists">Check Whether the Document Exists</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#simple-search-without-filter-condition">Simple Search without Filter Condition</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#app-status">App Status</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#search-transaction">Search Transaction</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#search-block">Search Block</a></li> <li class="toctree-l2"><a class="reference internal" href="examples.html#fetch-validator-status">Fetch Validator Status</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="libref.html">Library Reference</a><ul> <li class="toctree-l2"><a class="reference internal" href="libref.html#driver"><code class="docutils literal notranslate"><span class="pre">driver</span></code></a></li> </ul> </li> </ul> </div> </section> <section id="indices-and-tables"> <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this heading"></a></h1> <ul class="simple"> <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li> <li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li> <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li> </ul> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="install.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>&#169; Copyright 2022, glitter.</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>