indexer: update and fix documentation

This commit is contained in:
Braydon Fuller 2019-05-16 10:25:58 -07:00
parent 662a68cf10
commit 34e8f22b9b
No known key found for this signature in database
GPG Key ID: F24F232D108B3AD4
3 changed files with 8 additions and 7 deletions

View File

@ -1,5 +1,5 @@
/*! /*!
* addrindexer.js - addr indexer * addrindexer.js - address indexer for bcoin
* Copyright (c) 2018, the bcoin developers (MIT License). * Copyright (c) 2018, the bcoin developers (MIT License).
* https://github.com/bcoin-org/bcoin * https://github.com/bcoin-org/bcoin
*/ */

View File

@ -1,5 +1,5 @@
/*! /*!
* indexer.js - storage for indexes * indexer.js - abstract interface for bcoin indexers
* Copyright (c) 2018, the bcoin developers (MIT License). * Copyright (c) 2018, the bcoin developers (MIT License).
* https://github.com/bcoin-org/bcoin * https://github.com/bcoin-org/bcoin
*/ */
@ -21,11 +21,12 @@ const {ZERO_HASH} = require('../protocol/consensus');
/** /**
* Indexer * Indexer
* The class which indexers inherit from and implement the
* `indexBlock` and `unindexBlock` methods and database
* and storage initialization for indexing blocks.
* @alias module:indexer.Indexer * @alias module:indexer.Indexer
* @extends EventEmitter * @extends EventEmitter
* @property {IndexerDB} db * @abstract
* @property {Number} height
* @emits Indexer#chain tip
*/ */
class Indexer extends EventEmitter { class Indexer extends EventEmitter {
@ -121,7 +122,7 @@ class Indexer extends EventEmitter {
} }
/** /**
* Close the indexdb, wait for the database to close. * Close the indexer, wait for the database to close.
* @returns {Promise} * @returns {Promise}
*/ */

View File

@ -1,5 +1,5 @@
/*! /*!
* txindexer.js - tx indexer * txindexer.js - transaction indexer for bcoin
* Copyright (c) 2018, the bcoin developers (MIT License). * Copyright (c) 2018, the bcoin developers (MIT License).
* https://github.com/bcoin-org/bcoin * https://github.com/bcoin-org/bcoin
*/ */