docs/module-UnspentOutputsApi.html

   1 <!DOCTYPE html>
   2
   3 <html lang="en">
   4 <head>
   5         <meta charset="utf-8">
   6         <meta name="viewport" content="width=device-width">
   7         <title>Bytom Node.js SDK Module: UnspentOutputsApi</title>
   8
   9         <!--[if lt IE 9]>
  10         <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  11         <![endif]-->
  12         <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
  13
  14         <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
  15
  16 </head>
  17
  18 <body>
  19
  20 <div class="navbar navbar-default navbar-fixed-top ">
  21 <div class="container">
  22         <div class="navbar-header">
  23                 <a class="navbar-brand" href="index.html">Bytom Node.js SDK</a>
  24                 <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  25                         <span class="icon-bar"></span>
  26                         <span class="icon-bar"></span>
  27                         <span class="icon-bar"></span>
  28         </button>
  29         </div>
  30         <div class="navbar-collapse collapse" id="topNavigation">
  31                 <ul class="nav navbar-nav">
  32
  33                         <li class="dropdown">
  34                                 <a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
  35                                 <ul class="dropdown-menu ">
  36                                         <li><a href="module-AccessTokensApi.html">AccessTokensApi</a></li><li><a href="module-AccountsApi.html">AccountsApi</a></li><li><a href="module-AssetsApi.html">AssetsApi</a></li><li><a href="module-BalancesApi.html">BalancesApi</a></li><li><a href="module-KeysApi.html">KeysApi</a></li><li><a href="module-TransactionsApi.html">TransactionsApi</a></li><li><a href="module-UnspentOutputsApi.html">UnspentOutputsApi</a></li>
  37                                 </ul>
  38                         </li>
  39
  40                         <li class="dropdown">
  41                                 <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
  42                                 <ul class="dropdown-menu ">
  43                                         <li><a href="global.html">Global</a></li>
  44                                 </ul>
  45                         </li>
  46
  47                 </ul>
  48
  49             <div class="col-sm-3 col-md-3">
  50                 <form class="navbar-form" role="search">
  51                     <div class="input-group">
  52                         <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
  53                         <div class="input-group-btn">
  54                             <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
  55                         </div>
  56                     </div>
  57                 </form>
  58             </div>
  59
  60         </div>
  61
  62 </div>
  63 </div>
  64
  65
  66 <div class="container" id="toc-content">
  67 <div class="row">
  68
  69
  70         <div class="col-md-8">
  71
  72                 <div id="main">
  73
  74
  75         <h1 class="page-title">Module: UnspentOutputsApi</h1>
  76 <section>
  77
  78 <header>
  79
  80 </header>
  81
  82
  83 <article>
  84     <div class="container-overview">
  85
  86
  87             <div class="description"><p>API for interacting with <a href="global.html#UnspentOutput">unspent outputs</a>.</p></div>
  88
  89
  90
  91 <dl class="details">
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127 </dl>
 128
 129
 130
 131
 132     </div>
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147         <h3 class="subsection-title">Methods</h3>
 148
 149         <dl>
 150
 151 <hr>
 152 <dt>
 153     <h4 class="name" id="~list"><span class="type-signature">&lt;inner> </span>list()</h4>
 154
 155
 156 </dt>
 157 <dd>
 158
 159
 160     <div class="description">
 161         <p>Get all unspent outputs.</p>
 162     </div>
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173 <dl class="details">
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209 </dl>
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223     <h5>Returns:</h5>
 224
 225
 226 <div class="param-desc">
 227     <p>Target unspent outputs.</p>
 228 </div>
 229
 230
 231
 232 <dl>
 233     <dt>
 234         Type
 235     </dt>
 236     <dd>
 237
 238 <span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#UnspentOutput">UnspentOutput</a>>></span>
 239
 240
 241
 242     </dd>
 243 </dl>
 244
 245
 246
 247
 248
 249 </dd>
 250
 251
 252
 253 <hr>
 254 <dt>
 255     <h4 class="name" id="~listById"><span class="type-signature">&lt;inner> </span>listById(id)</h4>
 256
 257
 258 </dt>
 259 <dd>
 260
 261
 262     <div class="description">
 263         <p>Get target unspent outputs by id.</p>
 264     </div>
 265
 266
 267
 268
 269
 270
 271
 272
 273         <h5>Parameters:</h5>
 274
 275
 276 <table class="params table table-striped">
 277     <thead>
 278     <tr>
 279
 280         <th>Name</th>
 281
 282
 283         <th>Type</th>
 284
 285
 286
 287
 288
 289         <th class="last">Description</th>
 290     </tr>
 291     </thead>
 292
 293     <tbody>
 294
 295
 296         <tr>
 297
 298                 <td class="name"><code>id</code></td>
 299
 300
 301             <td class="type">
 302
 303
 304 <span class="param-type">String</span>
 305
 306
 307
 308
 309             </td>
 310
 311
 312
 313
 314
 315             <td class="description last"><p>Unspent output id.</p></td>
 316         </tr>
 317
 318
 319     </tbody>
 320 </table>
 321
 322
 323
 324
 325 <dl class="details">
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361 </dl>
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375     <h5>Returns:</h5>
 376
 377
 378 <div class="param-desc">
 379     <p>Target unspent outputs.</p>
 380 </div>
 381
 382
 383
 384 <dl>
 385     <dt>
 386         Type
 387     </dt>
 388     <dd>
 389
 390 <span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#UnspentOutput">UnspentOutput</a>>></span>
 391
 392
 393
 394     </dd>
 395 </dl>
 396
 397
 398
 399
 400
 401 </dd>
 402
 403         </dl>
 404
 405
 406
 407
 408
 409 </article>
 410
 411 </section>
 412
 413
 414
 415
 416                 </div>
 417         </div>
 418
 419         <div class="clearfix"></div>
 420
 421
 422                 <div class="col-md-3">
 423                         <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
 424                 </div>
 425
 426
 427 </div>
 428 </div>
 429
 430
 431     <div class="modal fade" id="searchResults">
 432       <div class="modal-dialog">
 433         <div class="modal-content">
 434           <div class="modal-header">
 435             <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
 436             <h4 class="modal-title">Search results</h4>
 437           </div>
 438           <div class="modal-body"></div>
 439           <div class="modal-footer">
 440             <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
 441           </div>
 442         </div><!-- /.modal-content -->
 443       </div><!-- /.modal-dialog -->
 444     </div>
 445
 446
 447 <footer>
 448
 449
 450 <span class="jsdoc-message">
 451         Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 452
 453                 on 2018-05-24T14:05:00+08:00
 454
 455         using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 456 </span>
 457 </footer>
 458
 459 <script src="scripts/docstrap.lib.js"></script>
 460 <script src="scripts/toc.js"></script>
 461
 462     <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
 463
 464
 465 <script>
 466 $( function () {
 467         $( "[id*='$']" ).each( function () {
 468                 var $this = $( this );
 469
 470                 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
 471         } );
 472
 473         $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
 474                 var $this = $( this );
 475
 476                 var example = $this.find( "code" );
 477                 exampleText = example.html();
 478                 var lang = /{@lang (.*?)}/.exec( exampleText );
 479                 if ( lang && lang[1] ) {
 480                         exampleText = exampleText.replace( lang[0], "" );
 481                         example.html( exampleText );
 482                         lang = lang[1];
 483                 } else {
 484                         var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
 485                         lang = langClassMatch ? langClassMatch[1] : "javascript";
 486                 }
 487
 488                 if ( lang ) {
 489
 490                         $this
 491                         .addClass( "sunlight-highlight-" + lang )
 492                         .addClass( "linenums" )
 493                         .html( example.html() );
 494
 495                 }
 496         } );
 497
 498         Sunlight.highlightAll( {
 499                 lineNumbers : true,
 500                 showMenu : true,
 501                 enableDoclinks : true
 502         } );
 503
 504         $.catchAnchorLinks( {
 505         navbarOffset: 10
 506         } );
 507         $( "#toc" ).toc( {
 508                 anchorName  : function ( i, heading, prefix ) {
 509                         return $( heading ).attr( "id" ) || ( prefix + i );
 510                 },
 511                 selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
 512                 showAndHide : false,
 513                 smoothScrolling: true
 514         } );
 515
 516         $( "#main span[id^='toc']" ).addClass( "toc-shim" );
 517         $( '.dropdown-toggle' ).dropdown();
 518
 519     $( "table" ).each( function () {
 520       var $this = $( this );
 521       $this.addClass('table');
 522     } );
 523
 524 } );
 525 </script>
 526
 527
 528
 529 <!--Navigation and Symbol Display-->
 530
 531
 532 <!--Google Analytics-->
 533
 534
 535
 536     <script type="text/javascript">
 537         $(document).ready(function() {
 538             SearcherDisplay.init();
 539         });
 540     </script>
 541
 542
 543 </body>
 544 </html>