2016-12-02 14:57:37 +01:00
<!doctype html>
2019-07-23 14:38:29 +02:00
< html >
< head >
< meta charset = 'utf-8' >
2019-09-25 16:30:33 +02:00
< title > peer-id 0.13.3 | Documentation< / title >
2019-07-23 14:38:29 +02:00
< meta name = 'description' content = 'IPFS Peer Id implementation in Node.js' >
< meta name = 'viewport' content = 'width=device-width,initial-scale=1' >
< link href = 'assets/bass.css' rel = 'stylesheet' >
< link href = 'assets/style.css' rel = 'stylesheet' >
< link href = 'assets/github.css' rel = 'stylesheet' >
< link href = 'assets/split.css' rel = 'stylesheet' >
< / head >
< body class = 'documentation m0' >
< div class = 'flex' >
< div id = 'split-left' class = 'overflow-auto fs0 height-viewport-100' >
< div class = 'py1 px2' >
< h3 class = 'mb0 no-anchor' > peer-id< / h3 >
2019-09-25 16:30:33 +02:00
< div class = 'mb1' > < code > 0.13.3< / code > < / div >
2019-07-23 14:38:29 +02:00
< input
placeholder='Filter'
id='filter-input'
class='col12 block input'
type='text' />
< div id = 'toc' >
< ul class = 'list-reset h5 py1-ul' >
< li > < a
href='#intro'
class="h5 bold black caps">
Intro
< / a >
< / li >
< / ul >
< / div >
< div class = 'mt1 h6 quiet' >
< a href = 'https://documentation.js.org/reading-documentation.html' > Need help reading this?< / a >
< / div >
< / div >
< / div >
< div id = 'split-right' class = 'relative overflow-auto height-viewport-100' >
< div class = 'keyline-top-not py2' > < section class = 'py2 clearfix' >
< h2 id = 'intro' class = 'mt0' >
Intro
< / h2 >
< p > Installable via < code > npm install --save peer-id< / code > , it can also be used directly in the browser.< / p >
2017-09-07 14:52:08 +01:00
< h2 > Download< / h2 >
< p > The source is available for download from < a href = "https://github.com/libp2p/js-peer-id.git" > GitHub< / a > . Alternatively, you can install using npm:< / p >
< pre class = 'hljs' > $ npm install --save peer-id< / pre >
< p > You can then < code > require()< / code > peer-id as normal:< / p >
< pre class = 'hljs' > < span class = "hljs-keyword" > const< / span > peerId = < span class = "hljs-built_in" > require< / span > (< span class = "hljs-string" > 'peer-id'< / span > )< / pre >
< h2 > In the Browser< / h2 >
< p > Peer-id should work in any ES2015 environment out of the box.< / p >
< p > Usage:< / p >
2019-07-11 18:26:28 +01:00
< pre class = 'hljs' > < span class = "hljs-tag" > < < span class = "hljs-name" > script< / span > < span class = "hljs-attr" > type< / span > =< span class = "hljs-string" > "text/javascript"< / span > < span class = "hljs-attr" > src< / span > =< span class = "hljs-string" > "index.js"< / span > > < / span > < span class = "hljs-tag" > < /< span class = "hljs-name" > script< / span > > < / span > < / pre >
< p > The portable versions of peer-id, including < code > index.js< / code > and < code > index.min.js< / code > , are included in the < code > /dist< / code > folder. Peer-id can also be found on < a href = "https://unpkg.com" > unpkg.com< / a > under< / p >
2017-09-07 14:52:08 +01:00
< ul >
< li > < a href = "https://unpkg.com/peer-id/dist/index.min.js" > https://unpkg.com/peer-id/dist/index.min.js< / a > < / li >
< li > < a href = "https://unpkg.com/peer-id/dist/index.js" > https://unpkg.com/peer-id/dist/index.js< / a > < / li >
< / ul >
2019-07-23 14:38:29 +02:00
< / section > < / div >
< / div >
< / div >
< script src = 'assets/anchor.js' > < / script >
< script src = 'assets/split.js' > < / script >
< script src = 'assets/site.js' > < / script >
< / body >
< / html >