xpub-generator
v1.3.2
Published
xpub-generator
Downloads
5
Readme
Using this module in other modules
Here is a quick example of how this module can be used in other modules. The TypeScript Module Resolution Logic makes it quite easy. The file src/index.ts
is a barrel that re-exports selected exports from other files. The package.json file contains main
attribute that points to the generated lib/index.js
file and typings
attribute that points to the generated lib/index.d.ts
file.
If you are planning to have code in multiple files (which is quite natural for a NodeJS module) that users can import, make sure you update
src/index.ts
file appropriately.
Now assuming you have published this amazing module to npm with the name xpub-generator
, and installed it in the module in which you need it -
- To use the
XPubGenerator
class in a TypeScript file -
import Bitcoin = require('bitcoinjs-lib');
import { XPubGenerator } from 'xpub-generator';
const g = new XPubGenerator('xpub....');
g.nthReceiving(1);
const gTestnet = new XPubGenerator('tpub...', Bitcoin.networks.testnet);
gTestnet.nthReceiving(1);
const gLitecoin = new XPubGenerator('tpub...', Bitcoin.networks.litecoin);
gLitecoin.nthReceiving(1);
- To use the
XPubGenerator
class in a JavaScript file -
const Bitcoin = require('bitcoinjs-lib')
const XPubGenerator = require('xpub-generator').XPubGenerator;
const g = new XPubGenerator('xpub...');
g.nthReceiving(1);
const gTestnet = new XPubGenerator('tpub...', Bitcoin.networks.testnet);
gTestnet.nthReceiving(1);
const gLitecoin = new XPubGenerator('tpub...', Bitcoin.networks.litecoin);
gLitecoin.nthReceiving(1);