Novices Performing Miracles

    @nervos/observables
    TypeScript icon, indicating that this package has built-in type declarations

    0.20.1 • Public • Published

    Travis npm MIT AppChain

    Nervos-Observables

    Observable based CITA RPC toolkit

    Features

    • Supports Observable API

    Installing

    $ yarn add @nervos/observables

    Example

    import NervosObservables from 'nervos-observables'
    
    const SERVER = 'localhost:1337'
    const INTERVAL = 10
    const RESERVED_RECORDS = 10
    
    const nervosObservables = new NervosObservables({
      server: SERVER,
      interval: INTERVAL,
      reservedRecords: RESERVED_RECORDS,
    })
    
    /**
     * @function peerCount
     * @description subscribe to the count of peer
     * @param {string} interval - interval of observable
     * @param {boolean} observed - switch of observable, default to true, observing the peerCount
     * @return {string} count - peer count
     */
    nervosObservables.peerCount(INTERVAL).subscribe(count => {
      console.log(count)
    })
    
    /**
     * @function newBlockNumber
     * @description subscribe to the latest block number
     * @param {string} interval - interval of observable
     * @param {boolean} observed - switch of observable, default to true, observing the new block number
     * @return {string} blockNumber - block number
     */
    nervosObservables.newBlockNumber(INTERVAL).subscribe(blockNumber => {
      console.log(blockNumber)
    })
    
    /**
     * @function blockByNumber
     * @description request block by block number
     * @param {string} blockNumber
     * @return {object} block
     */
    nervosObservables.blockByNumber(blockNumber).subscribe(block => {
      console.log(block)
    })
    
    /**
     * @function newBlockByNumber
     * @description subscribe to lastest block
     * @param {string} interval - interval of observable
     * @param {boolean} observed - switch of observable, default to true, observing the new block
     * @return {object} block
     */
    nervosObservables.newBlockByNumber(INTERVAL).subscribe(block => {
      console.log(block)
    })
    
    /**
     * @function blockByHash
     * @description request block by block hash
     * @param {string} hash - block hash
     * @return {object} block
     */
    nervosObservables.blockByHash(HASH).subscribe(block => {
      console.log(block)
    })
    
    /**
     * @function sendSignedTransaction
     * @description send signed transaction
     * @param {string} signedTransaction - signed transaction
     * @return {object} result
     */
    nervosObservables.sendSignedTransaction(signedTransaction).subscribe(result => {
      console.log(result)
    })
    
    /**
     * @function newBlockByNumberSubject
     * @description subscribe to new block
     */
    nervosObservable.newBlockByNumberSubject.subscribe(console.log)
    nervosObservable.newBlockByNumberSubject.connect()

    Keywords

    none

    Install

    npm i @nervos/observables

    DownloadsWeekly Downloads

    29

    Version

    0.20.1

    License

    MIT

    Unpacked Size

    14.9 kB

    Total Files

    12

    Last publish

    Collaborators

    • keith_chen
    • madayao