mirror of
https://github.com/fluencelabs/js-libp2p-interfaces
synced 2025-06-28 19:31:54 +00:00
chore: update documentation
This commit is contained in:
Vasco Santos
350
assets/anchor.js
350
assets/anchor.js
@ -1,350 +0,0 @@
|
||||
/*!
|
||||
* AnchorJS - v4.0.0 - 2017-06-02
|
||||
* https://github.com/bryanbraun/anchorjs
|
||||
* Copyright (c) 2017 Bryan Braun; Licensed MIT
|
||||
*/
|
||||
/* eslint-env amd, node */
|
||||
|
||||
// https://github.com/umdjs/umd/blob/master/templates/returnExports.js
|
||||
(function (root, factory) {
|
||||
'use strict';
|
||||
if (typeof define === 'function' && define.amd) {
|
||||
// AMD. Register as an anonymous module.
|
||||
define([], factory);
|
||||
} else if (typeof module === 'object' && module.exports) {
|
||||
// Node. Does not work with strict CommonJS, but
|
||||
// only CommonJS-like environments that support module.exports,
|
||||
// like Node.
|
||||
module.exports = factory();
|
||||
} else {
|
||||
// Browser globals (root is window)
|
||||
root.AnchorJS = factory();
|
||||
root.anchors = new root.AnchorJS();
|
||||
}
|
||||
})(this, function () {
|
||||
'use strict';
|
||||
function AnchorJS(options) {
|
||||
this.options = options || {};
|
||||
this.elements = [];
|
||||
|
||||
/**
|
||||
* Assigns options to the internal options object, and provides defaults.
|
||||
* @param {Object} opts - Options object
|
||||
*/
|
||||
function _applyRemainingDefaultOptions(opts) {
|
||||
opts.icon = opts.hasOwnProperty('icon') ? opts.icon : '\ue9cb'; // Accepts characters (and also URLs?), like '#', '¶', '❡', or '§'.
|
||||
opts.visible = opts.hasOwnProperty('visible') ? opts.visible : 'hover'; // Also accepts 'always' & 'touch'
|
||||
opts.placement = opts.hasOwnProperty('placement')
|
||||
? opts.placement
|
||||
: 'right'; // Also accepts 'left'
|
||||
opts.class = opts.hasOwnProperty('class') ? opts.class : ''; // Accepts any class name.
|
||||
// Using Math.floor here will ensure the value is Number-cast and an integer.
|
||||
opts.truncate = opts.hasOwnProperty('truncate')
|
||||
? Math.floor(opts.truncate)
|
||||
: 64; // Accepts any value that can be typecast to a number.
|
||||
}
|
||||
|
||||
_applyRemainingDefaultOptions(this.options);
|
||||
|
||||
/**
|
||||
* Checks to see if this device supports touch. Uses criteria pulled from Modernizr:
|
||||
* https://github.com/Modernizr/Modernizr/blob/da22eb27631fc4957f67607fe6042e85c0a84656/feature-detects/touchevents.js#L40
|
||||
* @returns {Boolean} - true if the current device supports touch.
|
||||
*/
|
||||
this.isTouchDevice = function () {
|
||||
return !!(
|
||||
'ontouchstart' in window ||
|
||||
(window.DocumentTouch && document instanceof DocumentTouch)
|
||||
);
|
||||
};
|
||||
|
||||
/**
|
||||
* Add anchor links to page elements.
|
||||
* @param {String|Array|Nodelist} selector - A CSS selector for targeting the elements you wish to add anchor links
|
||||
* to. Also accepts an array or nodeList containing the relavant elements.
|
||||
* @returns {this} - The AnchorJS object
|
||||
*/
|
||||
this.add = function (selector) {
|
||||
var elements,
|
||||
elsWithIds,
|
||||
idList,
|
||||
elementID,
|
||||
i,
|
||||
index,
|
||||
count,
|
||||
tidyText,
|
||||
newTidyText,
|
||||
readableID,
|
||||
anchor,
|
||||
visibleOptionToUse,
|
||||
indexesToDrop = [];
|
||||
|
||||
// We reapply options here because somebody may have overwritten the default options object when setting options.
|
||||
// For example, this overwrites all options but visible:
|
||||
//
|
||||
// anchors.options = { visible: 'always'; }
|
||||
_applyRemainingDefaultOptions(this.options);
|
||||
|
||||
visibleOptionToUse = this.options.visible;
|
||||
if (visibleOptionToUse === 'touch') {
|
||||
visibleOptionToUse = this.isTouchDevice() ? 'always' : 'hover';
|
||||
}
|
||||
|
||||
// Provide a sensible default selector, if none is given.
|
||||
if (!selector) {
|
||||
selector = 'h2, h3, h4, h5, h6';
|
||||
}
|
||||
|
||||
elements = _getElements(selector);
|
||||
|
||||
if (elements.length === 0) {
|
||||
return this;
|
||||
}
|
||||
|
||||
_addBaselineStyles();
|
||||
|
||||
// We produce a list of existing IDs so we don't generate a duplicate.
|
||||
elsWithIds = document.querySelectorAll('[id]');
|
||||
idList = [].map.call(elsWithIds, function assign(el) {
|
||||
return el.id;
|
||||
});
|
||||
|
||||
for (i = 0; i < elements.length; i++) {
|
||||
if (this.hasAnchorJSLink(elements[i])) {
|
||||
indexesToDrop.push(i);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (elements[i].hasAttribute('id')) {
|
||||
elementID = elements[i].getAttribute('id');
|
||||
} else if (elements[i].hasAttribute('data-anchor-id')) {
|
||||
elementID = elements[i].getAttribute('data-anchor-id');
|
||||
} else {
|
||||
tidyText = this.urlify(elements[i].textContent);
|
||||
|
||||
// Compare our generated ID to existing IDs (and increment it if needed)
|
||||
// before we add it to the page.
|
||||
newTidyText = tidyText;
|
||||
count = 0;
|
||||
do {
|
||||
if (index !== undefined) {
|
||||
newTidyText = tidyText + '-' + count;
|
||||
}
|
||||
|
||||
index = idList.indexOf(newTidyText);
|
||||
count += 1;
|
||||
} while (index !== -1);
|
||||
index = undefined;
|
||||
idList.push(newTidyText);
|
||||
|
||||
elements[i].setAttribute('id', newTidyText);
|
||||
elementID = newTidyText;
|
||||
}
|
||||
|
||||
readableID = elementID.replace(/-/g, ' ');
|
||||
|
||||
// The following code builds the following DOM structure in a more effiecient (albeit opaque) way.
|
||||
// '<a class="anchorjs-link ' + this.options.class + '" href="#' + elementID + '" aria-label="Anchor link for: ' + readableID + '" data-anchorjs-icon="' + this.options.icon + '"></a>';
|
||||
anchor = document.createElement('a');
|
||||
anchor.className = 'anchorjs-link ' + this.options.class;
|
||||
anchor.href = '#' + elementID;
|
||||
anchor.setAttribute('aria-label', 'Anchor link for: ' + readableID);
|
||||
anchor.setAttribute('data-anchorjs-icon', this.options.icon);
|
||||
|
||||
if (visibleOptionToUse === 'always') {
|
||||
anchor.style.opacity = '1';
|
||||
}
|
||||
|
||||
if (this.options.icon === '\ue9cb') {
|
||||
anchor.style.font = '1em/1 anchorjs-icons';
|
||||
|
||||
// We set lineHeight = 1 here because the `anchorjs-icons` font family could otherwise affect the
|
||||
// height of the heading. This isn't the case for icons with `placement: left`, so we restore
|
||||
// line-height: inherit in that case, ensuring they remain positioned correctly. For more info,
|
||||
// see https://github.com/bryanbraun/anchorjs/issues/39.
|
||||
if (this.options.placement === 'left') {
|
||||
anchor.style.lineHeight = 'inherit';
|
||||
}
|
||||
}
|
||||
|
||||
if (this.options.placement === 'left') {
|
||||
anchor.style.position = 'absolute';
|
||||
anchor.style.marginLeft = '-1em';
|
||||
anchor.style.paddingRight = '0.5em';
|
||||
elements[i].insertBefore(anchor, elements[i].firstChild);
|
||||
} else {
|
||||
// if the option provided is `right` (or anything else).
|
||||
anchor.style.paddingLeft = '0.375em';
|
||||
elements[i].appendChild(anchor);
|
||||
}
|
||||
}
|
||||
|
||||
for (i = 0; i < indexesToDrop.length; i++) {
|
||||
elements.splice(indexesToDrop[i] - i, 1);
|
||||
}
|
||||
this.elements = this.elements.concat(elements);
|
||||
|
||||
return this;
|
||||
};
|
||||
|
||||
/**
|
||||
* Removes all anchorjs-links from elements targed by the selector.
|
||||
* @param {String|Array|Nodelist} selector - A CSS selector string targeting elements with anchor links,
|
||||
* OR a nodeList / array containing the DOM elements.
|
||||
* @returns {this} - The AnchorJS object
|
||||
*/
|
||||
this.remove = function (selector) {
|
||||
var index,
|
||||
domAnchor,
|
||||
elements = _getElements(selector);
|
||||
|
||||
for (var i = 0; i < elements.length; i++) {
|
||||
domAnchor = elements[i].querySelector('.anchorjs-link');
|
||||
if (domAnchor) {
|
||||
// Drop the element from our main list, if it's in there.
|
||||
index = this.elements.indexOf(elements[i]);
|
||||
if (index !== -1) {
|
||||
this.elements.splice(index, 1);
|
||||
}
|
||||
// Remove the anchor from the DOM.
|
||||
elements[i].removeChild(domAnchor);
|
||||
}
|
||||
}
|
||||
return this;
|
||||
};
|
||||
|
||||
/**
|
||||
* Removes all anchorjs links. Mostly used for tests.
|
||||
*/
|
||||
this.removeAll = function () {
|
||||
this.remove(this.elements);
|
||||
};
|
||||
|
||||
/**
|
||||
* Urlify - Refine text so it makes a good ID.
|
||||
*
|
||||
* To do this, we remove apostrophes, replace nonsafe characters with hyphens,
|
||||
* remove extra hyphens, truncate, trim hyphens, and make lowercase.
|
||||
*
|
||||
* @param {String} text - Any text. Usually pulled from the webpage element we are linking to.
|
||||
* @returns {String} - hyphen-delimited text for use in IDs and URLs.
|
||||
*/
|
||||
this.urlify = function (text) {
|
||||
// Regex for finding the nonsafe URL characters (many need escaping): & +$,:;=?@"#{}|^~[`%!'<>]./()*\
|
||||
var nonsafeChars = /[& +$,:;=?@"#{}|^~[`%!'<>\]\.\/\(\)\*\\]/g,
|
||||
urlText;
|
||||
|
||||
// The reason we include this _applyRemainingDefaultOptions is so urlify can be called independently,
|
||||
// even after setting options. This can be useful for tests or other applications.
|
||||
if (!this.options.truncate) {
|
||||
_applyRemainingDefaultOptions(this.options);
|
||||
}
|
||||
|
||||
// Note: we trim hyphens after truncating because truncating can cause dangling hyphens.
|
||||
// Example string: // " ⚡⚡ Don't forget: URL fragments should be i18n-friendly, hyphenated, short, and clean."
|
||||
urlText = text
|
||||
.trim() // "⚡⚡ Don't forget: URL fragments should be i18n-friendly, hyphenated, short, and clean."
|
||||
.replace(/\'/gi, '') // "⚡⚡ Dont forget: URL fragments should be i18n-friendly, hyphenated, short, and clean."
|
||||
.replace(nonsafeChars, '-') // "⚡⚡-Dont-forget--URL-fragments-should-be-i18n-friendly--hyphenated--short--and-clean-"
|
||||
.replace(/-{2,}/g, '-') // "⚡⚡-Dont-forget-URL-fragments-should-be-i18n-friendly-hyphenated-short-and-clean-"
|
||||
.substring(0, this.options.truncate) // "⚡⚡-Dont-forget-URL-fragments-should-be-i18n-friendly-hyphenated-"
|
||||
.replace(/^-+|-+$/gm, '') // "⚡⚡-Dont-forget-URL-fragments-should-be-i18n-friendly-hyphenated"
|
||||
.toLowerCase(); // "⚡⚡-dont-forget-url-fragments-should-be-i18n-friendly-hyphenated"
|
||||
|
||||
return urlText;
|
||||
};
|
||||
|
||||
/**
|
||||
* Determines if this element already has an AnchorJS link on it.
|
||||
* Uses this technique: http://stackoverflow.com/a/5898748/1154642
|
||||
* @param {HTMLElemnt} el - a DOM node
|
||||
* @returns {Boolean} true/false
|
||||
*/
|
||||
this.hasAnchorJSLink = function (el) {
|
||||
var hasLeftAnchor =
|
||||
el.firstChild &&
|
||||
(' ' + el.firstChild.className + ' ').indexOf(' anchorjs-link ') > -1,
|
||||
hasRightAnchor =
|
||||
el.lastChild &&
|
||||
(' ' + el.lastChild.className + ' ').indexOf(' anchorjs-link ') > -1;
|
||||
|
||||
return hasLeftAnchor || hasRightAnchor || false;
|
||||
};
|
||||
|
||||
/**
|
||||
* Turns a selector, nodeList, or array of elements into an array of elements (so we can use array methods).
|
||||
* It also throws errors on any other inputs. Used to handle inputs to .add and .remove.
|
||||
* @param {String|Array|Nodelist} input - A CSS selector string targeting elements with anchor links,
|
||||
* OR a nodeList / array containing the DOM elements.
|
||||
* @returns {Array} - An array containing the elements we want.
|
||||
*/
|
||||
function _getElements(input) {
|
||||
var elements;
|
||||
if (typeof input === 'string' || input instanceof String) {
|
||||
// See https://davidwalsh.name/nodelist-array for the technique transforming nodeList -> Array.
|
||||
elements = [].slice.call(document.querySelectorAll(input));
|
||||
// I checked the 'input instanceof NodeList' test in IE9 and modern browsers and it worked for me.
|
||||
} else if (Array.isArray(input) || input instanceof NodeList) {
|
||||
elements = [].slice.call(input);
|
||||
} else {
|
||||
throw new Error('The selector provided to AnchorJS was invalid.');
|
||||
}
|
||||
return elements;
|
||||
}
|
||||
|
||||
/**
|
||||
* _addBaselineStyles
|
||||
* Adds baseline styles to the page, used by all AnchorJS links irregardless of configuration.
|
||||
*/
|
||||
function _addBaselineStyles() {
|
||||
// We don't want to add global baseline styles if they've been added before.
|
||||
if (document.head.querySelector('style.anchorjs') !== null) {
|
||||
return;
|
||||
}
|
||||
|
||||
var style = document.createElement('style'),
|
||||
linkRule =
|
||||
' .anchorjs-link {' +
|
||||
' opacity: 0;' +
|
||||
' text-decoration: none;' +
|
||||
' -webkit-font-smoothing: antialiased;' +
|
||||
' -moz-osx-font-smoothing: grayscale;' +
|
||||
' }',
|
||||
hoverRule =
|
||||
' *:hover > .anchorjs-link,' +
|
||||
' .anchorjs-link:focus {' +
|
||||
' opacity: 1;' +
|
||||
' }',
|
||||
anchorjsLinkFontFace =
|
||||
' @font-face {' +
|
||||
' font-family: "anchorjs-icons";' + // Icon from icomoon; 10px wide & 10px tall; 2 empty below & 4 above
|
||||
' src: url(data:n/a;base64,AAEAAAALAIAAAwAwT1MvMg8yG2cAAAE4AAAAYGNtYXDp3gC3AAABpAAAAExnYXNwAAAAEAAAA9wAAAAIZ2x5ZlQCcfwAAAH4AAABCGhlYWQHFvHyAAAAvAAAADZoaGVhBnACFwAAAPQAAAAkaG10eASAADEAAAGYAAAADGxvY2EACACEAAAB8AAAAAhtYXhwAAYAVwAAARgAAAAgbmFtZQGOH9cAAAMAAAAAunBvc3QAAwAAAAADvAAAACAAAQAAAAEAAHzE2p9fDzz1AAkEAAAAAADRecUWAAAAANQA6R8AAAAAAoACwAAAAAgAAgAAAAAAAAABAAADwP/AAAACgAAA/9MCrQABAAAAAAAAAAAAAAAAAAAAAwABAAAAAwBVAAIAAAAAAAIAAAAAAAAAAAAAAAAAAAAAAAMCQAGQAAUAAAKZAswAAACPApkCzAAAAesAMwEJAAAAAAAAAAAAAAAAAAAAARAAAAAAAAAAAAAAAAAAAAAAQAAg//0DwP/AAEADwABAAAAAAQAAAAAAAAAAAAAAIAAAAAAAAAIAAAACgAAxAAAAAwAAAAMAAAAcAAEAAwAAABwAAwABAAAAHAAEADAAAAAIAAgAAgAAACDpy//9//8AAAAg6cv//f///+EWNwADAAEAAAAAAAAAAAAAAAAACACEAAEAAAAAAAAAAAAAAAAxAAACAAQARAKAAsAAKwBUAAABIiYnJjQ3NzY2MzIWFxYUBwcGIicmNDc3NjQnJiYjIgYHBwYUFxYUBwYGIwciJicmNDc3NjIXFhQHBwYUFxYWMzI2Nzc2NCcmNDc2MhcWFAcHBgYjARQGDAUtLXoWOR8fORYtLTgKGwoKCjgaGg0gEhIgDXoaGgkJBQwHdR85Fi0tOAobCgoKOBoaDSASEiANehoaCQkKGwotLXoWOR8BMwUFLYEuehYXFxYugC44CQkKGwo4GkoaDQ0NDXoaShoKGwoFBe8XFi6ALjgJCQobCjgaShoNDQ0NehpKGgobCgoKLYEuehYXAAAADACWAAEAAAAAAAEACAAAAAEAAAAAAAIAAwAIAAEAAAAAAAMACAAAAAEAAAAAAAQACAAAAAEAAAAAAAUAAQALAAEAAAAAAAYACAAAAAMAAQQJAAEAEAAMAAMAAQQJAAIABgAcAAMAAQQJAAMAEAAMAAMAAQQJAAQAEAAMAAMAAQQJAAUAAgAiAAMAAQQJAAYAEAAMYW5jaG9yanM0MDBAAGEAbgBjAGgAbwByAGoAcwA0ADAAMABAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAH//wAP) format("truetype");' +
|
||||
' }',
|
||||
pseudoElContent =
|
||||
' [data-anchorjs-icon]::after {' +
|
||||
' content: attr(data-anchorjs-icon);' +
|
||||
' }',
|
||||
firstStyleEl;
|
||||
|
||||
style.className = 'anchorjs';
|
||||
style.appendChild(document.createTextNode('')); // Necessary for Webkit.
|
||||
|
||||
// We place it in the head with the other style tags, if possible, so as to
|
||||
// not look out of place. We insert before the others so these styles can be
|
||||
// overridden if necessary.
|
||||
firstStyleEl = document.head.querySelector('[rel="stylesheet"], style');
|
||||
if (firstStyleEl === undefined) {
|
||||
document.head.appendChild(style);
|
||||
} else {
|
||||
document.head.insertBefore(style, firstStyleEl);
|
||||
}
|
||||
|
||||
style.sheet.insertRule(linkRule, style.sheet.cssRules.length);
|
||||
style.sheet.insertRule(hoverRule, style.sheet.cssRules.length);
|
||||
style.sheet.insertRule(pseudoElContent, style.sheet.cssRules.length);
|
||||
style.sheet.insertRule(anchorjsLinkFontFace, style.sheet.cssRules.length);
|
||||
}
|
||||
}
|
||||
|
||||
return AnchorJS;
|
||||
});
|
||||
@ -1,12 +0,0 @@
|
||||
.input {
|
||||
font-family: inherit;
|
||||
display: block;
|
||||
width: 100%;
|
||||
height: 2rem;
|
||||
padding: .5rem;
|
||||
margin-bottom: 1rem;
|
||||
border: 1px solid #ccc;
|
||||
font-size: .875rem;
|
||||
border-radius: 3px;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
544
assets/bass.css
544
assets/bass.css
@ -1,544 +0,0 @@
|
||||
/*! Basscss | http://basscss.com | MIT License */
|
||||
|
||||
.h1{ font-size: 2rem }
|
||||
.h2{ font-size: 1.5rem }
|
||||
.h3{ font-size: 1.25rem }
|
||||
.h4{ font-size: 1rem }
|
||||
.h5{ font-size: .875rem }
|
||||
.h6{ font-size: .75rem }
|
||||
|
||||
.font-family-inherit{ font-family:inherit }
|
||||
.font-size-inherit{ font-size:inherit }
|
||||
.text-decoration-none{ text-decoration:none }
|
||||
|
||||
.bold{ font-weight: bold; font-weight: bold }
|
||||
.regular{ font-weight:normal }
|
||||
.italic{ font-style:italic }
|
||||
.caps{ text-transform:uppercase; letter-spacing: .2em; }
|
||||
|
||||
.left-align{ text-align:left }
|
||||
.center{ text-align:center }
|
||||
.right-align{ text-align:right }
|
||||
.justify{ text-align:justify }
|
||||
|
||||
.nowrap{ white-space:nowrap }
|
||||
.break-word{ word-wrap:break-word }
|
||||
|
||||
.line-height-1{ line-height: 1 }
|
||||
.line-height-2{ line-height: 1.125 }
|
||||
.line-height-3{ line-height: 1.25 }
|
||||
.line-height-4{ line-height: 1.5 }
|
||||
|
||||
.list-style-none{ list-style:none }
|
||||
.underline{ text-decoration:underline }
|
||||
|
||||
.truncate{
|
||||
max-width:100%;
|
||||
overflow:hidden;
|
||||
text-overflow:ellipsis;
|
||||
white-space:nowrap;
|
||||
}
|
||||
|
||||
.list-reset{
|
||||
list-style:none;
|
||||
padding-left:0;
|
||||
}
|
||||
|
||||
.inline{ display:inline }
|
||||
.block{ display:block }
|
||||
.inline-block{ display:inline-block }
|
||||
.table{ display:table }
|
||||
.table-cell{ display:table-cell }
|
||||
|
||||
.overflow-hidden{ overflow:hidden }
|
||||
.overflow-scroll{ overflow:scroll }
|
||||
.overflow-auto{ overflow:auto }
|
||||
|
||||
.clearfix:before,
|
||||
.clearfix:after{
|
||||
content:" ";
|
||||
display:table
|
||||
}
|
||||
.clearfix:after{ clear:both }
|
||||
|
||||
.left{ float:left }
|
||||
.right{ float:right }
|
||||
|
||||
.fit{ max-width:100% }
|
||||
|
||||
.max-width-1{ max-width: 24rem }
|
||||
.max-width-2{ max-width: 32rem }
|
||||
.max-width-3{ max-width: 48rem }
|
||||
.max-width-4{ max-width: 64rem }
|
||||
|
||||
.border-box{ box-sizing:border-box }
|
||||
|
||||
.align-baseline{ vertical-align:baseline }
|
||||
.align-top{ vertical-align:top }
|
||||
.align-middle{ vertical-align:middle }
|
||||
.align-bottom{ vertical-align:bottom }
|
||||
|
||||
.m0{ margin:0 }
|
||||
.mt0{ margin-top:0 }
|
||||
.mr0{ margin-right:0 }
|
||||
.mb0{ margin-bottom:0 }
|
||||
.ml0{ margin-left:0 }
|
||||
.mx0{ margin-left:0; margin-right:0 }
|
||||
.my0{ margin-top:0; margin-bottom:0 }
|
||||
|
||||
.m1{ margin: .5rem }
|
||||
.mt1{ margin-top: .5rem }
|
||||
.mr1{ margin-right: .5rem }
|
||||
.mb1{ margin-bottom: .5rem }
|
||||
.ml1{ margin-left: .5rem }
|
||||
.mx1{ margin-left: .5rem; margin-right: .5rem }
|
||||
.my1{ margin-top: .5rem; margin-bottom: .5rem }
|
||||
|
||||
.m2{ margin: 1rem }
|
||||
.mt2{ margin-top: 1rem }
|
||||
.mr2{ margin-right: 1rem }
|
||||
.mb2{ margin-bottom: 1rem }
|
||||
.ml2{ margin-left: 1rem }
|
||||
.mx2{ margin-left: 1rem; margin-right: 1rem }
|
||||
.my2{ margin-top: 1rem; margin-bottom: 1rem }
|
||||
|
||||
.m3{ margin: 2rem }
|
||||
.mt3{ margin-top: 2rem }
|
||||
.mr3{ margin-right: 2rem }
|
||||
.mb3{ margin-bottom: 2rem }
|
||||
.ml3{ margin-left: 2rem }
|
||||
.mx3{ margin-left: 2rem; margin-right: 2rem }
|
||||
.my3{ margin-top: 2rem; margin-bottom: 2rem }
|
||||
|
||||
.m4{ margin: 4rem }
|
||||
.mt4{ margin-top: 4rem }
|
||||
.mr4{ margin-right: 4rem }
|
||||
.mb4{ margin-bottom: 4rem }
|
||||
.ml4{ margin-left: 4rem }
|
||||
.mx4{ margin-left: 4rem; margin-right: 4rem }
|
||||
.my4{ margin-top: 4rem; margin-bottom: 4rem }
|
||||
|
||||
.mxn1{ margin-left: -.5rem; margin-right: -.5rem; }
|
||||
.mxn2{ margin-left: -1rem; margin-right: -1rem; }
|
||||
.mxn3{ margin-left: -2rem; margin-right: -2rem; }
|
||||
.mxn4{ margin-left: -4rem; margin-right: -4rem; }
|
||||
|
||||
.ml-auto{ margin-left:auto }
|
||||
.mr-auto{ margin-right:auto }
|
||||
.mx-auto{ margin-left:auto; margin-right:auto; }
|
||||
|
||||
.p0{ padding:0 }
|
||||
.pt0{ padding-top:0 }
|
||||
.pr0{ padding-right:0 }
|
||||
.pb0{ padding-bottom:0 }
|
||||
.pl0{ padding-left:0 }
|
||||
.px0{ padding-left:0; padding-right:0 }
|
||||
.py0{ padding-top:0; padding-bottom:0 }
|
||||
|
||||
.p1{ padding: .5rem }
|
||||
.pt1{ padding-top: .5rem }
|
||||
.pr1{ padding-right: .5rem }
|
||||
.pb1{ padding-bottom: .5rem }
|
||||
.pl1{ padding-left: .5rem }
|
||||
.py1{ padding-top: .5rem; padding-bottom: .5rem }
|
||||
.px1{ padding-left: .5rem; padding-right: .5rem }
|
||||
|
||||
.p2{ padding: 1rem }
|
||||
.pt2{ padding-top: 1rem }
|
||||
.pr2{ padding-right: 1rem }
|
||||
.pb2{ padding-bottom: 1rem }
|
||||
.pl2{ padding-left: 1rem }
|
||||
.py2{ padding-top: 1rem; padding-bottom: 1rem }
|
||||
.px2{ padding-left: 1rem; padding-right: 1rem }
|
||||
|
||||
.p3{ padding: 2rem }
|
||||
.pt3{ padding-top: 2rem }
|
||||
.pr3{ padding-right: 2rem }
|
||||
.pb3{ padding-bottom: 2rem }
|
||||
.pl3{ padding-left: 2rem }
|
||||
.py3{ padding-top: 2rem; padding-bottom: 2rem }
|
||||
.px3{ padding-left: 2rem; padding-right: 2rem }
|
||||
|
||||
.p4{ padding: 4rem }
|
||||
.pt4{ padding-top: 4rem }
|
||||
.pr4{ padding-right: 4rem }
|
||||
.pb4{ padding-bottom: 4rem }
|
||||
.pl4{ padding-left: 4rem }
|
||||
.py4{ padding-top: 4rem; padding-bottom: 4rem }
|
||||
.px4{ padding-left: 4rem; padding-right: 4rem }
|
||||
|
||||
.col{
|
||||
float:left;
|
||||
box-sizing:border-box;
|
||||
}
|
||||
|
||||
.col-right{
|
||||
float:right;
|
||||
box-sizing:border-box;
|
||||
}
|
||||
|
||||
.col-1{
|
||||
width:8.33333%;
|
||||
}
|
||||
|
||||
.col-2{
|
||||
width:16.66667%;
|
||||
}
|
||||
|
||||
.col-3{
|
||||
width:25%;
|
||||
}
|
||||
|
||||
.col-4{
|
||||
width:33.33333%;
|
||||
}
|
||||
|
||||
.col-5{
|
||||
width:41.66667%;
|
||||
}
|
||||
|
||||
.col-6{
|
||||
width:50%;
|
||||
}
|
||||
|
||||
.col-7{
|
||||
width:58.33333%;
|
||||
}
|
||||
|
||||
.col-8{
|
||||
width:66.66667%;
|
||||
}
|
||||
|
||||
.col-9{
|
||||
width:75%;
|
||||
}
|
||||
|
||||
.col-10{
|
||||
width:83.33333%;
|
||||
}
|
||||
|
||||
.col-11{
|
||||
width:91.66667%;
|
||||
}
|
||||
|
||||
.col-12{
|
||||
width:100%;
|
||||
}
|
||||
@media (min-width: 40em){
|
||||
|
||||
.sm-col{
|
||||
float:left;
|
||||
box-sizing:border-box;
|
||||
}
|
||||
|
||||
.sm-col-right{
|
||||
float:right;
|
||||
box-sizing:border-box;
|
||||
}
|
||||
|
||||
.sm-col-1{
|
||||
width:8.33333%;
|
||||
}
|
||||
|
||||
.sm-col-2{
|
||||
width:16.66667%;
|
||||
}
|
||||
|
||||
.sm-col-3{
|
||||
width:25%;
|
||||
}
|
||||
|
||||
.sm-col-4{
|
||||
width:33.33333%;
|
||||
}
|
||||
|
||||
.sm-col-5{
|
||||
width:41.66667%;
|
||||
}
|
||||
|
||||
.sm-col-6{
|
||||
width:50%;
|
||||
}
|
||||
|
||||
.sm-col-7{
|
||||
width:58.33333%;
|
||||
}
|
||||
|
||||
.sm-col-8{
|
||||
width:66.66667%;
|
||||
}
|
||||
|
||||
.sm-col-9{
|
||||
width:75%;
|
||||
}
|
||||
|
||||
.sm-col-10{
|
||||
width:83.33333%;
|
||||
}
|
||||
|
||||
.sm-col-11{
|
||||
width:91.66667%;
|
||||
}
|
||||
|
||||
.sm-col-12{
|
||||
width:100%;
|
||||
}
|
||||
|
||||
}
|
||||
@media (min-width: 52em){
|
||||
|
||||
.md-col{
|
||||
float:left;
|
||||
box-sizing:border-box;
|
||||
}
|
||||
|
||||
.md-col-right{
|
||||
float:right;
|
||||
box-sizing:border-box;
|
||||
}
|
||||
|
||||
.md-col-1{
|
||||
width:8.33333%;
|
||||
}
|
||||
|
||||
.md-col-2{
|
||||
width:16.66667%;
|
||||
}
|
||||
|
||||
.md-col-3{
|
||||
width:25%;
|
||||
}
|
||||
|
||||
.md-col-4{
|
||||
width:33.33333%;
|
||||
}
|
||||
|
||||
.md-col-5{
|
||||
width:41.66667%;
|
||||
}
|
||||
|
||||
.md-col-6{
|
||||
width:50%;
|
||||
}
|
||||
|
||||
.md-col-7{
|
||||
width:58.33333%;
|
||||
}
|
||||
|
||||
.md-col-8{
|
||||
width:66.66667%;
|
||||
}
|
||||
|
||||
.md-col-9{
|
||||
width:75%;
|
||||
}
|
||||
|
||||
.md-col-10{
|
||||
width:83.33333%;
|
||||
}
|
||||
|
||||
.md-col-11{
|
||||
width:91.66667%;
|
||||
}
|
||||
|
||||
.md-col-12{
|
||||
width:100%;
|
||||
}
|
||||
|
||||
}
|
||||
@media (min-width: 64em){
|
||||
|
||||
.lg-col{
|
||||
float:left;
|
||||
box-sizing:border-box;
|
||||
}
|
||||
|
||||
.lg-col-right{
|
||||
float:right;
|
||||
box-sizing:border-box;
|
||||
}
|
||||
|
||||
.lg-col-1{
|
||||
width:8.33333%;
|
||||
}
|
||||
|
||||
.lg-col-2{
|
||||
width:16.66667%;
|
||||
}
|
||||
|
||||
.lg-col-3{
|
||||
width:25%;
|
||||
}
|
||||
|
||||
.lg-col-4{
|
||||
width:33.33333%;
|
||||
}
|
||||
|
||||
.lg-col-5{
|
||||
width:41.66667%;
|
||||
}
|
||||
|
||||
.lg-col-6{
|
||||
width:50%;
|
||||
}
|
||||
|
||||
.lg-col-7{
|
||||
width:58.33333%;
|
||||
}
|
||||
|
||||
.lg-col-8{
|
||||
width:66.66667%;
|
||||
}
|
||||
|
||||
.lg-col-9{
|
||||
width:75%;
|
||||
}
|
||||
|
||||
.lg-col-10{
|
||||
width:83.33333%;
|
||||
}
|
||||
|
||||
.lg-col-11{
|
||||
width:91.66667%;
|
||||
}
|
||||
|
||||
.lg-col-12{
|
||||
width:100%;
|
||||
}
|
||||
|
||||
}
|
||||
.flex{ display:-webkit-box; display:-webkit-flex; display:-ms-flexbox; display:flex }
|
||||
|
||||
@media (min-width: 40em){
|
||||
.sm-flex{ display:-webkit-box; display:-webkit-flex; display:-ms-flexbox; display:flex }
|
||||
}
|
||||
|
||||
@media (min-width: 52em){
|
||||
.md-flex{ display:-webkit-box; display:-webkit-flex; display:-ms-flexbox; display:flex }
|
||||
}
|
||||
|
||||
@media (min-width: 64em){
|
||||
.lg-flex{ display:-webkit-box; display:-webkit-flex; display:-ms-flexbox; display:flex }
|
||||
}
|
||||
|
||||
.flex-column{ -webkit-box-orient:vertical; -webkit-box-direction:normal; -webkit-flex-direction:column; -ms-flex-direction:column; flex-direction:column }
|
||||
.flex-wrap{ -webkit-flex-wrap:wrap; -ms-flex-wrap:wrap; flex-wrap:wrap }
|
||||
|
||||
.items-start{ -webkit-box-align:start; -webkit-align-items:flex-start; -ms-flex-align:start; -ms-grid-row-align:flex-start; align-items:flex-start }
|
||||
.items-end{ -webkit-box-align:end; -webkit-align-items:flex-end; -ms-flex-align:end; -ms-grid-row-align:flex-end; align-items:flex-end }
|
||||
.items-center{ -webkit-box-align:center; -webkit-align-items:center; -ms-flex-align:center; -ms-grid-row-align:center; align-items:center }
|
||||
.items-baseline{ -webkit-box-align:baseline; -webkit-align-items:baseline; -ms-flex-align:baseline; -ms-grid-row-align:baseline; align-items:baseline }
|
||||
.items-stretch{ -webkit-box-align:stretch; -webkit-align-items:stretch; -ms-flex-align:stretch; -ms-grid-row-align:stretch; align-items:stretch }
|
||||
|
||||
.self-start{ -webkit-align-self:flex-start; -ms-flex-item-align:start; align-self:flex-start }
|
||||
.self-end{ -webkit-align-self:flex-end; -ms-flex-item-align:end; align-self:flex-end }
|
||||
.self-center{ -webkit-align-self:center; -ms-flex-item-align:center; align-self:center }
|
||||
.self-baseline{ -webkit-align-self:baseline; -ms-flex-item-align:baseline; align-self:baseline }
|
||||
.self-stretch{ -webkit-align-self:stretch; -ms-flex-item-align:stretch; align-self:stretch }
|
||||
|
||||
.justify-start{ -webkit-box-pack:start; -webkit-justify-content:flex-start; -ms-flex-pack:start; justify-content:flex-start }
|
||||
.justify-end{ -webkit-box-pack:end; -webkit-justify-content:flex-end; -ms-flex-pack:end; justify-content:flex-end }
|
||||
.justify-center{ -webkit-box-pack:center; -webkit-justify-content:center; -ms-flex-pack:center; justify-content:center }
|
||||
.justify-between{ -webkit-box-pack:justify; -webkit-justify-content:space-between; -ms-flex-pack:justify; justify-content:space-between }
|
||||
.justify-around{ -webkit-justify-content:space-around; -ms-flex-pack:distribute; justify-content:space-around }
|
||||
|
||||
.content-start{ -webkit-align-content:flex-start; -ms-flex-line-pack:start; align-content:flex-start }
|
||||
.content-end{ -webkit-align-content:flex-end; -ms-flex-line-pack:end; align-content:flex-end }
|
||||
.content-center{ -webkit-align-content:center; -ms-flex-line-pack:center; align-content:center }
|
||||
.content-between{ -webkit-align-content:space-between; -ms-flex-line-pack:justify; align-content:space-between }
|
||||
.content-around{ -webkit-align-content:space-around; -ms-flex-line-pack:distribute; align-content:space-around }
|
||||
.content-stretch{ -webkit-align-content:stretch; -ms-flex-line-pack:stretch; align-content:stretch }
|
||||
.flex-auto{
|
||||
-webkit-box-flex:1;
|
||||
-webkit-flex:1 1 auto;
|
||||
-ms-flex:1 1 auto;
|
||||
flex:1 1 auto;
|
||||
min-width:0;
|
||||
min-height:0;
|
||||
}
|
||||
.flex-none{ -webkit-box-flex:0; -webkit-flex:none; -ms-flex:none; flex:none }
|
||||
.fs0{ flex-shrink: 0 }
|
||||
|
||||
.order-0{ -webkit-box-ordinal-group:1; -webkit-order:0; -ms-flex-order:0; order:0 }
|
||||
.order-1{ -webkit-box-ordinal-group:2; -webkit-order:1; -ms-flex-order:1; order:1 }
|
||||
.order-2{ -webkit-box-ordinal-group:3; -webkit-order:2; -ms-flex-order:2; order:2 }
|
||||
.order-3{ -webkit-box-ordinal-group:4; -webkit-order:3; -ms-flex-order:3; order:3 }
|
||||
.order-last{ -webkit-box-ordinal-group:100000; -webkit-order:99999; -ms-flex-order:99999; order:99999 }
|
||||
|
||||
.relative{ position:relative }
|
||||
.absolute{ position:absolute }
|
||||
.fixed{ position:fixed }
|
||||
|
||||
.top-0{ top:0 }
|
||||
.right-0{ right:0 }
|
||||
.bottom-0{ bottom:0 }
|
||||
.left-0{ left:0 }
|
||||
|
||||
.z1{ z-index: 1 }
|
||||
.z2{ z-index: 2 }
|
||||
.z3{ z-index: 3 }
|
||||
.z4{ z-index: 4 }
|
||||
|
||||
.border{
|
||||
border-style:solid;
|
||||
border-width: 1px;
|
||||
}
|
||||
|
||||
.border-top{
|
||||
border-top-style:solid;
|
||||
border-top-width: 1px;
|
||||
}
|
||||
|
||||
.border-right{
|
||||
border-right-style:solid;
|
||||
border-right-width: 1px;
|
||||
}
|
||||
|
||||
.border-bottom{
|
||||
border-bottom-style:solid;
|
||||
border-bottom-width: 1px;
|
||||
}
|
||||
|
||||
.border-left{
|
||||
border-left-style:solid;
|
||||
border-left-width: 1px;
|
||||
}
|
||||
|
||||
.border-none{ border:0 }
|
||||
|
||||
.rounded{ border-radius: 3px }
|
||||
.circle{ border-radius:50% }
|
||||
|
||||
.rounded-top{ border-radius: 3px 3px 0 0 }
|
||||
.rounded-right{ border-radius: 0 3px 3px 0 }
|
||||
.rounded-bottom{ border-radius: 0 0 3px 3px }
|
||||
.rounded-left{ border-radius: 3px 0 0 3px }
|
||||
|
||||
.not-rounded{ border-radius:0 }
|
||||
|
||||
.hide{
|
||||
position:absolute !important;
|
||||
height:1px;
|
||||
width:1px;
|
||||
overflow:hidden;
|
||||
clip:rect(1px, 1px, 1px, 1px);
|
||||
}
|
||||
|
||||
@media (max-width: 40em){
|
||||
.xs-hide{ display:none !important }
|
||||
}
|
||||
|
||||
@media (min-width: 40em) and (max-width: 52em){
|
||||
.sm-hide{ display:none !important }
|
||||
}
|
||||
|
||||
@media (min-width: 52em) and (max-width: 64em){
|
||||
.md-hide{ display:none !important }
|
||||
}
|
||||
|
||||
@media (min-width: 64em){
|
||||
.lg-hide{ display:none !important }
|
||||
}
|
||||
|
||||
.display-none{ display:none !important }
|
||||
|
||||
1
assets/css/main.css
Normal file
1
assets/css/main.css
Normal file
File diff suppressed because one or more lines are too long
Binary file not shown.
Binary file not shown.
@ -1,93 +0,0 @@
|
||||
Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.
|
||||
|
||||
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
||||
|
||||
This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL
|
||||
|
||||
|
||||
-----------------------------------------------------------
|
||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||
-----------------------------------------------------------
|
||||
|
||||
PREAMBLE
|
||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
||||
development of collaborative font projects, to support the font creation
|
||||
efforts of academic and linguistic communities, and to provide a free and
|
||||
open framework in which fonts may be shared and improved in partnership
|
||||
with others.
|
||||
|
||||
The OFL allows the licensed fonts to be used, studied, modified and
|
||||
redistributed freely as long as they are not sold by themselves. The
|
||||
fonts, including any derivative works, can be bundled, embedded,
|
||||
redistributed and/or sold with any software provided that any reserved
|
||||
names are not used by derivative works. The fonts and derivatives,
|
||||
however, cannot be released under any other type of license. The
|
||||
requirement for fonts to remain under this license does not apply
|
||||
to any document created using the fonts or their derivatives.
|
||||
|
||||
DEFINITIONS
|
||||
"Font Software" refers to the set of files released by the Copyright
|
||||
Holder(s) under this license and clearly marked as such. This may
|
||||
include source files, build scripts and documentation.
|
||||
|
||||
"Reserved Font Name" refers to any names specified as such after the
|
||||
copyright statement(s).
|
||||
|
||||
"Original Version" refers to the collection of Font Software components as
|
||||
distributed by the Copyright Holder(s).
|
||||
|
||||
"Modified Version" refers to any derivative made by adding to, deleting,
|
||||
or substituting -- in part or in whole -- any of the components of the
|
||||
Original Version, by changing formats or by porting the Font Software to a
|
||||
new environment.
|
||||
|
||||
"Author" refers to any designer, engineer, programmer, technical
|
||||
writer or other person who contributed to the Font Software.
|
||||
|
||||
PERMISSION & CONDITIONS
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
||||
redistribute, and sell modified and unmodified copies of the Font
|
||||
Software, subject to the following conditions:
|
||||
|
||||
1) Neither the Font Software nor any of its individual components,
|
||||
in Original or Modified Versions, may be sold by itself.
|
||||
|
||||
2) Original or Modified Versions of the Font Software may be bundled,
|
||||
redistributed and/or sold with any software, provided that each copy
|
||||
contains the above copyright notice and this license. These can be
|
||||
included either as stand-alone text files, human-readable headers or
|
||||
in the appropriate machine-readable metadata fields within text or
|
||||
binary files as long as those fields can be easily viewed by the user.
|
||||
|
||||
3) No Modified Version of the Font Software may use the Reserved Font
|
||||
Name(s) unless explicit written permission is granted by the corresponding
|
||||
Copyright Holder. This restriction only applies to the primary font name as
|
||||
presented to the users.
|
||||
|
||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||
Software shall not be used to promote, endorse or advertise any
|
||||
Modified Version, except to acknowledge the contribution(s) of the
|
||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||
permission.
|
||||
|
||||
5) The Font Software, modified or unmodified, in part or in whole,
|
||||
must be distributed entirely under this license, and must not be
|
||||
distributed under any other license. The requirement for fonts to
|
||||
remain under this license does not apply to any document created
|
||||
using the Font Software.
|
||||
|
||||
TERMINATION
|
||||
This license becomes null and void if any of the above conditions are
|
||||
not met.
|
||||
|
||||
DISCLAIMER
|
||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -1,23 +0,0 @@
|
||||
@font-face{
|
||||
font-family: 'Source Code Pro';
|
||||
font-weight: 400;
|
||||
font-style: normal;
|
||||
font-stretch: normal;
|
||||
src: url('EOT/SourceCodePro-Regular.eot') format('embedded-opentype'),
|
||||
url('WOFF2/TTF/SourceCodePro-Regular.ttf.woff2') format('woff2'),
|
||||
url('WOFF/OTF/SourceCodePro-Regular.otf.woff') format('woff'),
|
||||
url('OTF/SourceCodePro-Regular.otf') format('opentype'),
|
||||
url('TTF/SourceCodePro-Regular.ttf') format('truetype');
|
||||
}
|
||||
|
||||
@font-face{
|
||||
font-family: 'Source Code Pro';
|
||||
font-weight: 700;
|
||||
font-style: normal;
|
||||
font-stretch: normal;
|
||||
src: url('EOT/SourceCodePro-Bold.eot') format('embedded-opentype'),
|
||||
url('WOFF2/TTF/SourceCodePro-Bold.ttf.woff2') format('woff2'),
|
||||
url('WOFF/OTF/SourceCodePro-Bold.otf.woff') format('woff'),
|
||||
url('OTF/SourceCodePro-Bold.otf') format('opentype'),
|
||||
url('TTF/SourceCodePro-Bold.ttf') format('truetype');
|
||||
}
|
||||
@ -1,123 +0,0 @@
|
||||
/*
|
||||
|
||||
github.com style (c) Vasily Polovnyov <vast@whiteants.net>
|
||||
|
||||
*/
|
||||
|
||||
.hljs {
|
||||
display: block;
|
||||
overflow-x: auto;
|
||||
padding: 0.5em;
|
||||
color: #333;
|
||||
background: #f8f8f8;
|
||||
-webkit-text-size-adjust: none;
|
||||
}
|
||||
|
||||
.hljs-comment,
|
||||
.diff .hljs-header,
|
||||
.hljs-javadoc {
|
||||
color: #998;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.hljs-keyword,
|
||||
.css .rule .hljs-keyword,
|
||||
.hljs-winutils,
|
||||
.nginx .hljs-title,
|
||||
.hljs-subst,
|
||||
.hljs-request,
|
||||
.hljs-status {
|
||||
color: #1184CE;
|
||||
}
|
||||
|
||||
.hljs-number,
|
||||
.hljs-hexcolor,
|
||||
.ruby .hljs-constant {
|
||||
color: #ed225d;
|
||||
}
|
||||
|
||||
.hljs-string,
|
||||
.hljs-tag .hljs-value,
|
||||
.hljs-phpdoc,
|
||||
.hljs-dartdoc,
|
||||
.tex .hljs-formula {
|
||||
color: #ed225d;
|
||||
}
|
||||
|
||||
.hljs-title,
|
||||
.hljs-id,
|
||||
.scss .hljs-preprocessor {
|
||||
color: #900;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.hljs-list .hljs-keyword,
|
||||
.hljs-subst {
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
.hljs-class .hljs-title,
|
||||
.hljs-type,
|
||||
.vhdl .hljs-literal,
|
||||
.tex .hljs-command {
|
||||
color: #458;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.hljs-tag,
|
||||
.hljs-tag .hljs-title,
|
||||
.hljs-rules .hljs-property,
|
||||
.django .hljs-tag .hljs-keyword {
|
||||
color: #000080;
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
.hljs-attribute,
|
||||
.hljs-variable,
|
||||
.lisp .hljs-body {
|
||||
color: #008080;
|
||||
}
|
||||
|
||||
.hljs-regexp {
|
||||
color: #009926;
|
||||
}
|
||||
|
||||
.hljs-symbol,
|
||||
.ruby .hljs-symbol .hljs-string,
|
||||
.lisp .hljs-keyword,
|
||||
.clojure .hljs-keyword,
|
||||
.scheme .hljs-keyword,
|
||||
.tex .hljs-special,
|
||||
.hljs-prompt {
|
||||
color: #990073;
|
||||
}
|
||||
|
||||
.hljs-built_in {
|
||||
color: #0086b3;
|
||||
}
|
||||
|
||||
.hljs-preprocessor,
|
||||
.hljs-pragma,
|
||||
.hljs-pi,
|
||||
.hljs-doctype,
|
||||
.hljs-shebang,
|
||||
.hljs-cdata {
|
||||
color: #999;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.hljs-deletion {
|
||||
background: #fdd;
|
||||
}
|
||||
|
||||
.hljs-addition {
|
||||
background: #dfd;
|
||||
}
|
||||
|
||||
.diff .hljs-change {
|
||||
background: #0086b3;
|
||||
}
|
||||
|
||||
.hljs-chunk {
|
||||
color: #aaa;
|
||||
}
|
||||
BIN
assets/images/icons.png
Normal file
BIN
assets/images/icons.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.4 KiB |
BIN
assets/images/icons@2x.png
Normal file
BIN
assets/images/icons@2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
BIN
assets/images/widgets.png
Normal file
BIN
assets/images/widgets.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 480 B |
BIN
assets/images/widgets@2x.png
Normal file
BIN
assets/images/widgets@2x.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 855 B |
51
assets/js/main.js
Normal file
51
assets/js/main.js
Normal file
File diff suppressed because one or more lines are too long
1
assets/js/search.json
Normal file
1
assets/js/search.json
Normal file
File diff suppressed because one or more lines are too long
168
assets/site.js
168
assets/site.js
@ -1,168 +0,0 @@
|
||||
/* global anchors */
|
||||
|
||||
// add anchor links to headers
|
||||
anchors.options.placement = 'left';
|
||||
anchors.add('h3');
|
||||
|
||||
// Filter UI
|
||||
var tocElements = document.getElementById('toc').getElementsByTagName('li');
|
||||
|
||||
document.getElementById('filter-input').addEventListener('keyup', function (e) {
|
||||
var i, element, children;
|
||||
|
||||
// enter key
|
||||
if (e.keyCode === 13) {
|
||||
// go to the first displayed item in the toc
|
||||
for (i = 0; i < tocElements.length; i++) {
|
||||
element = tocElements[i];
|
||||
if (!element.classList.contains('display-none')) {
|
||||
location.replace(element.firstChild.href);
|
||||
return e.preventDefault();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var match = function () {
|
||||
return true;
|
||||
};
|
||||
|
||||
var value = this.value.toLowerCase();
|
||||
|
||||
if (!value.match(/^\s*$/)) {
|
||||
match = function (element) {
|
||||
var html = element.firstChild.innerHTML;
|
||||
return html && html.toLowerCase().indexOf(value) !== -1;
|
||||
};
|
||||
}
|
||||
|
||||
for (i = 0; i < tocElements.length; i++) {
|
||||
element = tocElements[i];
|
||||
children = Array.from(element.getElementsByTagName('li'));
|
||||
if (match(element) || children.some(match)) {
|
||||
element.classList.remove('display-none');
|
||||
} else {
|
||||
element.classList.add('display-none');
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
var items = document.getElementsByClassName('toggle-sibling');
|
||||
for (var j = 0; j < items.length; j++) {
|
||||
items[j].addEventListener('click', toggleSibling);
|
||||
}
|
||||
|
||||
function toggleSibling() {
|
||||
var stepSibling = this.parentNode.getElementsByClassName('toggle-target')[0];
|
||||
var icon = this.getElementsByClassName('icon')[0];
|
||||
var klass = 'display-none';
|
||||
if (stepSibling.classList.contains(klass)) {
|
||||
stepSibling.classList.remove(klass);
|
||||
icon.innerHTML = '▾';
|
||||
} else {
|
||||
stepSibling.classList.add(klass);
|
||||
icon.innerHTML = '▸';
|
||||
}
|
||||
}
|
||||
|
||||
function showHashTarget(targetId) {
|
||||
if (targetId) {
|
||||
var hashTarget = document.getElementById(targetId);
|
||||
// new target is hidden
|
||||
if (
|
||||
hashTarget &&
|
||||
hashTarget.offsetHeight === 0 &&
|
||||
hashTarget.parentNode.parentNode.classList.contains('display-none')
|
||||
) {
|
||||
hashTarget.parentNode.parentNode.classList.remove('display-none');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function scrollIntoView(targetId) {
|
||||
// Only scroll to element if we don't have a stored scroll position.
|
||||
if (targetId && !history.state) {
|
||||
var hashTarget = document.getElementById(targetId);
|
||||
if (hashTarget) {
|
||||
hashTarget.scrollIntoView();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function gotoCurrentTarget() {
|
||||
showHashTarget(location.hash.substring(1));
|
||||
scrollIntoView(location.hash.substring(1));
|
||||
}
|
||||
|
||||
window.addEventListener('hashchange', gotoCurrentTarget);
|
||||
gotoCurrentTarget();
|
||||
|
||||
var toclinks = document.getElementsByClassName('pre-open');
|
||||
for (var k = 0; k < toclinks.length; k++) {
|
||||
toclinks[k].addEventListener('mousedown', preOpen, false);
|
||||
}
|
||||
|
||||
function preOpen() {
|
||||
showHashTarget(this.hash.substring(1));
|
||||
}
|
||||
|
||||
var split_left = document.querySelector('#split-left');
|
||||
var split_right = document.querySelector('#split-right');
|
||||
var split_parent = split_left.parentNode;
|
||||
var cw_with_sb = split_left.clientWidth;
|
||||
split_left.style.overflow = 'hidden';
|
||||
var cw_without_sb = split_left.clientWidth;
|
||||
split_left.style.overflow = '';
|
||||
|
||||
Split(['#split-left', '#split-right'], {
|
||||
elementStyle: function (dimension, size, gutterSize) {
|
||||
return {
|
||||
'flex-basis': 'calc(' + size + '% - ' + gutterSize + 'px)'
|
||||
};
|
||||
},
|
||||
gutterStyle: function (dimension, gutterSize) {
|
||||
return {
|
||||
'flex-basis': gutterSize + 'px'
|
||||
};
|
||||
},
|
||||
gutterSize: 20,
|
||||
sizes: [33, 67]
|
||||
});
|
||||
|
||||
// Chrome doesn't remember scroll position properly so do it ourselves.
|
||||
// Also works on Firefox and Edge.
|
||||
|
||||
function updateState() {
|
||||
history.replaceState(
|
||||
{
|
||||
left_top: split_left.scrollTop,
|
||||
right_top: split_right.scrollTop
|
||||
},
|
||||
document.title
|
||||
);
|
||||
}
|
||||
|
||||
function loadState(ev) {
|
||||
if (ev) {
|
||||
// Edge doesn't replace change history.state on popstate.
|
||||
history.replaceState(ev.state, document.title);
|
||||
}
|
||||
if (history.state) {
|
||||
split_left.scrollTop = history.state.left_top;
|
||||
split_right.scrollTop = history.state.right_top;
|
||||
}
|
||||
}
|
||||
|
||||
window.addEventListener('load', function () {
|
||||
// Restore after Firefox scrolls to hash.
|
||||
setTimeout(function () {
|
||||
loadState();
|
||||
// Update with initial scroll position.
|
||||
updateState();
|
||||
// Update scroll positions only after we've loaded because Firefox
|
||||
// emits an initial scroll event with 0.
|
||||
split_left.addEventListener('scroll', updateState);
|
||||
split_right.addEventListener('scroll', updateState);
|
||||
}, 1);
|
||||
});
|
||||
|
||||
window.addEventListener('popstate', loadState);
|
||||
@ -1,15 +0,0 @@
|
||||
.gutter {
|
||||
background-color: #f5f5f5;
|
||||
background-repeat: no-repeat;
|
||||
background-position: 50%;
|
||||
}
|
||||
|
||||
.gutter.gutter-vertical {
|
||||
background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAB4AAAAFAQMAAABo7865AAAABlBMVEVHcEzMzMzyAv2sAAAAAXRSTlMAQObYZgAAABBJREFUeF5jOAMEEAIEEFwAn3kMwcB6I2AAAAAASUVORK5CYII=');
|
||||
cursor: ns-resize;
|
||||
}
|
||||
|
||||
.gutter.gutter-horizontal {
|
||||
background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAeCAYAAADkftS9AAAAIklEQVQoU2M4c+bMfxAGAgYYmwGrIIiDjrELjpo5aiZeMwF+yNnOs5KSvgAAAABJRU5ErkJggg==');
|
||||
cursor: ew-resize;
|
||||
}
|
||||
782
assets/split.js
782
assets/split.js
@ -1,782 +0,0 @@
|
||||
/*! Split.js - v1.5.11 */
|
||||
|
||||
(function (global, factory) {
|
||||
typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
|
||||
typeof define === 'function' && define.amd ? define(factory) :
|
||||
(global.Split = factory());
|
||||
}(this, (function () { 'use strict';
|
||||
|
||||
// The programming goals of Split.js are to deliver readable, understandable and
|
||||
// maintainable code, while at the same time manually optimizing for tiny minified file size,
|
||||
// browser compatibility without additional requirements, graceful fallback (IE8 is supported)
|
||||
// and very few assumptions about the user's page layout.
|
||||
var global = window;
|
||||
var document = global.document;
|
||||
|
||||
// Save a couple long function names that are used frequently.
|
||||
// This optimization saves around 400 bytes.
|
||||
var addEventListener = 'addEventListener';
|
||||
var removeEventListener = 'removeEventListener';
|
||||
var getBoundingClientRect = 'getBoundingClientRect';
|
||||
var gutterStartDragging = '_a';
|
||||
var aGutterSize = '_b';
|
||||
var bGutterSize = '_c';
|
||||
var HORIZONTAL = 'horizontal';
|
||||
var NOOP = function () { return false; };
|
||||
|
||||
// Figure out if we're in IE8 or not. IE8 will still render correctly,
|
||||
// but will be static instead of draggable.
|
||||
var isIE8 = global.attachEvent && !global[addEventListener];
|
||||
|
||||
// Helper function determines which prefixes of CSS calc we need.
|
||||
// We only need to do this once on startup, when this anonymous function is called.
|
||||
//
|
||||
// Tests -webkit, -moz and -o prefixes. Modified from StackOverflow:
|
||||
// http://stackoverflow.com/questions/16625140/js-feature-detection-to-detect-the-usage-of-webkit-calc-over-calc/16625167#16625167
|
||||
var calc = (['', '-webkit-', '-moz-', '-o-']
|
||||
.filter(function (prefix) {
|
||||
var el = document.createElement('div');
|
||||
el.style.cssText = "width:" + prefix + "calc(9px)";
|
||||
|
||||
return !!el.style.length
|
||||
})
|
||||
.shift()) + "calc";
|
||||
|
||||
// Helper function checks if its argument is a string-like type
|
||||
var isString = function (v) { return typeof v === 'string' || v instanceof String; };
|
||||
|
||||
// Helper function allows elements and string selectors to be used
|
||||
// interchangeably. In either case an element is returned. This allows us to
|
||||
// do `Split([elem1, elem2])` as well as `Split(['#id1', '#id2'])`.
|
||||
var elementOrSelector = function (el) {
|
||||
if (isString(el)) {
|
||||
var ele = document.querySelector(el);
|
||||
if (!ele) {
|
||||
throw new Error(("Selector " + el + " did not match a DOM element"))
|
||||
}
|
||||
return ele
|
||||
}
|
||||
|
||||
return el
|
||||
};
|
||||
|
||||
// Helper function gets a property from the properties object, with a default fallback
|
||||
var getOption = function (options, propName, def) {
|
||||
var value = options[propName];
|
||||
if (value !== undefined) {
|
||||
return value
|
||||
}
|
||||
return def
|
||||
};
|
||||
|
||||
var getGutterSize = function (gutterSize, isFirst, isLast, gutterAlign) {
|
||||
if (isFirst) {
|
||||
if (gutterAlign === 'end') {
|
||||
return 0
|
||||
}
|
||||
if (gutterAlign === 'center') {
|
||||
return gutterSize / 2
|
||||
}
|
||||
} else if (isLast) {
|
||||
if (gutterAlign === 'start') {
|
||||
return 0
|
||||
}
|
||||
if (gutterAlign === 'center') {
|
||||
return gutterSize / 2
|
||||
}
|
||||
}
|
||||
|
||||
return gutterSize
|
||||
};
|
||||
|
||||
// Default options
|
||||
var defaultGutterFn = function (i, gutterDirection) {
|
||||
var gut = document.createElement('div');
|
||||
gut.className = "gutter gutter-" + gutterDirection;
|
||||
return gut
|
||||
};
|
||||
|
||||
var defaultElementStyleFn = function (dim, size, gutSize) {
|
||||
var style = {};
|
||||
|
||||
if (!isString(size)) {
|
||||
if (!isIE8) {
|
||||
style[dim] = calc + "(" + size + "% - " + gutSize + "px)";
|
||||
} else {
|
||||
style[dim] = size + "%";
|
||||
}
|
||||
} else {
|
||||
style[dim] = size;
|
||||
}
|
||||
|
||||
return style
|
||||
};
|
||||
|
||||
var defaultGutterStyleFn = function (dim, gutSize) {
|
||||
var obj;
|
||||
|
||||
return (( obj = {}, obj[dim] = (gutSize + "px"), obj ));
|
||||
};
|
||||
|
||||
// The main function to initialize a split. Split.js thinks about each pair
|
||||
// of elements as an independant pair. Dragging the gutter between two elements
|
||||
// only changes the dimensions of elements in that pair. This is key to understanding
|
||||
// how the following functions operate, since each function is bound to a pair.
|
||||
//
|
||||
// A pair object is shaped like this:
|
||||
//
|
||||
// {
|
||||
// a: DOM element,
|
||||
// b: DOM element,
|
||||
// aMin: Number,
|
||||
// bMin: Number,
|
||||
// dragging: Boolean,
|
||||
// parent: DOM element,
|
||||
// direction: 'horizontal' | 'vertical'
|
||||
// }
|
||||
//
|
||||
// The basic sequence:
|
||||
//
|
||||
// 1. Set defaults to something sane. `options` doesn't have to be passed at all.
|
||||
// 2. Initialize a bunch of strings based on the direction we're splitting.
|
||||
// A lot of the behavior in the rest of the library is paramatized down to
|
||||
// rely on CSS strings and classes.
|
||||
// 3. Define the dragging helper functions, and a few helpers to go with them.
|
||||
// 4. Loop through the elements while pairing them off. Every pair gets an
|
||||
// `pair` object and a gutter.
|
||||
// 5. Actually size the pair elements, insert gutters and attach event listeners.
|
||||
var Split = function (idsOption, options) {
|
||||
if ( options === void 0 ) options = {};
|
||||
|
||||
var ids = idsOption;
|
||||
var dimension;
|
||||
var clientAxis;
|
||||
var position;
|
||||
var positionEnd;
|
||||
var clientSize;
|
||||
var elements;
|
||||
|
||||
// Allow HTMLCollection to be used as an argument when supported
|
||||
if (Array.from) {
|
||||
ids = Array.from(ids);
|
||||
}
|
||||
|
||||
// All DOM elements in the split should have a common parent. We can grab
|
||||
// the first elements parent and hope users read the docs because the
|
||||
// behavior will be whacky otherwise.
|
||||
var firstElement = elementOrSelector(ids[0]);
|
||||
var parent = firstElement.parentNode;
|
||||
var parentStyle = getComputedStyle ? getComputedStyle(parent) : null;
|
||||
var parentFlexDirection = parentStyle ? parentStyle.flexDirection : null;
|
||||
|
||||
// Set default options.sizes to equal percentages of the parent element.
|
||||
var sizes = getOption(options, 'sizes') || ids.map(function () { return 100 / ids.length; });
|
||||
|
||||
// Standardize minSize to an array if it isn't already. This allows minSize
|
||||
// to be passed as a number.
|
||||
var minSize = getOption(options, 'minSize', 100);
|
||||
var minSizes = Array.isArray(minSize) ? minSize : ids.map(function () { return minSize; });
|
||||
|
||||
// Get other options
|
||||
var expandToMin = getOption(options, 'expandToMin', false);
|
||||
var gutterSize = getOption(options, 'gutterSize', 10);
|
||||
var gutterAlign = getOption(options, 'gutterAlign', 'center');
|
||||
var snapOffset = getOption(options, 'snapOffset', 30);
|
||||
var dragInterval = getOption(options, 'dragInterval', 1);
|
||||
var direction = getOption(options, 'direction', HORIZONTAL);
|
||||
var cursor = getOption(
|
||||
options,
|
||||
'cursor',
|
||||
direction === HORIZONTAL ? 'col-resize' : 'row-resize'
|
||||
);
|
||||
var gutter = getOption(options, 'gutter', defaultGutterFn);
|
||||
var elementStyle = getOption(
|
||||
options,
|
||||
'elementStyle',
|
||||
defaultElementStyleFn
|
||||
);
|
||||
var gutterStyle = getOption(options, 'gutterStyle', defaultGutterStyleFn);
|
||||
|
||||
// 2. Initialize a bunch of strings based on the direction we're splitting.
|
||||
// A lot of the behavior in the rest of the library is paramatized down to
|
||||
// rely on CSS strings and classes.
|
||||
if (direction === HORIZONTAL) {
|
||||
dimension = 'width';
|
||||
clientAxis = 'clientX';
|
||||
position = 'left';
|
||||
positionEnd = 'right';
|
||||
clientSize = 'clientWidth';
|
||||
} else if (direction === 'vertical') {
|
||||
dimension = 'height';
|
||||
clientAxis = 'clientY';
|
||||
position = 'top';
|
||||
positionEnd = 'bottom';
|
||||
clientSize = 'clientHeight';
|
||||
}
|
||||
|
||||
// 3. Define the dragging helper functions, and a few helpers to go with them.
|
||||
// Each helper is bound to a pair object that contains its metadata. This
|
||||
// also makes it easy to store references to listeners that that will be
|
||||
// added and removed.
|
||||
//
|
||||
// Even though there are no other functions contained in them, aliasing
|
||||
// this to self saves 50 bytes or so since it's used so frequently.
|
||||
//
|
||||
// The pair object saves metadata like dragging state, position and
|
||||
// event listener references.
|
||||
|
||||
function setElementSize(el, size, gutSize, i) {
|
||||
// Split.js allows setting sizes via numbers (ideally), or if you must,
|
||||
// by string, like '300px'. This is less than ideal, because it breaks
|
||||
// the fluid layout that `calc(% - px)` provides. You're on your own if you do that,
|
||||
// make sure you calculate the gutter size by hand.
|
||||
var style = elementStyle(dimension, size, gutSize, i);
|
||||
|
||||
Object.keys(style).forEach(function (prop) {
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
el.style[prop] = style[prop];
|
||||
});
|
||||
}
|
||||
|
||||
function setGutterSize(gutterElement, gutSize, i) {
|
||||
var style = gutterStyle(dimension, gutSize, i);
|
||||
|
||||
Object.keys(style).forEach(function (prop) {
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
gutterElement.style[prop] = style[prop];
|
||||
});
|
||||
}
|
||||
|
||||
function getSizes() {
|
||||
return elements.map(function (element) { return element.size; })
|
||||
}
|
||||
|
||||
// Supports touch events, but not multitouch, so only the first
|
||||
// finger `touches[0]` is counted.
|
||||
function getMousePosition(e) {
|
||||
if ('touches' in e) { return e.touches[0][clientAxis] }
|
||||
return e[clientAxis]
|
||||
}
|
||||
|
||||
// Actually adjust the size of elements `a` and `b` to `offset` while dragging.
|
||||
// calc is used to allow calc(percentage + gutterpx) on the whole split instance,
|
||||
// which allows the viewport to be resized without additional logic.
|
||||
// Element a's size is the same as offset. b's size is total size - a size.
|
||||
// Both sizes are calculated from the initial parent percentage,
|
||||
// then the gutter size is subtracted.
|
||||
function adjust(offset) {
|
||||
var a = elements[this.a];
|
||||
var b = elements[this.b];
|
||||
var percentage = a.size + b.size;
|
||||
|
||||
a.size = (offset / this.size) * percentage;
|
||||
b.size = percentage - (offset / this.size) * percentage;
|
||||
|
||||
setElementSize(a.element, a.size, this[aGutterSize], a.i);
|
||||
setElementSize(b.element, b.size, this[bGutterSize], b.i);
|
||||
}
|
||||
|
||||
// drag, where all the magic happens. The logic is really quite simple:
|
||||
//
|
||||
// 1. Ignore if the pair is not dragging.
|
||||
// 2. Get the offset of the event.
|
||||
// 3. Snap offset to min if within snappable range (within min + snapOffset).
|
||||
// 4. Actually adjust each element in the pair to offset.
|
||||
//
|
||||
// ---------------------------------------------------------------------
|
||||
// | | <- a.minSize || b.minSize -> | |
|
||||
// | | | <- this.snapOffset || this.snapOffset -> | | |
|
||||
// | | | || | | |
|
||||
// | | | || | | |
|
||||
// ---------------------------------------------------------------------
|
||||
// | <- this.start this.size -> |
|
||||
function drag(e) {
|
||||
var offset;
|
||||
var a = elements[this.a];
|
||||
var b = elements[this.b];
|
||||
|
||||
if (!this.dragging) { return }
|
||||
|
||||
// Get the offset of the event from the first side of the
|
||||
// pair `this.start`. Then offset by the initial position of the
|
||||
// mouse compared to the gutter size.
|
||||
offset =
|
||||
getMousePosition(e) -
|
||||
this.start +
|
||||
(this[aGutterSize] - this.dragOffset);
|
||||
|
||||
if (dragInterval > 1) {
|
||||
offset = Math.round(offset / dragInterval) * dragInterval;
|
||||
}
|
||||
|
||||
// If within snapOffset of min or max, set offset to min or max.
|
||||
// snapOffset buffers a.minSize and b.minSize, so logic is opposite for both.
|
||||
// Include the appropriate gutter sizes to prevent overflows.
|
||||
if (offset <= a.minSize + snapOffset + this[aGutterSize]) {
|
||||
offset = a.minSize + this[aGutterSize];
|
||||
} else if (
|
||||
offset >=
|
||||
this.size - (b.minSize + snapOffset + this[bGutterSize])
|
||||
) {
|
||||
offset = this.size - (b.minSize + this[bGutterSize]);
|
||||
}
|
||||
|
||||
// Actually adjust the size.
|
||||
adjust.call(this, offset);
|
||||
|
||||
// Call the drag callback continously. Don't do anything too intensive
|
||||
// in this callback.
|
||||
getOption(options, 'onDrag', NOOP)();
|
||||
}
|
||||
|
||||
// Cache some important sizes when drag starts, so we don't have to do that
|
||||
// continously:
|
||||
//
|
||||
// `size`: The total size of the pair. First + second + first gutter + second gutter.
|
||||
// `start`: The leading side of the first element.
|
||||
//
|
||||
// ------------------------------------------------
|
||||
// | aGutterSize -> ||| |
|
||||
// | ||| |
|
||||
// | ||| |
|
||||
// | ||| <- bGutterSize |
|
||||
// ------------------------------------------------
|
||||
// | <- start size -> |
|
||||
function calculateSizes() {
|
||||
// Figure out the parent size minus padding.
|
||||
var a = elements[this.a].element;
|
||||
var b = elements[this.b].element;
|
||||
|
||||
var aBounds = a[getBoundingClientRect]();
|
||||
var bBounds = b[getBoundingClientRect]();
|
||||
|
||||
this.size =
|
||||
aBounds[dimension] +
|
||||
bBounds[dimension] +
|
||||
this[aGutterSize] +
|
||||
this[bGutterSize];
|
||||
this.start = aBounds[position];
|
||||
this.end = aBounds[positionEnd];
|
||||
}
|
||||
|
||||
function innerSize(element) {
|
||||
// Return nothing if getComputedStyle is not supported (< IE9)
|
||||
// Or if parent element has no layout yet
|
||||
if (!getComputedStyle) { return null }
|
||||
|
||||
var computedStyle = getComputedStyle(element);
|
||||
|
||||
if (!computedStyle) { return null }
|
||||
|
||||
var size = element[clientSize];
|
||||
|
||||
if (size === 0) { return null }
|
||||
|
||||
if (direction === HORIZONTAL) {
|
||||
size -=
|
||||
parseFloat(computedStyle.paddingLeft) +
|
||||
parseFloat(computedStyle.paddingRight);
|
||||
} else {
|
||||
size -=
|
||||
parseFloat(computedStyle.paddingTop) +
|
||||
parseFloat(computedStyle.paddingBottom);
|
||||
}
|
||||
|
||||
return size
|
||||
}
|
||||
|
||||
// When specifying percentage sizes that are less than the computed
|
||||
// size of the element minus the gutter, the lesser percentages must be increased
|
||||
// (and decreased from the other elements) to make space for the pixels
|
||||
// subtracted by the gutters.
|
||||
function trimToMin(sizesToTrim) {
|
||||
// Try to get inner size of parent element.
|
||||
// If it's no supported, return original sizes.
|
||||
var parentSize = innerSize(parent);
|
||||
if (parentSize === null) {
|
||||
return sizesToTrim
|
||||
}
|
||||
|
||||
if (minSizes.reduce(function (a, b) { return a + b; }, 0) > parentSize) {
|
||||
return sizesToTrim
|
||||
}
|
||||
|
||||
// Keep track of the excess pixels, the amount of pixels over the desired percentage
|
||||
// Also keep track of the elements with pixels to spare, to decrease after if needed
|
||||
var excessPixels = 0;
|
||||
var toSpare = [];
|
||||
|
||||
var pixelSizes = sizesToTrim.map(function (size, i) {
|
||||
// Convert requested percentages to pixel sizes
|
||||
var pixelSize = (parentSize * size) / 100;
|
||||
var elementGutterSize = getGutterSize(
|
||||
gutterSize,
|
||||
i === 0,
|
||||
i === sizesToTrim.length - 1,
|
||||
gutterAlign
|
||||
);
|
||||
var elementMinSize = minSizes[i] + elementGutterSize;
|
||||
|
||||
// If element is too smal, increase excess pixels by the difference
|
||||
// and mark that it has no pixels to spare
|
||||
if (pixelSize < elementMinSize) {
|
||||
excessPixels += elementMinSize - pixelSize;
|
||||
toSpare.push(0);
|
||||
return elementMinSize
|
||||
}
|
||||
|
||||
// Otherwise, mark the pixels it has to spare and return it's original size
|
||||
toSpare.push(pixelSize - elementMinSize);
|
||||
return pixelSize
|
||||
});
|
||||
|
||||
// If nothing was adjusted, return the original sizes
|
||||
if (excessPixels === 0) {
|
||||
return sizesToTrim
|
||||
}
|
||||
|
||||
return pixelSizes.map(function (pixelSize, i) {
|
||||
var newPixelSize = pixelSize;
|
||||
|
||||
// While there's still pixels to take, and there's enough pixels to spare,
|
||||
// take as many as possible up to the total excess pixels
|
||||
if (excessPixels > 0 && toSpare[i] - excessPixels > 0) {
|
||||
var takenPixels = Math.min(
|
||||
excessPixels,
|
||||
toSpare[i] - excessPixels
|
||||
);
|
||||
|
||||
// Subtract the amount taken for the next iteration
|
||||
excessPixels -= takenPixels;
|
||||
newPixelSize = pixelSize - takenPixels;
|
||||
}
|
||||
|
||||
// Return the pixel size adjusted as a percentage
|
||||
return (newPixelSize / parentSize) * 100
|
||||
})
|
||||
}
|
||||
|
||||
// stopDragging is very similar to startDragging in reverse.
|
||||
function stopDragging() {
|
||||
var self = this;
|
||||
var a = elements[self.a].element;
|
||||
var b = elements[self.b].element;
|
||||
|
||||
if (self.dragging) {
|
||||
getOption(options, 'onDragEnd', NOOP)(getSizes());
|
||||
}
|
||||
|
||||
self.dragging = false;
|
||||
|
||||
// Remove the stored event listeners. This is why we store them.
|
||||
global[removeEventListener]('mouseup', self.stop);
|
||||
global[removeEventListener]('touchend', self.stop);
|
||||
global[removeEventListener]('touchcancel', self.stop);
|
||||
global[removeEventListener]('mousemove', self.move);
|
||||
global[removeEventListener]('touchmove', self.move);
|
||||
|
||||
// Clear bound function references
|
||||
self.stop = null;
|
||||
self.move = null;
|
||||
|
||||
a[removeEventListener]('selectstart', NOOP);
|
||||
a[removeEventListener]('dragstart', NOOP);
|
||||
b[removeEventListener]('selectstart', NOOP);
|
||||
b[removeEventListener]('dragstart', NOOP);
|
||||
|
||||
a.style.userSelect = '';
|
||||
a.style.webkitUserSelect = '';
|
||||
a.style.MozUserSelect = '';
|
||||
a.style.pointerEvents = '';
|
||||
|
||||
b.style.userSelect = '';
|
||||
b.style.webkitUserSelect = '';
|
||||
b.style.MozUserSelect = '';
|
||||
b.style.pointerEvents = '';
|
||||
|
||||
self.gutter.style.cursor = '';
|
||||
self.parent.style.cursor = '';
|
||||
document.body.style.cursor = '';
|
||||
}
|
||||
|
||||
// startDragging calls `calculateSizes` to store the inital size in the pair object.
|
||||
// It also adds event listeners for mouse/touch events,
|
||||
// and prevents selection while dragging so avoid the selecting text.
|
||||
function startDragging(e) {
|
||||
// Right-clicking can't start dragging.
|
||||
if ('button' in e && e.button !== 0) {
|
||||
return
|
||||
}
|
||||
|
||||
// Alias frequently used variables to save space. 200 bytes.
|
||||
var self = this;
|
||||
var a = elements[self.a].element;
|
||||
var b = elements[self.b].element;
|
||||
|
||||
// Call the onDragStart callback.
|
||||
if (!self.dragging) {
|
||||
getOption(options, 'onDragStart', NOOP)(getSizes());
|
||||
}
|
||||
|
||||
// Don't actually drag the element. We emulate that in the drag function.
|
||||
e.preventDefault();
|
||||
|
||||
// Set the dragging property of the pair object.
|
||||
self.dragging = true;
|
||||
|
||||
// Create two event listeners bound to the same pair object and store
|
||||
// them in the pair object.
|
||||
self.move = drag.bind(self);
|
||||
self.stop = stopDragging.bind(self);
|
||||
|
||||
// All the binding. `window` gets the stop events in case we drag out of the elements.
|
||||
global[addEventListener]('mouseup', self.stop);
|
||||
global[addEventListener]('touchend', self.stop);
|
||||
global[addEventListener]('touchcancel', self.stop);
|
||||
global[addEventListener]('mousemove', self.move);
|
||||
global[addEventListener]('touchmove', self.move);
|
||||
|
||||
// Disable selection. Disable!
|
||||
a[addEventListener]('selectstart', NOOP);
|
||||
a[addEventListener]('dragstart', NOOP);
|
||||
b[addEventListener]('selectstart', NOOP);
|
||||
b[addEventListener]('dragstart', NOOP);
|
||||
|
||||
a.style.userSelect = 'none';
|
||||
a.style.webkitUserSelect = 'none';
|
||||
a.style.MozUserSelect = 'none';
|
||||
a.style.pointerEvents = 'none';
|
||||
|
||||
b.style.userSelect = 'none';
|
||||
b.style.webkitUserSelect = 'none';
|
||||
b.style.MozUserSelect = 'none';
|
||||
b.style.pointerEvents = 'none';
|
||||
|
||||
// Set the cursor at multiple levels
|
||||
self.gutter.style.cursor = cursor;
|
||||
self.parent.style.cursor = cursor;
|
||||
document.body.style.cursor = cursor;
|
||||
|
||||
// Cache the initial sizes of the pair.
|
||||
calculateSizes.call(self);
|
||||
|
||||
// Determine the position of the mouse compared to the gutter
|
||||
self.dragOffset = getMousePosition(e) - self.end;
|
||||
}
|
||||
|
||||
// adjust sizes to ensure percentage is within min size and gutter.
|
||||
sizes = trimToMin(sizes);
|
||||
|
||||
// 5. Create pair and element objects. Each pair has an index reference to
|
||||
// elements `a` and `b` of the pair (first and second elements).
|
||||
// Loop through the elements while pairing them off. Every pair gets a
|
||||
// `pair` object and a gutter.
|
||||
//
|
||||
// Basic logic:
|
||||
//
|
||||
// - Starting with the second element `i > 0`, create `pair` objects with
|
||||
// `a = i - 1` and `b = i`
|
||||
// - Set gutter sizes based on the _pair_ being first/last. The first and last
|
||||
// pair have gutterSize / 2, since they only have one half gutter, and not two.
|
||||
// - Create gutter elements and add event listeners.
|
||||
// - Set the size of the elements, minus the gutter sizes.
|
||||
//
|
||||
// -----------------------------------------------------------------------
|
||||
// | i=0 | i=1 | i=2 | i=3 |
|
||||
// | | | | |
|
||||
// | pair 0 pair 1 pair 2 |
|
||||
// | | | | |
|
||||
// -----------------------------------------------------------------------
|
||||
var pairs = [];
|
||||
elements = ids.map(function (id, i) {
|
||||
// Create the element object.
|
||||
var element = {
|
||||
element: elementOrSelector(id),
|
||||
size: sizes[i],
|
||||
minSize: minSizes[i],
|
||||
i: i,
|
||||
};
|
||||
|
||||
var pair;
|
||||
|
||||
if (i > 0) {
|
||||
// Create the pair object with its metadata.
|
||||
pair = {
|
||||
a: i - 1,
|
||||
b: i,
|
||||
dragging: false,
|
||||
direction: direction,
|
||||
parent: parent,
|
||||
};
|
||||
|
||||
pair[aGutterSize] = getGutterSize(
|
||||
gutterSize,
|
||||
i - 1 === 0,
|
||||
false,
|
||||
gutterAlign
|
||||
);
|
||||
pair[bGutterSize] = getGutterSize(
|
||||
gutterSize,
|
||||
false,
|
||||
i === ids.length - 1,
|
||||
gutterAlign
|
||||
);
|
||||
|
||||
// if the parent has a reverse flex-direction, switch the pair elements.
|
||||
if (
|
||||
parentFlexDirection === 'row-reverse' ||
|
||||
parentFlexDirection === 'column-reverse'
|
||||
) {
|
||||
var temp = pair.a;
|
||||
pair.a = pair.b;
|
||||
pair.b = temp;
|
||||
}
|
||||
}
|
||||
|
||||
// Determine the size of the current element. IE8 is supported by
|
||||
// staticly assigning sizes without draggable gutters. Assigns a string
|
||||
// to `size`.
|
||||
//
|
||||
// IE9 and above
|
||||
if (!isIE8) {
|
||||
// Create gutter elements for each pair.
|
||||
if (i > 0) {
|
||||
var gutterElement = gutter(i, direction, element.element);
|
||||
setGutterSize(gutterElement, gutterSize, i);
|
||||
|
||||
// Save bound event listener for removal later
|
||||
pair[gutterStartDragging] = startDragging.bind(pair);
|
||||
|
||||
// Attach bound event listener
|
||||
gutterElement[addEventListener](
|
||||
'mousedown',
|
||||
pair[gutterStartDragging]
|
||||
);
|
||||
gutterElement[addEventListener](
|
||||
'touchstart',
|
||||
pair[gutterStartDragging]
|
||||
);
|
||||
|
||||
parent.insertBefore(gutterElement, element.element);
|
||||
|
||||
pair.gutter = gutterElement;
|
||||
}
|
||||
}
|
||||
|
||||
setElementSize(
|
||||
element.element,
|
||||
element.size,
|
||||
getGutterSize(
|
||||
gutterSize,
|
||||
i === 0,
|
||||
i === ids.length - 1,
|
||||
gutterAlign
|
||||
),
|
||||
i
|
||||
);
|
||||
|
||||
// After the first iteration, and we have a pair object, append it to the
|
||||
// list of pairs.
|
||||
if (i > 0) {
|
||||
pairs.push(pair);
|
||||
}
|
||||
|
||||
return element
|
||||
});
|
||||
|
||||
function adjustToMin(element) {
|
||||
var isLast = element.i === pairs.length;
|
||||
var pair = isLast ? pairs[element.i - 1] : pairs[element.i];
|
||||
|
||||
calculateSizes.call(pair);
|
||||
|
||||
var size = isLast
|
||||
? pair.size - element.minSize - pair[bGutterSize]
|
||||
: element.minSize + pair[aGutterSize];
|
||||
|
||||
adjust.call(pair, size);
|
||||
}
|
||||
|
||||
elements.forEach(function (element) {
|
||||
var computedSize = element.element[getBoundingClientRect]()[dimension];
|
||||
|
||||
if (computedSize < element.minSize) {
|
||||
if (expandToMin) {
|
||||
adjustToMin(element);
|
||||
} else {
|
||||
// eslint-disable-next-line no-param-reassign
|
||||
element.minSize = computedSize;
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
function setSizes(newSizes) {
|
||||
var trimmed = trimToMin(newSizes);
|
||||
trimmed.forEach(function (newSize, i) {
|
||||
if (i > 0) {
|
||||
var pair = pairs[i - 1];
|
||||
|
||||
var a = elements[pair.a];
|
||||
var b = elements[pair.b];
|
||||
|
||||
a.size = trimmed[i - 1];
|
||||
b.size = newSize;
|
||||
|
||||
setElementSize(a.element, a.size, pair[aGutterSize], a.i);
|
||||
setElementSize(b.element, b.size, pair[bGutterSize], b.i);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function destroy(preserveStyles, preserveGutter) {
|
||||
pairs.forEach(function (pair) {
|
||||
if (preserveGutter !== true) {
|
||||
pair.parent.removeChild(pair.gutter);
|
||||
} else {
|
||||
pair.gutter[removeEventListener](
|
||||
'mousedown',
|
||||
pair[gutterStartDragging]
|
||||
);
|
||||
pair.gutter[removeEventListener](
|
||||
'touchstart',
|
||||
pair[gutterStartDragging]
|
||||
);
|
||||
}
|
||||
|
||||
if (preserveStyles !== true) {
|
||||
var style = elementStyle(
|
||||
dimension,
|
||||
pair.a.size,
|
||||
pair[aGutterSize]
|
||||
);
|
||||
|
||||
Object.keys(style).forEach(function (prop) {
|
||||
elements[pair.a].element.style[prop] = '';
|
||||
elements[pair.b].element.style[prop] = '';
|
||||
});
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
if (isIE8) {
|
||||
return {
|
||||
setSizes: setSizes,
|
||||
destroy: destroy,
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
setSizes: setSizes,
|
||||
getSizes: getSizes,
|
||||
collapse: function collapse(i) {
|
||||
adjustToMin(elements[i]);
|
||||
},
|
||||
destroy: destroy,
|
||||
parent: parent,
|
||||
pairs: pairs,
|
||||
}
|
||||
};
|
||||
|
||||
return Split;
|
||||
|
||||
})));
|
||||
147
assets/style.css
147
assets/style.css
@ -1,147 +0,0 @@
|
||||
.documentation {
|
||||
font-family: Helvetica, sans-serif;
|
||||
color: #666;
|
||||
line-height: 1.5;
|
||||
background: #f5f5f5;
|
||||
}
|
||||
|
||||
.black {
|
||||
color: #666;
|
||||
}
|
||||
|
||||
.bg-white {
|
||||
background-color: #fff;
|
||||
}
|
||||
|
||||
h4 {
|
||||
margin: 20px 0 10px 0;
|
||||
}
|
||||
|
||||
.documentation h3 {
|
||||
color: #000;
|
||||
}
|
||||
|
||||
.border-bottom {
|
||||
border-color: #ddd;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #1184ce;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.documentation a[href]:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.py1-ul li {
|
||||
padding: 5px 0;
|
||||
}
|
||||
|
||||
.max-height-100 {
|
||||
max-height: 100%;
|
||||
}
|
||||
|
||||
.height-viewport-100 {
|
||||
height: 100vh;
|
||||
}
|
||||
|
||||
section:target h3 {
|
||||
font-weight: 700;
|
||||
}
|
||||
|
||||
.documentation td,
|
||||
.documentation th {
|
||||
padding: 0.25rem 0.25rem;
|
||||
}
|
||||
|
||||
h1:hover .anchorjs-link,
|
||||
h2:hover .anchorjs-link,
|
||||
h3:hover .anchorjs-link,
|
||||
h4:hover .anchorjs-link {
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
.fix-3 {
|
||||
width: 25%;
|
||||
max-width: 244px;
|
||||
}
|
||||
|
||||
.fix-3 {
|
||||
width: 25%;
|
||||
max-width: 244px;
|
||||
}
|
||||
|
||||
@media (min-width: 52em) {
|
||||
.fix-margin-3 {
|
||||
margin-left: 25%;
|
||||
}
|
||||
}
|
||||
|
||||
.pre,
|
||||
pre,
|
||||
code,
|
||||
.code {
|
||||
font-family: Source Code Pro, Menlo, Consolas, Liberation Mono, monospace;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
.fill-light {
|
||||
background: #f9f9f9;
|
||||
}
|
||||
|
||||
.width2 {
|
||||
width: 1rem;
|
||||
}
|
||||
|
||||
.input {
|
||||
font-family: inherit;
|
||||
display: block;
|
||||
width: 100%;
|
||||
height: 2rem;
|
||||
padding: 0.5rem;
|
||||
margin-bottom: 1rem;
|
||||
border: 1px solid #ccc;
|
||||
font-size: 0.875rem;
|
||||
border-radius: 3px;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
table {
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
.prose table th,
|
||||
.prose table td {
|
||||
text-align: left;
|
||||
padding: 8px;
|
||||
border: 1px solid #ddd;
|
||||
}
|
||||
|
||||
.prose table th:nth-child(1) {
|
||||
border-right: none;
|
||||
}
|
||||
.prose table th:nth-child(2) {
|
||||
border-left: none;
|
||||
}
|
||||
|
||||
.prose table {
|
||||
border: 1px solid #ddd;
|
||||
}
|
||||
|
||||
.prose-big {
|
||||
font-size: 18px;
|
||||
line-height: 30px;
|
||||
}
|
||||
|
||||
.quiet {
|
||||
opacity: 0.7;
|
||||
}
|
||||
|
||||
.minishadow {
|
||||
box-shadow: 2px 2px 10px #f3f3f3;
|
||||
}
|
||||
912
classes/_connection_connection_.connection.html
Normal file
912
classes/_connection_connection_.connection.html
Normal file
@ -0,0 +1,912 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Connection | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_connection_connection_.html">connection/connection</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_connection_connection_.connection.html">Connection</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class Connection</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>An implementation of the js-libp2p connection.
|
||||
Any libp2p transport should use an upgrader to return this connection.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Connection</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>References</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#conectionstat" class="tsd-kind-icon">Conection<wbr>Stat</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#connectionoptions" class="tsd-kind-icon">Connection<wbr>Options</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#status" class="tsd-kind-icon">Status</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#streamdata" class="tsd-kind-icon">Stream<wbr>Data</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_connection_connection_.connection.html#timeline" class="tsd-kind-icon">Timeline</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_connection_connection_.connection.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_close" class="tsd-kind-icon">_close</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_closing" class="tsd-kind-icon">_closing</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_getstreams" class="tsd-kind-icon">_get<wbr>Streams</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_newstream" class="tsd-kind-icon">_new<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_stat" class="tsd-kind-icon">_stat</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#id" class="tsd-kind-icon">id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#localaddr" class="tsd-kind-icon">local<wbr>Addr</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#localpeer" class="tsd-kind-icon">local<wbr>Peer</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#registry" class="tsd-kind-icon">registry</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#remoteaddr" class="tsd-kind-icon">remote<wbr>Addr</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#remotepeer" class="tsd-kind-icon">remote<wbr>Peer</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_connection_connection_.connection.html#tags" class="tsd-kind-icon">tags</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_connection_connection_.connection.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_connection_connection_.connection.html#stat" class="tsd-kind-icon">stat</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_connection_connection_.connection.html#streams" class="tsd-kind-icon">streams</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_connection_connection_.connection.html#addstream" class="tsd-kind-icon">add<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_connection_connection_.connection.html#close" class="tsd-kind-icon">close</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_connection_connection_.connection.html#newstream" class="tsd-kind-icon">new<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_connection_connection_.connection.html#removestream" class="tsd-kind-icon">remove<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_connection_connection_.connection.html#isconnection" class="tsd-kind-icon">is<wbr>Connection</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>References</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="conectionstat" class="tsd-anchor"></a>
|
||||
<h3>Conection<wbr>Stat</h3>
|
||||
Re-exports <a href="../modules/_connection_connection_.html#conectionstat">ConectionStat</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="connectionoptions" class="tsd-anchor"></a>
|
||||
<h3>Connection<wbr>Options</h3>
|
||||
Re-exports <a href="../modules/_connection_connection_.html#connectionoptions">ConnectionOptions</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="muxedstream" class="tsd-anchor"></a>
|
||||
<h3>Muxed<wbr>Stream</h3>
|
||||
Re-exports <a href="../modules/_connection_connection_.html#muxedstream">MuxedStream</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="status" class="tsd-anchor"></a>
|
||||
<h3>Status</h3>
|
||||
Re-exports <a href="../modules/_connection_connection_.html#status">Status</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="streamdata" class="tsd-anchor"></a>
|
||||
<h3>Stream<wbr>Data</h3>
|
||||
Re-exports <a href="../modules/_connection_connection_.html#streamdata">StreamData</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="timeline" class="tsd-anchor"></a>
|
||||
<h3>Timeline</h3>
|
||||
Re-exports <a href="../modules/_connection_connection_.html#timeline-1">Timeline</a>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Connection<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>close<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>getStreams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>localAddr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>localPeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>newStream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>remoteAddr<span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>remotePeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>stat<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>An implementation of the js-libp2p connection.
|
||||
Any libp2p transport should use an upgrader to return this connection.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>close<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>getStreams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>localAddr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>localPeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>newStream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>remoteAddr<span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>remotePeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>stat<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>close<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>get<wbr>Streams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>local<wbr>Addr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>local<wbr>Peer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>new<wbr>Stream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>protocols: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>remote<wbr>Addr<span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>remote<wbr>Peer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>stat<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_close" class="tsd-anchor"></a>
|
||||
<h3>_close</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_close<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Reference to the close function of the raw connection</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_closing" class="tsd-anchor"></a>
|
||||
<h3>_closing</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_closing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_getstreams" class="tsd-anchor"></a>
|
||||
<h3>_get<wbr>Streams</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_get<wbr>Streams<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Reference to the getStreams function of the muxer</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_newstream" class="tsd-anchor"></a>
|
||||
<h3>_new<wbr>Stream</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_new<wbr>Stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Reference to the new stream function of the multiplexer</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>protocols: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_stat" class="tsd-anchor"></a>
|
||||
<h3>_stat</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_stat<span class="tsd-signature-symbol">:</span> <a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>status<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#status" class="tsd-signature-type">Status</a><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Connection metadata.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="id" class="tsd-anchor"></a>
|
||||
<h3>id</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Connection identifier.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="localaddr" class="tsd-anchor"></a>
|
||||
<h3>local<wbr>Addr</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">local<wbr>Addr<span class="tsd-signature-symbol">:</span> <a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Observed multiaddr of the local peer</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="localpeer" class="tsd-anchor"></a>
|
||||
<h3>local<wbr>Peer</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">local<wbr>Peer<span class="tsd-signature-symbol">:</span> <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Local peer id.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="registry" class="tsd-anchor"></a>
|
||||
<h3>registry</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">registry<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Connection streams registry</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="remoteaddr" class="tsd-anchor"></a>
|
||||
<h3>remote<wbr>Addr</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">remote<wbr>Addr<span class="tsd-signature-symbol">:</span> <a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Observed multiaddr of the remote peer</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="remotepeer" class="tsd-anchor"></a>
|
||||
<h3>remote<wbr>Peer</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">remote<wbr>Peer<span class="tsd-signature-symbol">:</span> <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Remote peer id.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="tags" class="tsd-anchor"></a>
|
||||
<h3>tags</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">tags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>User provided tags</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="_symbol_tostringtag_" class="tsd-anchor"></a>
|
||||
<h3>[<wbr>Symbol.to<wbr>String<wbr>Tag]</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> [Symbol.toStringTag]<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="stat" class="tsd-anchor"></a>
|
||||
<h3>stat</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> stat<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>status<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#status" class="tsd-signature-type">Status</a><span class="tsd-signature-symbol"> }</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get connection metadata</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_connection_connection_.connection.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>status<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html#status" class="tsd-signature-type">Status</a><span class="tsd-signature-symbol"> }</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="streams" class="tsd-anchor"></a>
|
||||
<h3>streams</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> streams<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get all the streams of the muxer.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="addstream" class="tsd-anchor"></a>
|
||||
<h3>add<wbr>Stream</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">add<wbr>Stream<span class="tsd-signature-symbol">(</span>muxedStream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a>, __namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Add a stream when it is opened to the registry.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>muxedStream: <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>a muxed stream</p>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>metadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="close" class="tsd-anchor"></a>
|
||||
<h3>close</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Close the connection.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="newstream" class="tsd-anchor"></a>
|
||||
<h3>new<wbr>Stream</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new<wbr>Stream<span class="tsd-signature-symbol">(</span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Create a new stream from this connection</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>protocols: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>intended protocol for the stream</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<blockquote>
|
||||
<p>} with muxed+multistream-selected stream and selected protocol</p>
|
||||
</blockquote>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="removestream" class="tsd-anchor"></a>
|
||||
<h3>remove<wbr>Stream</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">remove<wbr>Stream<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Remove stream registry after it is closed.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>identifier of the stream</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<a name="isconnection" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Connection</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Connection<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Connection</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Checks if the given value is a <code>Connection</code> instance.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>other: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Connection</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_connection_connection_.html">connection/connection</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_connection_connection_.connection.html" class="tsd-kind-icon">Connection</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#conectionstat" class="tsd-kind-icon">Conection<wbr>Stat</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#connectionoptions" class="tsd-kind-icon">Connection<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#status" class="tsd-kind-icon">Status</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#streamdata" class="tsd-kind-icon">Stream<wbr>Data</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#timeline" class="tsd-kind-icon">Timeline</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#_close" class="tsd-kind-icon">_close</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#_closing" class="tsd-kind-icon">_closing</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#_getstreams" class="tsd-kind-icon">_get<wbr>Streams</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#_newstream" class="tsd-kind-icon">_new<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#_stat" class="tsd-kind-icon">_stat</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#id" class="tsd-kind-icon">id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#localaddr" class="tsd-kind-icon">local<wbr>Addr</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#localpeer" class="tsd-kind-icon">local<wbr>Peer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#registry" class="tsd-kind-icon">registry</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#remoteaddr" class="tsd-kind-icon">remote<wbr>Addr</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#remotepeer" class="tsd-kind-icon">remote<wbr>Peer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#tags" class="tsd-kind-icon">tags</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#stat" class="tsd-kind-icon">stat</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#streams" class="tsd-kind-icon">streams</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#addstream" class="tsd-kind-icon">add<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#close" class="tsd-kind-icon">close</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#newstream" class="tsd-kind-icon">new<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_connection_connection_.connection.html#removestream" class="tsd-kind-icon">remove<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_connection_connection_.connection.html#isconnection" class="tsd-kind-icon">is<wbr>Connection</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_connection_connection_.html#conectionstat" class="tsd-kind-icon">Conection<wbr>Stat</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_connection_connection_.html#connectionoptions" class="tsd-kind-icon">Connection<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_connection_connection_.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_connection_connection_.html#status" class="tsd-kind-icon">Status</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_connection_connection_.html#streamdata" class="tsd-kind-icon">Stream<wbr>Data</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_connection_connection_.html#timeline-1" class="tsd-kind-icon">Timeline</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
367
classes/_crypto_errors_.invalidcryptoexchangeerror.html
Normal file
367
classes/_crypto_errors_.invalidcryptoexchangeerror.html
Normal file
@ -0,0 +1,367 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>InvalidCryptoExchangeError | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html">InvalidCryptoExchangeError</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class InvalidCryptoExchangeError</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">InvalidCryptoExchangeError</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#code" class="tsd-kind-icon">code</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#message" class="tsd-kind-icon">message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#name" class="tsd-kind-icon">name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#stack" class="tsd-kind-icon">stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#error" class="tsd-kind-icon">Error</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_crypto_errors_.invalidcryptoexchangeerror.html#code-1" class="tsd-kind-icon">code</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Invalid<wbr>Crypto<wbr>Exchange<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_crypto_errors_.invalidcryptoexchangeerror.html" class="tsd-signature-type">InvalidCryptoExchangeError</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> message: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_crypto_errors_.invalidcryptoexchangeerror.html" class="tsd-signature-type">InvalidCryptoExchangeError</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="code" class="tsd-anchor"></a>
|
||||
<h3>code</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="message" class="tsd-anchor"></a>
|
||||
<h3>message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#message">message</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3>name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#name">name</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="stack" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#stack">stack</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a name="error" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a name="code-1" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> code</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> code<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Exchange<wbr>Error</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#code" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#message" class="tsd-kind-icon">message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#stack" class="tsd-kind-icon">stack</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#error" class="tsd-kind-icon">Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html#code-1" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Transmission<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html" class="tsd-kind-icon">Unexpected<wbr>Peer<wbr>Error</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
367
classes/_crypto_errors_.invalidcryptotransmissionerror.html
Normal file
367
classes/_crypto_errors_.invalidcryptotransmissionerror.html
Normal file
@ -0,0 +1,367 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>InvalidCryptoTransmissionError | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html">InvalidCryptoTransmissionError</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class InvalidCryptoTransmissionError</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">InvalidCryptoTransmissionError</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#code" class="tsd-kind-icon">code</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#message" class="tsd-kind-icon">message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#name" class="tsd-kind-icon">name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#stack" class="tsd-kind-icon">stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#error" class="tsd-kind-icon">Error</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_crypto_errors_.invalidcryptotransmissionerror.html#code-1" class="tsd-kind-icon">code</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Invalid<wbr>Crypto<wbr>Transmission<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_crypto_errors_.invalidcryptotransmissionerror.html" class="tsd-signature-type">InvalidCryptoTransmissionError</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> message: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_crypto_errors_.invalidcryptotransmissionerror.html" class="tsd-signature-type">InvalidCryptoTransmissionError</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="code" class="tsd-anchor"></a>
|
||||
<h3>code</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="message" class="tsd-anchor"></a>
|
||||
<h3>message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#message">message</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3>name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#name">name</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="stack" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#stack">stack</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a name="error" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a name="code-1" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> code</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> code<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Exchange<wbr>Error</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Transmission<wbr>Error</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#code" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#message" class="tsd-kind-icon">message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#stack" class="tsd-kind-icon">stack</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#error" class="tsd-kind-icon">Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html#code-1" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html" class="tsd-kind-icon">Unexpected<wbr>Peer<wbr>Error</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
367
classes/_crypto_errors_.unexpectedpeererror.html
Normal file
367
classes/_crypto_errors_.unexpectedpeererror.html
Normal file
@ -0,0 +1,367 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>UnexpectedPeerError | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class UnexpectedPeerError</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">UnexpectedPeerError</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_crypto_errors_.unexpectedpeererror.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_crypto_errors_.unexpectedpeererror.html#code" class="tsd-kind-icon">code</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.unexpectedpeererror.html#message" class="tsd-kind-icon">message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.unexpectedpeererror.html#name" class="tsd-kind-icon">name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_crypto_errors_.unexpectedpeererror.html#stack" class="tsd-kind-icon">stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-kind-icon">Error</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_crypto_errors_.unexpectedpeererror.html#code-1" class="tsd-kind-icon">code</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Unexpected<wbr>Peer<wbr>Error<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_crypto_errors_.unexpectedpeererror.html" class="tsd-signature-type">UnexpectedPeerError</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> message: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_crypto_errors_.unexpectedpeererror.html" class="tsd-signature-type">UnexpectedPeerError</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="code" class="tsd-anchor"></a>
|
||||
<h3>code</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="message" class="tsd-anchor"></a>
|
||||
<h3>message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#message">message</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3>name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#name">name</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="stack" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#stack">stack</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a name="error" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a name="code-1" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> code</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> code<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.invalidcryptoexchangeerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Exchange<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.invalidcryptotransmissionerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Transmission<wbr>Error</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html" class="tsd-kind-icon">Unexpected<wbr>Peer<wbr>Error</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#code" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#message" class="tsd-kind-icon">message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#stack" class="tsd-kind-icon">stack</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-kind-icon">Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#code-1" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
2114
classes/_pubsub_index_.pubsubbaseprotocol.html
Normal file
2114
classes/_pubsub_index_.pubsubbaseprotocol.html
Normal file
File diff suppressed because it is too large
Load Diff
1207
classes/_pubsub_peer_streams_.peerstreams.html
Normal file
1207
classes/_pubsub_peer_streams_.peerstreams.html
Normal file
File diff suppressed because it is too large
Load Diff
600
classes/_topology_index_.topology.html
Normal file
600
classes/_topology_index_.topology.html
Normal file
@ -0,0 +1,600 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Topology | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_topology_index_.html">topology/index</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_topology_index_.topology.html">Topology</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class Topology</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>property</dt>
|
||||
<dd><p>{number} [min=0] - minimum needed connections.</p>
|
||||
</dd>
|
||||
<dt>property</dt>
|
||||
<dd><p>{number} [max=Infinity] - maximum needed connections.</p>
|
||||
</dd>
|
||||
<dt>property</dt>
|
||||
<dd><p>{Handlers} [handlers]</p>
|
||||
</dd>
|
||||
<dt>property</dt>
|
||||
<dd><p>{(peerId: PeerId, conn: Connection) => void} [onConnect] - protocol "onConnect" handler</p>
|
||||
</dd>
|
||||
<dt>property</dt>
|
||||
<dd><p>{(peerId: PeerId, error?:Error) => void} [onDisconnect] - protocol "onDisconnect" handler</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Topology</span>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html" class="tsd-signature-type">MulticodecTopology</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>References</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_index_.topology.html#connection" class="tsd-kind-icon">Connection</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_index_.topology.html#handlers" class="tsd-kind-icon">Handlers</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_index_.topology.html#options" class="tsd-kind-icon">Options</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_index_.topology.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_topology_index_.topology.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_index_.topology.html#_onconnect" class="tsd-kind-icon">_on<wbr>Connect</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_index_.topology.html#_ondisconnect" class="tsd-kind-icon">_on<wbr>Disconnect</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_index_.topology.html#_registrar" class="tsd-kind-icon">_registrar</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_index_.topology.html#max" class="tsd-kind-icon">max</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_index_.topology.html#min" class="tsd-kind-icon">min</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_index_.topology.html#peers" class="tsd-kind-icon">peers</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="_topology_index_.topology.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a></li>
|
||||
<li class="tsd-kind-set-signature tsd-parent-kind-class"><a href="_topology_index_.topology.html#registrar" class="tsd-kind-icon">registrar</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_topology_index_.topology.html#disconnect" class="tsd-kind-icon">disconnect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_topology_index_.topology.html#istopology" class="tsd-kind-icon">is<wbr>Topology</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>References</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="connection" class="tsd-anchor"></a>
|
||||
<h3>Connection</h3>
|
||||
Re-exports <a href="_connection_connection_.connection.html">Connection</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="handlers" class="tsd-anchor"></a>
|
||||
<h3>Handlers</h3>
|
||||
Re-exports <a href="../modules/_topology_index_.html#handlers">Handlers</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="options" class="tsd-anchor"></a>
|
||||
<h3>Options</h3>
|
||||
Re-exports <a href="../modules/_topology_index_.html#options">Options</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="peerid" class="tsd-anchor"></a>
|
||||
<h3>Peer<wbr>Id</h3>
|
||||
Re-exports <a href="../modules/_pubsub_peer_streams_.html#peerid">PeerId</a>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Topology<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>handlers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="_topology_index_.topology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol">; </span>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_topology_index_.topology.html" class="tsd-signature-type">Topology</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>handlers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="_topology_index_.topology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol">; </span>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>handlers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="_topology_index_.topology.html#handlers" class="tsd-signature-type">Handlers</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_topology_index_.topology.html" class="tsd-signature-type">Topology</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_onconnect" class="tsd-anchor"></a>
|
||||
<h3>_on<wbr>Connect</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_on<wbr>Connect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>peerId: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>conn: <a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_ondisconnect" class="tsd-anchor"></a>
|
||||
<h3>_on<wbr>Disconnect</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_on<wbr>Disconnect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>peerId: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="_registrar" class="tsd-anchor"></a>
|
||||
<h3>_registrar</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_registrar<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="max" class="tsd-anchor"></a>
|
||||
<h3>max</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">max<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="min" class="tsd-anchor"></a>
|
||||
<h3>min</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">min<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="peers" class="tsd-anchor"></a>
|
||||
<h3>peers</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">peers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Set of peers that support the protocol.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a name="_symbol_tostringtag_" class="tsd-anchor"></a>
|
||||
<h3>[<wbr>Symbol.to<wbr>String<wbr>Tag]</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> [Symbol.toStringTag]<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-set-signature tsd-parent-kind-class">
|
||||
<a name="registrar" class="tsd-anchor"></a>
|
||||
<h3>registrar</h3>
|
||||
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> registrar<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>arg: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="disconnect" class="tsd-anchor"></a>
|
||||
<h3>disconnect</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">disconnect<span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Notify about peer disconnected event.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>peerId: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<a name="istopology" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Topology</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Topology<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Topology</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Checks if the given value is a Topology instance.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>other: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Topology</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_topology_index_.html">topology/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_topology_index_.topology.html" class="tsd-kind-icon">Topology</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#connection" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#handlers" class="tsd-kind-icon">Handlers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#options" class="tsd-kind-icon">Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#_onconnect" class="tsd-kind-icon">_on<wbr>Connect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#_ondisconnect" class="tsd-kind-icon">_on<wbr>Disconnect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#_registrar" class="tsd-kind-icon">_registrar</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#max" class="tsd-kind-icon">max</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#min" class="tsd-kind-icon">min</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#peers" class="tsd-kind-icon">peers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-set-signature tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#registrar" class="tsd-kind-icon">registrar</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_topology_index_.topology.html#disconnect" class="tsd-kind-icon">disconnect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_topology_index_.topology.html#istopology" class="tsd-kind-icon">is<wbr>Topology</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_index_.html#connection" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_index_.html#handlers" class="tsd-kind-icon">Handlers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_index_.html#options" class="tsd-kind-icon">Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_index_.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
795
classes/_topology_multicodec_topology_.multicodectopology.html
Normal file
795
classes/_topology_multicodec_topology_.multicodectopology.html
Normal file
@ -0,0 +1,795 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MulticodecTopology | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_topology_multicodec_topology_.html">topology/multicodec-topology</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html">MulticodecTopology</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class MulticodecTopology</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="_topology_index_.topology.html" class="tsd-signature-type">Topology</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">MulticodecTopology</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>References</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#connection" class="tsd-kind-icon">Connection</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#connection-1" class="tsd-kind-icon">Connection</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-kind-icon">Handlers</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#handlers-1" class="tsd-kind-icon">Handlers</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#multiaddr" class="tsd-kind-icon">Multiaddr</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#multicodecoptions" class="tsd-kind-icon">Multicodec<wbr>Options</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#options" class="tsd-kind-icon">Options</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#peerid-1" class="tsd-kind-icon">Peer<wbr>Id</a></li>
|
||||
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#topologyoptions" class="tsd-kind-icon">Topology<wbr>Options</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="_topology_multicodec_topology_.multicodectopology.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#_onconnect" class="tsd-kind-icon">_on<wbr>Connect</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#_ondisconnect" class="tsd-kind-icon">_on<wbr>Disconnect</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#_registrar" class="tsd-kind-icon">_registrar</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#max" class="tsd-kind-icon">max</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#min" class="tsd-kind-icon">min</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#multicodecs" class="tsd-kind-icon">multicodecs</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#peers" class="tsd-kind-icon">peers</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a></li>
|
||||
<li class="tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#registrar" class="tsd-kind-icon">registrar</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#_onpeerconnect" class="tsd-kind-icon">_on<wbr>Peer<wbr>Connect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#_onprotocolchange" class="tsd-kind-icon">_on<wbr>Protocol<wbr>Change</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_topology_multicodec_topology_.multicodectopology.html#_updatepeers" class="tsd-kind-icon">_update<wbr>Peers</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_topology_multicodec_topology_.multicodectopology.html#disconnect" class="tsd-kind-icon">disconnect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_topology_multicodec_topology_.multicodectopology.html#ismulticodectopology" class="tsd-kind-icon">is<wbr>Multicodec<wbr>Topology</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="_topology_multicodec_topology_.multicodectopology.html#istopology" class="tsd-kind-icon">is<wbr>Topology</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>References</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="connection" class="tsd-anchor"></a>
|
||||
<h3>Connection</h3>
|
||||
Re-exports <a href="_connection_connection_.connection.html">Connection</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="connection-1" class="tsd-anchor"></a>
|
||||
<h3>Connection</h3>
|
||||
Re-exports <a href="_connection_connection_.connection.html">Connection</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="handlers" class="tsd-anchor"></a>
|
||||
<h3>Handlers</h3>
|
||||
Re-exports <a href="../modules/_topology_index_.html#handlers">Handlers</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="handlers-1" class="tsd-anchor"></a>
|
||||
<h3>Handlers</h3>
|
||||
Re-exports <a href="../modules/_topology_index_.html#handlers">Handlers</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="multiaddr" class="tsd-anchor"></a>
|
||||
<h3>Multiaddr</h3>
|
||||
Re-exports <a href="../modules/_topology_multicodec_topology_.html#multiaddr">Multiaddr</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="multicodecoptions" class="tsd-anchor"></a>
|
||||
<h3>Multicodec<wbr>Options</h3>
|
||||
Re-exports <a href="../modules/_topology_multicodec_topology_.html#multicodecoptions">MulticodecOptions</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="options" class="tsd-anchor"></a>
|
||||
<h3>Options</h3>
|
||||
Re-exports <a href="../modules/_topology_index_.html#options">Options</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="peerid" class="tsd-anchor"></a>
|
||||
<h3>Peer<wbr>Id</h3>
|
||||
Re-exports <a href="../modules/_pubsub_peer_streams_.html#peerid">PeerId</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="peerid-1" class="tsd-anchor"></a>
|
||||
<h3>Peer<wbr>Id</h3>
|
||||
Re-exports <a href="../modules/_pubsub_peer_streams_.html#peerid">PeerId</a>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
|
||||
<a name="topologyoptions" class="tsd-anchor"></a>
|
||||
<h3>Topology<wbr>Options</h3>
|
||||
Re-exports <a href="../modules/_topology_multicodec_topology_.html#topologyoptions">TopologyOptions</a>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Multicodec<wbr>Topology<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>handlers<span class="tsd-signature-symbol">: </span><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>multicodecs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_topology_multicodec_topology_.multicodectopology.html" class="tsd-signature-type">MulticodecTopology</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#constructor">constructor</a></p>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>handlers<span class="tsd-signature-symbol">: </span><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>multicodecs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>handlers<span class="tsd-signature-symbol">: </span><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>multicodecs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_topology_multicodec_topology_.multicodectopology.html" class="tsd-signature-type">MulticodecTopology</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="_onconnect" class="tsd-anchor"></a>
|
||||
<h3>_on<wbr>Connect</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_on<wbr>Connect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#_onconnect">_onConnect</a></p>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>peerId: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>conn: <a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="_ondisconnect" class="tsd-anchor"></a>
|
||||
<h3>_on<wbr>Disconnect</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_on<wbr>Disconnect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#_ondisconnect">_onDisconnect</a></p>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>peerId: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="_registrar" class="tsd-anchor"></a>
|
||||
<h3>_registrar</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_registrar<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#_registrar">_registrar</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="max" class="tsd-anchor"></a>
|
||||
<h3>max</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">max<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#max">max</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="min" class="tsd-anchor"></a>
|
||||
<h3>min</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">min<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#min">min</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="multicodecs" class="tsd-anchor"></a>
|
||||
<h3>multicodecs</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">multicodecs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="peers" class="tsd-anchor"></a>
|
||||
<h3>peers</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">peers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#peers">peers</a></p>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Set of peers that support the protocol.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="_symbol_tostringtag_" class="tsd-anchor"></a>
|
||||
<h3>[<wbr>Symbol.to<wbr>String<wbr>Tag]</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> [Symbol.toStringTag]<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#_symbol_tostringtag_">[Symbol.toStringTag]</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="registrar" class="tsd-anchor"></a>
|
||||
<h3>registrar</h3>
|
||||
<ul class="tsd-signatures tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">set</span> registrar<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#registrar">registrar</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>arg: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="_onpeerconnect" class="tsd-anchor"></a>
|
||||
<h3>_on<wbr>Peer<wbr>Connect</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">_on<wbr>Peer<wbr>Connect<span class="tsd-signature-symbol">(</span>connection<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Verify if a new connected peer has a topology multicodec and call _onConnect.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>connection: <a href="_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="_onprotocolchange" class="tsd-anchor"></a>
|
||||
<h3>_on<wbr>Protocol<wbr>Change</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">_on<wbr>Protocol<wbr>Change<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Check if a new peer support the multicodecs for this topology.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>peer<wbr>Id<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="_updatepeers" class="tsd-anchor"></a>
|
||||
<h3>_update<wbr>Peers</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">_update<wbr>Peers<span class="tsd-signature-symbol">(</span>peerDataIterable<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>multiaddrs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Update topology.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>peerDataIterable: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>multiaddrs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="disconnect" class="tsd-anchor"></a>
|
||||
<h3>disconnect</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">disconnect<span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#disconnect">disconnect</a></p>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Notify about peer disconnected event.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>peerId: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<a name="ismulticodectopology" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Multicodec<wbr>Topology</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Multicodec<wbr>Topology<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">MulticodecTopology</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Checks if the given value is a <code>MulticodecTopology</code> instance.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>other: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">MulticodecTopology</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
|
||||
<a name="istopology" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>Topology</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Topology<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Topology</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_topology_index_.topology.html">Topology</a>.<a href="_topology_index_.topology.html#istopology">isTopology</a></p>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Checks if the given value is a Topology instance.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>other: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">other</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type">Topology</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_topology_multicodec_topology_.html">topology/multicodec-topology</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html" class="tsd-kind-icon">Multicodec<wbr>Topology</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#connection" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#connection-1" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#handlers" class="tsd-kind-icon">Handlers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#handlers-1" class="tsd-kind-icon">Handlers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#multiaddr" class="tsd-kind-icon">Multiaddr</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#multicodecoptions" class="tsd-kind-icon">Multicodec<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#options" class="tsd-kind-icon">Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#peerid-1" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-reference tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#topologyoptions" class="tsd-kind-icon">Topology<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_onconnect" class="tsd-kind-icon">_on<wbr>Connect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_ondisconnect" class="tsd-kind-icon">_on<wbr>Disconnect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_registrar" class="tsd-kind-icon">_registrar</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#max" class="tsd-kind-icon">max</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#min" class="tsd-kind-icon">min</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#multicodecs" class="tsd-kind-icon">multicodecs</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#peers" class="tsd-kind-icon">peers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_symbol_tostringtag_" class="tsd-kind-icon">[<wbr>Symbol.to<wbr>String<wbr>Tag]</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-set-signature tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#registrar" class="tsd-kind-icon">registrar</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_onpeerconnect" class="tsd-kind-icon">_on<wbr>Peer<wbr>Connect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_onprotocolchange" class="tsd-kind-icon">_on<wbr>Protocol<wbr>Change</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#_updatepeers" class="tsd-kind-icon">_update<wbr>Peers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#disconnect" class="tsd-kind-icon">disconnect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#ismulticodectopology" class="tsd-kind-icon">is<wbr>Multicodec<wbr>Topology</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static">
|
||||
<a href="_topology_multicodec_topology_.multicodectopology.html#istopology" class="tsd-kind-icon">is<wbr>Topology</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_multicodec_topology_.html#connection" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_multicodec_topology_.html#handlers" class="tsd-kind-icon">Handlers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-kind-icon">Multiaddr</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_multicodec_topology_.html#multicodecoptions" class="tsd-kind-icon">Multicodec<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_multicodec_topology_.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_multicodec_topology_.html#topologyoptions" class="tsd-kind-icon">Topology<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="../modules/_topology_multicodec_topology_.html#multicodectopology_base" class="tsd-kind-icon">Multicodec<wbr>Topology_<wbr>base</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
357
classes/_transport_errors_.aborterror.html
Normal file
357
classes/_transport_errors_.aborterror.html
Normal file
@ -0,0 +1,357 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>AbortError | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_transport_errors_.html">transport/errors</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_transport_errors_.aborterror.html">AbortError</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class AbortError</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">AbortError</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_transport_errors_.aborterror.html#code" class="tsd-kind-icon">code</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_transport_errors_.aborterror.html#message" class="tsd-kind-icon">message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_transport_errors_.aborterror.html#name" class="tsd-kind-icon">name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_transport_errors_.aborterror.html#stack" class="tsd-kind-icon">stack</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_transport_errors_.aborterror.html#type" class="tsd-kind-icon">type</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_transport_errors_.aborterror.html#error" class="tsd-kind-icon">Error</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Accessors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_transport_errors_.aborterror.html#code-1" class="tsd-kind-icon">code</a></li>
|
||||
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-static"><a href="_transport_errors_.aborterror.html#type-1" class="tsd-kind-icon">type</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="code" class="tsd-anchor"></a>
|
||||
<h3>code</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="message" class="tsd-anchor"></a>
|
||||
<h3>message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#message">message</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3>name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#name">name</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="stack" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_crypto_errors_.unexpectedpeererror.html">UnexpectedPeerError</a>.<a href="_crypto_errors_.unexpectedpeererror.html#stack">stack</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="type" class="tsd-anchor"></a>
|
||||
<h3>type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a name="error" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> Error</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ErrorConstructor</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Accessors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a name="code-1" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> code</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> code<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a name="type-1" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> type</h3>
|
||||
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_transport_errors_.html">transport/errors</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="_transport_errors_.aborterror.html" class="tsd-kind-icon">Abort<wbr>Error</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_transport_errors_.aborterror.html#code" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_transport_errors_.aborterror.html#message" class="tsd-kind-icon">message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_transport_errors_.aborterror.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="_transport_errors_.aborterror.html#stack" class="tsd-kind-icon">stack</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="_transport_errors_.aborterror.html#type" class="tsd-kind-icon">type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_transport_errors_.aborterror.html#error" class="tsd-kind-icon">Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_transport_errors_.aborterror.html#code-1" class="tsd-kind-icon">code</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-static">
|
||||
<a href="_transport_errors_.aborterror.html#type-1" class="tsd-kind-icon">type</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
BIN
globals.html
Normal file
BIN
globals.html
Normal file
Binary file not shown.
426
index.html
426
index.html
@ -1,45 +1,389 @@
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset='utf-8'>
|
||||
<title>libp2p-interfaces 0.7.2 | Documentation</title>
|
||||
<meta name='description' content='Interfaces for JS Libp2p'>
|
||||
<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'>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</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'>libp2p-interfaces</h3>
|
||||
<div class='mb1'><code>0.7.2</code></div>
|
||||
<input
|
||||
placeholder='Filter'
|
||||
id='filter-input'
|
||||
class='col12 block input'
|
||||
spellcheck='false'
|
||||
autocapitalize='off'
|
||||
autocorrect='off'
|
||||
type='text' />
|
||||
<div id='toc'>
|
||||
<ul class='list-reset h5 py1-ul'>
|
||||
|
||||
</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>
|
||||
</div>
|
||||
<script src='assets/anchor.js'></script>
|
||||
<script src='assets/split.js'></script>
|
||||
<script src='assets/site.js'></script>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
</ul>
|
||||
<h1>libp2p-interfaces - v0.8.0</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<div class="tsd-panel tsd-typography">
|
||||
<a href="#js-libp2p-interfaces" id="js-libp2p-interfaces" style="color: inherit; text-decoration: none;">
|
||||
<h1>JS libp2p Interfaces</h1>
|
||||
</a>
|
||||
<p><a href="http://protocol.ai"><img src="https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square" alt=""></a>
|
||||
<a href="http://libp2p.io/"><img src="https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square" alt=""></a>
|
||||
<a href="http://webchat.freenode.net/?channels=%23libp2p"><img src="https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square" alt=""></a>
|
||||
<a href="https://discuss.libp2p.io"><img src="https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg" alt=""></a></p>
|
||||
<blockquote>
|
||||
<p>Contains test suites and interfaces you can use to implement the various components of libp2p.</p>
|
||||
</blockquote>
|
||||
<a href="#lead-maintainer" id="lead-maintainer" style="color: inherit; text-decoration: none;">
|
||||
<h2>Lead Maintainer</h2>
|
||||
</a>
|
||||
<p><a href="https://github.com/jacobheun">Jacob Heun</a>.</p>
|
||||
<a href="#interfaces" id="interfaces" style="color: inherit; text-decoration: none;">
|
||||
<h2>Interfaces</h2>
|
||||
</a>
|
||||
<ul>
|
||||
<li><a href="./src/connection">Connection</a></li>
|
||||
<li><a href="./src/content-routing">Content Routing</a></li>
|
||||
<li><a href="./src/crypto">Crypto</a></li>
|
||||
<li><a href="./src/peer-discovery">Peer Discovery</a></li>
|
||||
<li><a href="./src/peer-routing">Peer Routing</a></li>
|
||||
<li><a href="./src/pubsub">Pubsub</a></li>
|
||||
<li><a href="./src/record">Record</a></li>
|
||||
<li><a href="./src/stream-muxer">Stream Muxer</a></li>
|
||||
<li><a href="./src/topology">Topology</a></li>
|
||||
<li><a href="./src/transport">Transport</a></li>
|
||||
</ul>
|
||||
<a href="#origin-repositories" id="origin-repositories" style="color: inherit; text-decoration: none;">
|
||||
<h3>Origin Repositories</h3>
|
||||
</a>
|
||||
<p>For posterity, here are links to the original repositories for each of the interfaces (if they had one).</p>
|
||||
<ul>
|
||||
<li><a href="https://github.com/libp2p/interface-connection">Connection</a></li>
|
||||
<li><a href="https://github.com/libp2p/interface-content-routing">Content Routing</a></li>
|
||||
<li><a href="https://github.com/libp2p/interface-peer-discovery">Peer Discovery</a></li>
|
||||
<li><a href="https://github.com/libp2p/interface-peer-routing">Peer Routing</a></li>
|
||||
<li><a href="https://github.com/libp2p/js-libp2p-pubsub">Pubsub</a></li>
|
||||
<li><a href="https://github.com/libp2p/interface-stream-muxer">Stream Muxer</a></li>
|
||||
<li><a href="https://github.com/libp2p/interface-transport">Transport</a></li>
|
||||
</ul>
|
||||
<a href="#contribute" id="contribute" style="color: inherit; text-decoration: none;">
|
||||
<h2>Contribute</h2>
|
||||
</a>
|
||||
<p>Feel free to join in. All welcome. Open an <a href="https://github.com/libp2p/js-interfaces/issues">issue</a>!</p>
|
||||
<p>This repository falls under the IPFS <a href="https://github.com/ipfs/community/blob/master/code-of-conduct.md">Code of Conduct</a>.</p>
|
||||
<p><a href="https://github.com/ipfs/community/blob/master/contributing.md"><img src="https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif" alt=""></a></p>
|
||||
<a href="#license" id="license" style="color: inherit; text-decoration: none;">
|
||||
<h2>License</h2>
|
||||
</a>
|
||||
<p>MIT - Protocol Labs 2019</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/__libp2p_interfaces_.html"> libp2p-interfaces</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_connection_connection_.html">connection/connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_connection_index_.html">connection/index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_connection_status_.html">connection/status</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_connection_tests_connection_.html">connection/tests/connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_connection_tests_index_.html">connection/tests/index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_content_routing_types_.html">content-routing/types</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_crypto_tests_index_.html">crypto/tests/index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_crypto_types_.html">crypto/types</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_peer_discovery_tests_index_.html">peer-discovery/tests/index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_errors_.html">pubsub/errors</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_index_.html">pubsub/index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_message_index_.html">pubsub/message/index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_message_rpc_proto_.html">pubsub/message/rpc.proto</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_message_sign_.html">pubsub/message/sign</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_message_topic_descriptor_proto_.html">pubsub/message/topic-descriptor.proto</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_peer_streams_.html">pubsub/peer-streams</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_signature_policy_.html">pubsub/signature-policy</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_tests_api_.html">pubsub/tests/api</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_tests_emit_self_.html">pubsub/tests/emit-self</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_tests_index_.html">pubsub/tests/index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_tests_messages_.html">pubsub/tests/messages</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_tests_multiple_nodes_.html">pubsub/tests/multiple-nodes</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_tests_two_nodes_.html">pubsub/tests/two-nodes</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_tests_utils_.html">pubsub/tests/utils</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_pubsub_utils_.html">pubsub/utils</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_record_tests_index_.html">record/tests/index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_record_types_.html">record/types</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_stream_muxer_tests_base_test_.html">stream-muxer/tests/base-test</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_stream_muxer_tests_close_test_.html">stream-muxer/tests/close-test</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_stream_muxer_tests_index_.html">stream-muxer/tests/index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_stream_muxer_tests_mega_stress_test_.html">stream-muxer/tests/mega-stress-test</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_stream_muxer_tests_spawner_.html">stream-muxer/tests/spawner</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_stream_muxer_tests_stress_test_.html">stream-muxer/tests/stress-test</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_stream_muxer_types_.html">stream-muxer/types</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_topology_index_.html">topology/index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_topology_multicodec_topology_.html">topology/multicodec-topology</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_topology_tests_multicodec_topology_.html">topology/tests/multicodec-topology</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_topology_tests_topology_.html">topology/tests/topology</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_transport_errors_.html">transport/errors</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_transport_tests_dial_test_.html">transport/tests/dial-test</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_transport_tests_filter_test_.html">transport/tests/filter-test</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_transport_tests_index_.html">transport/tests/index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_transport_tests_listen_test_.html">transport/tests/listen-test</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_transport_tests_utils_index_.html">transport/tests/utils/index</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_transport_types_.html">transport/types</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-module">
|
||||
<a href="modules/_utils_peers_.html">utils/peers</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
</html>
|
||||
334
interfaces/_crypto_types_.crypto.html
Normal file
334
interfaces/_crypto_types_.crypto.html
Normal file
@ -0,0 +1,334 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Crypto | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_crypto_types_.html">crypto/types</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_crypto_types_.crypto.html">Crypto</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface Crypto</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>A libp2p crypto module must be compliant to this interface
|
||||
to ensure all exchanged data between two peers is encrypted.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Crypto</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_crypto_types_.crypto.html#protocol" class="tsd-kind-icon">protocol</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_crypto_types_.crypto.html#secureinbound" class="tsd-kind-icon">secure<wbr>Inbound</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_crypto_types_.crypto.html#secureoutbound" class="tsd-kind-icon">secure<wbr>Outbound</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="protocol" class="tsd-anchor"></a>
|
||||
<h3>protocol</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">protocol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="secureinbound" class="tsd-anchor"></a>
|
||||
<h3>secure<wbr>Inbound</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">secure<wbr>Inbound<span class="tsd-signature-symbol">(</span>localPeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, connection<span class="tsd-signature-symbol">: </span><a href="../modules/_transport_types_.html#multiaddrconnection" class="tsd-signature-type">MultiaddrConnection</a>, remotePeer<span class="tsd-signature-symbol">?: </span><a href="../classes/_pubsub_peer_streams_.peerstreams.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_crypto_types_.html#secureoutbound" class="tsd-signature-type">SecureOutbound</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Decrypt incoming data.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>localPeer: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>connection: <a href="../modules/_transport_types_.html#multiaddrconnection" class="tsd-signature-type">MultiaddrConnection</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> remotePeer: <a href="../classes/_pubsub_peer_streams_.peerstreams.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_crypto_types_.html#secureoutbound" class="tsd-signature-type">SecureOutbound</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="secureoutbound" class="tsd-anchor"></a>
|
||||
<h3>secure<wbr>Outbound</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">secure<wbr>Outbound<span class="tsd-signature-symbol">(</span>localPeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, connection<span class="tsd-signature-symbol">: </span><a href="../modules/_transport_types_.html#multiaddrconnection" class="tsd-signature-type">MultiaddrConnection</a>, remotePeer<span class="tsd-signature-symbol">: </span><a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_crypto_types_.html#secureoutbound" class="tsd-signature-type">SecureOutbound</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Encrypt outgoing data to the remote party.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>localPeer: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>connection: <a href="../modules/_transport_types_.html#multiaddrconnection" class="tsd-signature-type">MultiaddrConnection</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>remotePeer: <a href="../modules/_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../modules/_crypto_types_.html#secureoutbound" class="tsd-signature-type">SecureOutbound</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_crypto_types_.html">crypto/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_crypto_types_.crypto.html" class="tsd-kind-icon">Crypto</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="_crypto_types_.crypto.html#protocol" class="tsd-kind-icon">protocol</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_crypto_types_.crypto.html#secureinbound" class="tsd-kind-icon">secure<wbr>Inbound</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_crypto_types_.crypto.html#secureoutbound" class="tsd-kind-icon">secure<wbr>Outbound</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_crypto_types_.html#secureoutbound" class="tsd-kind-icon">Secure<wbr>Outbound</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
333
interfaces/_record_types_.record.html
Normal file
333
interfaces/_record_types_.record.html
Normal file
@ -0,0 +1,333 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Record | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_record_types_.html">record/types</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_record_types_.record.html">Record</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface Record</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Record is the base implementation of a record that can be used as the payload of a libp2p envelope.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Record</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_record_types_.record.html#codec" class="tsd-kind-icon">codec</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_record_types_.record.html#domain" class="tsd-kind-icon">domain</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_record_types_.record.html#equals" class="tsd-kind-icon">equals</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_record_types_.record.html#marshal" class="tsd-kind-icon">marshal</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="codec" class="tsd-anchor"></a>
|
||||
<h3>codec</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">codec<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>identifier of the type of record</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="domain" class="tsd-anchor"></a>
|
||||
<h3>domain</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">domain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>signature domain.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="equals" class="tsd-anchor"></a>
|
||||
<h3>equals</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">equals<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Verifies if the other provided Record is identical to this one.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>other: <span class="tsd-signature-type">unknown</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="marshal" class="tsd-anchor"></a>
|
||||
<h3>marshal</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">marshal<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Marshal a record to be used in an envelope.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_record_types_.html">record/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_record_types_.record.html" class="tsd-kind-icon">Record</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="_record_types_.record.html#codec" class="tsd-kind-icon">codec</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="_record_types_.record.html#domain" class="tsd-kind-icon">domain</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_record_types_.record.html#equals" class="tsd-kind-icon">equals</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_record_types_.record.html#marshal" class="tsd-kind-icon">marshal</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
417
interfaces/_stream_muxer_types_.muxedstream.html
Normal file
417
interfaces/_stream_muxer_types_.muxedstream.html
Normal file
@ -0,0 +1,417 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MuxedStream | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_stream_muxer_types_.html">stream-muxer/types</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_stream_muxer_types_.muxedstream.html">MuxedStream</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface MuxedStream</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_pubsub_index_.html#bufferlist" class="tsd-signature-type">BufferList</a><span class="tsd-signature-symbol">></span>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">MuxedStream</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxedstream.html#abort" class="tsd-kind-icon">abort</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxedstream.html#close" class="tsd-kind-icon">close</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxedstream.html#id" class="tsd-kind-icon">id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxedstream.html#reset" class="tsd-kind-icon">reset</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxedstream.html#sink" class="tsd-kind-icon">sink</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxedstream.html#source" class="tsd-kind-icon">source</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxedstream.html#timeline" class="tsd-kind-icon">timeline</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_stream_muxer_types_.muxedstream.html#_symbol_asynciterator_" class="tsd-kind-icon">[<wbr>Symbol.async<wbr>Iterator]</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="abort" class="tsd-anchor"></a>
|
||||
<h3>abort</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">abort<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="close" class="tsd-anchor"></a>
|
||||
<h3>close</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="id" class="tsd-anchor"></a>
|
||||
<h3>id</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="reset" class="tsd-anchor"></a>
|
||||
<h3>reset</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">reset<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="sink" class="tsd-anchor"></a>
|
||||
<h3>sink</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">sink<span class="tsd-signature-symbol">:</span> <a href="../modules/_stream_muxer_types_.html#sink" class="tsd-signature-type">Sink</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="source" class="tsd-anchor"></a>
|
||||
<h3>source</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_pubsub_index_.html#bufferlist" class="tsd-signature-type">BufferList</a><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_pubsub_index_.html#bufferlist" class="tsd-signature-type">BufferList</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_pubsub_index_.html#bufferlist" class="tsd-signature-type">BufferList</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="timeline" class="tsd-anchor"></a>
|
||||
<h3>timeline</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">timeline<span class="tsd-signature-symbol">:</span> <a href="../modules/_stream_muxer_types_.html#muxedtimeline" class="tsd-signature-type">MuxedTimeline</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="_symbol_asynciterator_" class="tsd-anchor"></a>
|
||||
<h3>[<wbr>Symbol.async<wbr>Iterator]</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">[<wbr>Symbol.async<wbr>Iterator]<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_pubsub_index_.html#bufferlist" class="tsd-signature-type">BufferList</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_stream_muxer_types_.muxedstream.html">MuxedStream</a>.<a href="_stream_muxer_types_.muxedstream.html#_symbol_asynciterator_">[Symbol.asyncIterator]</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_pubsub_index_.html#bufferlist" class="tsd-signature-type">BufferList</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_stream_muxer_types_.html">stream-muxer/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_stream_muxer_types_.muxedstream.html" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxedstream.html#abort" class="tsd-kind-icon">abort</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxedstream.html#close" class="tsd-kind-icon">close</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxedstream.html#id" class="tsd-kind-icon">id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxedstream.html#reset" class="tsd-kind-icon">reset</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxedstream.html#sink" class="tsd-kind-icon">sink</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxedstream.html#source" class="tsd-kind-icon">source</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxedstream.html#timeline" class="tsd-kind-icon">timeline</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_stream_muxer_types_.muxedstream.html#_symbol_asynciterator_" class="tsd-kind-icon">[<wbr>Symbol.async<wbr>Iterator]</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_stream_muxer_types_.muxer.html" class="tsd-kind-icon">Muxer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_stream_muxer_types_.muxerfactory.html" class="tsd-kind-icon">Muxer<wbr>Factory</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_stream_muxer_types_.html#muxedtimeline" class="tsd-kind-icon">Muxed<wbr>Timeline</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_stream_muxer_types_.html#muxeroptions" class="tsd-kind-icon">Muxer<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_stream_muxer_types_.html#sink" class="tsd-kind-icon">Sink</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
363
interfaces/_stream_muxer_types_.muxer.html
Normal file
363
interfaces/_stream_muxer_types_.muxer.html
Normal file
@ -0,0 +1,363 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Muxer | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_stream_muxer_types_.html">stream-muxer/types</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_stream_muxer_types_.muxer.html">Muxer</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface Muxer</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>A libp2p stream muxer</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Muxer</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxer.html#streams" class="tsd-kind-icon">streams</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxer.html#newstream" class="tsd-kind-icon">new<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxer.html#onstream" class="tsd-kind-icon">on<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxer.html#onstreamend" class="tsd-kind-icon">on<wbr>Stream<wbr>End</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="streams" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> streams</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">streams<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="newstream" class="tsd-anchor"></a>
|
||||
<h3>new<wbr>Stream</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">new<wbr>Stream<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Initiate a new stream with the given name. If no name is
|
||||
provided, the id of th stream will be used.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> name: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="onstream" class="tsd-anchor"></a>
|
||||
<h3>on<wbr>Stream</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">on<wbr>Stream<span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>A function called when receiving a new stream from the remote.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>stream: <a href="_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="onstreamend" class="tsd-anchor"></a>
|
||||
<h3>on<wbr>Stream<wbr>End</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">on<wbr>Stream<wbr>End<span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>A function called when a stream ends.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>stream: <a href="_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_stream_muxer_types_.html">stream-muxer/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_stream_muxer_types_.muxedstream.html" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_stream_muxer_types_.muxer.html" class="tsd-kind-icon">Muxer</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxer.html#streams" class="tsd-kind-icon">streams</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxer.html#newstream" class="tsd-kind-icon">new<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxer.html#onstream" class="tsd-kind-icon">on<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxer.html#onstreamend" class="tsd-kind-icon">on<wbr>Stream<wbr>End</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_stream_muxer_types_.muxerfactory.html" class="tsd-kind-icon">Muxer<wbr>Factory</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_stream_muxer_types_.html#muxedtimeline" class="tsd-kind-icon">Muxed<wbr>Timeline</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_stream_muxer_types_.html#muxeroptions" class="tsd-kind-icon">Muxer<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_stream_muxer_types_.html#sink" class="tsd-kind-icon">Sink</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
292
interfaces/_stream_muxer_types_.muxerfactory.html
Normal file
292
interfaces/_stream_muxer_types_.muxerfactory.html
Normal file
@ -0,0 +1,292 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MuxerFactory | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_stream_muxer_types_.html">stream-muxer/types</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_stream_muxer_types_.muxerfactory.html">MuxerFactory</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface MuxerFactory</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">MuxerFactory</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxerfactory.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_stream_muxer_types_.muxerfactory.html#multicodec" class="tsd-kind-icon">multicodec</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-interface">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Muxer<wbr>Factory<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../modules/_stream_muxer_types_.html#muxeroptions" class="tsd-signature-type">MuxerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_stream_muxer_types_.muxer.html" class="tsd-signature-type">Muxer</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>options: <a href="../modules/_stream_muxer_types_.html#muxeroptions" class="tsd-signature-type">MuxerOptions</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_stream_muxer_types_.muxer.html" class="tsd-signature-type">Muxer</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="multicodec" class="tsd-anchor"></a>
|
||||
<h3>multicodec</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">multicodec<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_stream_muxer_types_.html">stream-muxer/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_stream_muxer_types_.muxedstream.html" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_stream_muxer_types_.muxer.html" class="tsd-kind-icon">Muxer</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_stream_muxer_types_.muxerfactory.html" class="tsd-kind-icon">Muxer<wbr>Factory</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxerfactory.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="_stream_muxer_types_.muxerfactory.html#multicodec" class="tsd-kind-icon">multicodec</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_stream_muxer_types_.html#muxedtimeline" class="tsd-kind-icon">Muxed<wbr>Timeline</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_stream_muxer_types_.html#muxeroptions" class="tsd-kind-icon">Muxer<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_stream_muxer_types_.html#sink" class="tsd-kind-icon">Sink</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
951
interfaces/_transport_types_.listener.html
Normal file
951
interfaces/_transport_types_.listener.html
Normal file
@ -0,0 +1,951 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Listener | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_transport_types_.html">transport/types</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_transport_types_.listener.html">Listener</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface Listener</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="tsd-signature-type">EventEmitter</span>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Listener</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-static"><a href="_transport_types_.listener.html#defaultmaxlisteners" class="tsd-kind-icon">default<wbr>Max<wbr>Listeners</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-static"><a href="_transport_types_.listener.html#errormonitor" class="tsd-kind-icon">error<wbr>Monitor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#addlistener" class="tsd-kind-icon">add<wbr>Listener</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_transport_types_.listener.html#close" class="tsd-kind-icon">close</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#emit" class="tsd-kind-icon">emit</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#eventnames" class="tsd-kind-icon">event<wbr>Names</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_transport_types_.listener.html#getaddrs" class="tsd-kind-icon">get<wbr>Addrs</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#getmaxlisteners" class="tsd-kind-icon">get<wbr>Max<wbr>Listeners</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_transport_types_.listener.html#listen" class="tsd-kind-icon">listen</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#listenercount" class="tsd-kind-icon">listener<wbr>Count</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#listeners" class="tsd-kind-icon">listeners</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#off" class="tsd-kind-icon">off</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#on" class="tsd-kind-icon">on</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#once" class="tsd-kind-icon">once</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#prependlistener" class="tsd-kind-icon">prepend<wbr>Listener</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#prependoncelistener" class="tsd-kind-icon">prepend<wbr>Once<wbr>Listener</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#rawlisteners" class="tsd-kind-icon">raw<wbr>Listeners</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#removealllisteners" class="tsd-kind-icon">remove<wbr>All<wbr>Listeners</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#removelistener" class="tsd-kind-icon">remove<wbr>Listener</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="_transport_types_.listener.html#setmaxlisteners" class="tsd-kind-icon">set<wbr>Max<wbr>Listeners</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-static"><a href="_transport_types_.listener.html#listenercount-1" class="tsd-kind-icon">listener<wbr>Count</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Listener<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">EventEmitterOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_transport_types_.listener.html" class="tsd-signature-type">Listener</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#constructor">constructor</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">EventEmitterOptions</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_transport_types_.listener.html" class="tsd-signature-type">Listener</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-static">
|
||||
<a name="defaultmaxlisteners" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> default<wbr>Max<wbr>Listeners</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">default<wbr>Max<wbr>Listeners<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#defaultmaxlisteners">defaultMaxListeners</a></p>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-static">
|
||||
<a name="errormonitor" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> error<wbr>Monitor</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">error<wbr>Monitor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">unique </span><span class="tsd-signature-type">symbol</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#errormonitor">errorMonitor</a></p>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>This symbol shall be used to install a listener for only monitoring <code>'error'</code>
|
||||
events. Listeners installed using this symbol are called before the regular
|
||||
<code>'error'</code> listeners are called.</p>
|
||||
</div>
|
||||
<p>Installing a listener using this symbol does not change the behavior once an
|
||||
<code>'error'</code> event is emitted, therefore the process will still crash if no
|
||||
regular <code>'error'</code> listener is installed.</p>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="addlistener" class="tsd-anchor"></a>
|
||||
<h3>add<wbr>Listener</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">add<wbr>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#addlistener">addListener</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="close" class="tsd-anchor"></a>
|
||||
<h3>close</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">close<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Close listener</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="emit" class="tsd-anchor"></a>
|
||||
<h3>emit</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#emit">emit</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="eventnames" class="tsd-anchor"></a>
|
||||
<h3>event<wbr>Names</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">event<wbr>Names<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#eventnames">eventNames</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="getaddrs" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Addrs</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Addrs<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Get listen addresses</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="getmaxlisteners" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Max<wbr>Listeners</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Max<wbr>Listeners<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#getmaxlisteners">getMaxListeners</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="listen" class="tsd-anchor"></a>
|
||||
<h3>listen</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span>multiaddr<span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Start a listener</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>multiaddr: <a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="listenercount" class="tsd-anchor"></a>
|
||||
<h3>listener<wbr>Count</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">listener<wbr>Count<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#listenercount">listenerCount</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="listeners" class="tsd-anchor"></a>
|
||||
<h3>listeners</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#listeners">listeners</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="off" class="tsd-anchor"></a>
|
||||
<h3>off</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#off">off</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="on" class="tsd-anchor"></a>
|
||||
<h3>on</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#on">on</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="once" class="tsd-anchor"></a>
|
||||
<h3>once</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#once">once</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="prependlistener" class="tsd-anchor"></a>
|
||||
<h3>prepend<wbr>Listener</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">prepend<wbr>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#prependlistener">prependListener</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="prependoncelistener" class="tsd-anchor"></a>
|
||||
<h3>prepend<wbr>Once<wbr>Listener</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">prepend<wbr>Once<wbr>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#prependoncelistener">prependOnceListener</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="rawlisteners" class="tsd-anchor"></a>
|
||||
<h3>raw<wbr>Listeners</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">raw<wbr>Listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#rawlisteners">rawListeners</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="removealllisteners" class="tsd-anchor"></a>
|
||||
<h3>remove<wbr>All<wbr>Listeners</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">remove<wbr>All<wbr>Listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#removealllisteners">removeAllListeners</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="removelistener" class="tsd-anchor"></a>
|
||||
<h3>remove<wbr>Listener</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">remove<wbr>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#removelistener">removeListener</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="setmaxlisteners" class="tsd-anchor"></a>
|
||||
<h3>set<wbr>Max<wbr>Listeners</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">set<wbr>Max<wbr>Listeners<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#setmaxlisteners">setMaxListeners</a></p>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>n: <span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-static">
|
||||
<a name="listenercount-1" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagStatic">Static</span> listener<wbr>Count</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-static">
|
||||
<li class="tsd-signature tsd-kind-icon">listener<wbr>Count<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span>, event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="_transport_types_.listener.html">Listener</a>.<a href="_transport_types_.listener.html#listenercount-1">listenerCount</a></p>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>deprecated</dt>
|
||||
<dd><p>since v4.0.0</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>emitter: <span class="tsd-signature-type">EventEmitter</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_transport_types_.html">transport/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_transport_types_.listener.html" class="tsd-kind-icon">Listener</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-static">
|
||||
<a href="_transport_types_.listener.html#defaultmaxlisteners" class="tsd-kind-icon">default<wbr>Max<wbr>Listeners</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-static">
|
||||
<a href="_transport_types_.listener.html#errormonitor" class="tsd-kind-icon">error<wbr>Monitor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#addlistener" class="tsd-kind-icon">add<wbr>Listener</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_transport_types_.listener.html#close" class="tsd-kind-icon">close</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#emit" class="tsd-kind-icon">emit</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#eventnames" class="tsd-kind-icon">event<wbr>Names</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_transport_types_.listener.html#getaddrs" class="tsd-kind-icon">get<wbr>Addrs</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#getmaxlisteners" class="tsd-kind-icon">get<wbr>Max<wbr>Listeners</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_transport_types_.listener.html#listen" class="tsd-kind-icon">listen</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#listenercount" class="tsd-kind-icon">listener<wbr>Count</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#listeners" class="tsd-kind-icon">listeners</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#off" class="tsd-kind-icon">off</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#on" class="tsd-kind-icon">on</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#once" class="tsd-kind-icon">once</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#prependlistener" class="tsd-kind-icon">prepend<wbr>Listener</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#prependoncelistener" class="tsd-kind-icon">prepend<wbr>Once<wbr>Listener</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#rawlisteners" class="tsd-kind-icon">raw<wbr>Listeners</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#removealllisteners" class="tsd-kind-icon">remove<wbr>All<wbr>Listeners</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#removelistener" class="tsd-kind-icon">remove<wbr>Listener</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="_transport_types_.listener.html#setmaxlisteners" class="tsd-kind-icon">set<wbr>Max<wbr>Listeners</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-static">
|
||||
<a href="_transport_types_.listener.html#listenercount-1" class="tsd-kind-icon">listener<wbr>Count</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="_transport_types_.transport.html" class="tsd-kind-icon">Transport</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="_transport_types_.transportfactory.html" class="tsd-kind-icon">Transport<wbr>Factory</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_transport_types_.upgrader.html" class="tsd-kind-icon">Upgrader</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_transport_types_.html#multiaddrconnection" class="tsd-kind-icon">Multiaddr<wbr>Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_transport_types_.html#multiaddrconnectiontimeline" class="tsd-kind-icon">Multiaddr<wbr>Connection<wbr>Timeline</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
359
interfaces/_transport_types_.transport.html
Normal file
359
interfaces/_transport_types_.transport.html
Normal file
@ -0,0 +1,359 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Transport | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_transport_types_.html">transport/types</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_transport_types_.transport.html">Transport</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface Transport<DialOptions, ListenerOptions></h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>A libp2p transport is understood as something that offers a dial and listen interface to establish connections.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-type-parameters">
|
||||
<h3>Type parameters</h3>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>DialOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>signal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol"> }</span></h4>
|
||||
</li>
|
||||
<li>
|
||||
<h4>ListenerOptions</h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Transport</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_transport_types_.transport.html#createlistener" class="tsd-kind-icon">create<wbr>Listener</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_transport_types_.transport.html#dial" class="tsd-kind-icon">dial</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_transport_types_.transport.html#filter" class="tsd-kind-icon">filter</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="createlistener" class="tsd-anchor"></a>
|
||||
<h3>create<wbr>Listener</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">create<wbr>Listener<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ListenerOptions</span>, handler<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>connection<span class="tsd-signature-symbol">: </span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_transport_types_.listener.html" class="tsd-signature-type">Listener</a></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Create transport listeners.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>options: <span class="tsd-signature-type">ListenerOptions</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> handler: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>connection<span class="tsd-signature-symbol">: </span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_transport_types_.listener.html" class="tsd-signature-type">Listener</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="dial" class="tsd-anchor"></a>
|
||||
<h3>dial</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">dial<span class="tsd-signature-symbol">(</span>ma<span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a>, options<span class="tsd-signature-symbol">?: </span><a href="" class="tsd-signature-type">DialOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Dial a given multiaddr.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>ma: <a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="" class="tsd-signature-type">DialOptions</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="filter" class="tsd-anchor"></a>
|
||||
<h3>filter</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">filter<span class="tsd-signature-symbol">(</span>multiaddrs<span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Takes a list of <code>Multiaddr</code>s and returns only valid addresses for the transport</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>multiaddrs: <a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../modules/_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_transport_types_.html">transport/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_transport_types_.listener.html" class="tsd-kind-icon">Listener</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="_transport_types_.transport.html" class="tsd-kind-icon">Transport</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_transport_types_.transport.html#createlistener" class="tsd-kind-icon">create<wbr>Listener</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_transport_types_.transport.html#dial" class="tsd-kind-icon">dial</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_transport_types_.transport.html#filter" class="tsd-kind-icon">filter</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="_transport_types_.transportfactory.html" class="tsd-kind-icon">Transport<wbr>Factory</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_transport_types_.upgrader.html" class="tsd-kind-icon">Upgrader</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_transport_types_.html#multiaddrconnection" class="tsd-kind-icon">Multiaddr<wbr>Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_transport_types_.html#multiaddrconnectiontimeline" class="tsd-kind-icon">Multiaddr<wbr>Connection<wbr>Timeline</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
283
interfaces/_transport_types_.transportfactory.html
Normal file
283
interfaces/_transport_types_.transportfactory.html
Normal file
@ -0,0 +1,283 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>TransportFactory | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_transport_types_.html">transport/types</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_transport_types_.transportfactory.html">TransportFactory</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface TransportFactory<DialOptions, ListenerOptions></h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-type-parameters">
|
||||
<h3>Type parameters</h3>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>DialOptions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>signal<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol"> }</span></h4>
|
||||
</li>
|
||||
<li>
|
||||
<h4>ListenerOptions</h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">TransportFactory</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Constructors</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><a href="_transport_types_.transportfactory.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Constructors</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-interface">
|
||||
<a name="constructor" class="tsd-anchor"></a>
|
||||
<h3>constructor</h3>
|
||||
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">new <wbr>Transport<wbr>Factory<span class="tsd-signature-symbol">(</span>upgrader<span class="tsd-signature-symbol">: </span><a href="_transport_types_.upgrader.html" class="tsd-signature-type">Upgrader</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_transport_types_.transport.html" class="tsd-signature-type">Transport</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DialOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ListenerOptions</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>upgrader: <a href="_transport_types_.upgrader.html" class="tsd-signature-type">Upgrader</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="_transport_types_.transport.html" class="tsd-signature-type">Transport</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">DialOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">ListenerOptions</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_transport_types_.html">transport/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_transport_types_.listener.html" class="tsd-kind-icon">Listener</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="_transport_types_.transport.html" class="tsd-kind-icon">Transport</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="_transport_types_.transportfactory.html" class="tsd-kind-icon">Transport<wbr>Factory</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-constructor tsd-parent-kind-interface">
|
||||
<a href="_transport_types_.transportfactory.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_transport_types_.upgrader.html" class="tsd-kind-icon">Upgrader</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_transport_types_.html#multiaddrconnection" class="tsd-kind-icon">Multiaddr<wbr>Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_transport_types_.html#multiaddrconnectiontimeline" class="tsd-kind-icon">Multiaddr<wbr>Connection<wbr>Timeline</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
306
interfaces/_transport_types_.upgrader.html
Normal file
306
interfaces/_transport_types_.upgrader.html
Normal file
@ -0,0 +1,306 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Upgrader | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../modules/_transport_types_.html">transport/types</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_transport_types_.upgrader.html">Upgrader</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface Upgrader</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Upgrader</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_transport_types_.upgrader.html#upgradeinbound" class="tsd-kind-icon">upgrade<wbr>Inbound</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_transport_types_.upgrader.html#upgradeoutbound" class="tsd-kind-icon">upgrade<wbr>Outbound</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="upgradeinbound" class="tsd-anchor"></a>
|
||||
<h3>upgrade<wbr>Inbound</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">upgrade<wbr>Inbound<span class="tsd-signature-symbol">(</span>maConn<span class="tsd-signature-symbol">: </span><a href="../modules/_transport_types_.html#multiaddrconnection" class="tsd-signature-type">MultiaddrConnection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Upgrades an inbound connection on transport listener.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>maConn: <a href="../modules/_transport_types_.html#multiaddrconnection" class="tsd-signature-type">MultiaddrConnection</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||||
<a name="upgradeoutbound" class="tsd-anchor"></a>
|
||||
<h3>upgrade<wbr>Outbound</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||||
<li class="tsd-signature tsd-kind-icon">upgrade<wbr>Outbound<span class="tsd-signature-symbol">(</span>maConn<span class="tsd-signature-symbol">: </span><a href="../modules/_transport_types_.html#multiaddrconnection" class="tsd-signature-type">MultiaddrConnection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Upgrades an outbound connection on <code>transport.dial</code>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>maConn: <a href="../modules/_transport_types_.html#multiaddrconnection" class="tsd-signature-type">MultiaddrConnection</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/_transport_types_.html">transport/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_transport_types_.listener.html" class="tsd-kind-icon">Listener</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="_transport_types_.transport.html" class="tsd-kind-icon">Transport</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="_transport_types_.transportfactory.html" class="tsd-kind-icon">Transport<wbr>Factory</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="_transport_types_.upgrader.html" class="tsd-kind-icon">Upgrader</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_transport_types_.upgrader.html#upgradeinbound" class="tsd-kind-icon">upgrade<wbr>Inbound</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||||
<a href="_transport_types_.upgrader.html#upgradeoutbound" class="tsd-kind-icon">upgrade<wbr>Outbound</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_transport_types_.html#multiaddrconnection" class="tsd-kind-icon">Multiaddr<wbr>Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="../modules/_transport_types_.html#multiaddrconnectiontimeline" class="tsd-kind-icon">Multiaddr<wbr>Connection<wbr>Timeline</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
BIN
modules/__libp2p_interfaces_.html
Normal file
BIN
modules/__libp2p_interfaces_.html
Normal file
Binary file not shown.
512
modules/_connection_connection_.html
Normal file
512
modules/_connection_connection_.html
Normal file
@ -0,0 +1,512 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"connection/connection" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_connection_connection_.html">connection/connection</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module connection/connection</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_connection_connection_.connection.html" class="tsd-kind-icon">Connection</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_connection_connection_.html#conectionstat" class="tsd-kind-icon">Conection<wbr>Stat</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_connection_connection_.html#connectionoptions" class="tsd-kind-icon">Connection<wbr>Options</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_connection_connection_.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_connection_connection_.html#status" class="tsd-kind-icon">Status</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_connection_connection_.html#streamdata" class="tsd-kind-icon">Stream<wbr>Data</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_connection_connection_.html#timeline-1" class="tsd-kind-icon">Timeline</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="conectionstat" class="tsd-anchor"></a>
|
||||
<h3>Conection<wbr>Stat</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Conection<wbr>Stat<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>direction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>encryption<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>multiplexer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>timeline<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.html#timeline-1" class="tsd-signature-type">Timeline</a><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>direction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>connection establishment direction ("inbound" or "outbound").</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> encryption<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>connection encryption method identifier.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> multiplexer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>connection multiplexing identifier.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>timeline<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.html#timeline-1" class="tsd-signature-type">Timeline</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>connection relevant events timestamp.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="connectionoptions" class="tsd-anchor"></a>
|
||||
<h3>Connection<wbr>Options</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Connection<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>close<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>getStreams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>localAddr<span class="tsd-signature-symbol">?: </span><a href="_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>localPeer<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>newStream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>remoteAddr<span class="tsd-signature-symbol">: </span><a href="_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol">; </span>remotePeer<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>stat<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.html#conectionstat" class="tsd-signature-type">ConectionStat</a><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>close<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>close raw connection function.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>get<wbr>Streams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>get streams from muxer function.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> local<wbr>Addr<span class="tsd-signature-symbol">?: </span><a href="_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>local multiaddr of the connection if known.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>local<wbr>Peer<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>local peer-id.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>new<wbr>Stream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>new stream muxer function.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>protocols<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>protocols: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>remote<wbr>Addr<span class="tsd-signature-symbol">: </span><a href="_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>remote multiaddr of the connection.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>remote<wbr>Peer<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>remote peer-id.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>stat<span class="tsd-signature-symbol">: </span><a href="_connection_connection_.html#conectionstat" class="tsd-signature-type">ConectionStat</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>metadata of the connection.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="muxedstream" class="tsd-anchor"></a>
|
||||
<h3>Muxed<wbr>Stream</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Muxed<wbr>Stream<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="status" class="tsd-anchor"></a>
|
||||
<h3>Status</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"open"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"closing"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"closed"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="streamdata" class="tsd-anchor"></a>
|
||||
<h3>Stream<wbr>Data</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Stream<wbr>Data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>metadata<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> metadata<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>metadata of the stream</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>protocol<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>the protocol used by the stream</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="timeline-1" class="tsd-anchor"></a>
|
||||
<h3>Timeline</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Timeline<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>close<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>open<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>upgraded<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> close<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>open<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>connection opening timestamp.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> upgraded<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>connection upgraded timestamp.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_connection_connection_.html">connection/connection</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="../classes/_connection_connection_.connection.html" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_connection_connection_.html#conectionstat" class="tsd-kind-icon">Conection<wbr>Stat</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_connection_connection_.html#connectionoptions" class="tsd-kind-icon">Connection<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_connection_connection_.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_connection_connection_.html#status" class="tsd-kind-icon">Status</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_connection_connection_.html#streamdata" class="tsd-kind-icon">Stream<wbr>Data</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_connection_connection_.html#timeline-1" class="tsd-kind-icon">Timeline</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
223
modules/_connection_index_.html
Normal file
223
modules/_connection_index_.html
Normal file
@ -0,0 +1,223 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"connection/index" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_connection_index_.html">connection/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module connection/index</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="_connection_index_.html#connection" class="tsd-kind-icon">Connection</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
||||
<a name="connection" class="tsd-anchor"></a>
|
||||
<h3>Connection</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Connection<span class="tsd-signature-symbol">:</span> <a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_connection_index_.html">connection/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
||||
<a href="_connection_index_.html#connection" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
223
modules/_connection_status_.html
Normal file
223
modules/_connection_status_.html
Normal file
@ -0,0 +1,223 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"connection/status" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_connection_status_.html">connection/status</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module connection/status</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_connection_status_.html#status" class="tsd-kind-icon">Status</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a name="status" class="tsd-anchor"></a>
|
||||
<h3>Status</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"open"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"closing"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"closed"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_connection_status_.html">connection/status</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="_connection_status_.html#status" class="tsd-kind-icon">Status</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_connection_tests_connection_.html
Normal file
236
modules/_connection_tests_connection_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"connection/tests/connection" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_connection_tests_connection_.html">connection/tests/connection</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module connection/tests/connection</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_connection_tests_connection_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagExport assignment">Export assignment</span> _exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>test: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_connection_tests_connection_.html">connection/tests/connection</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="_connection_tests_connection_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_connection_tests_index_.html
Normal file
236
modules/_connection_tests_index_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"connection/tests/index" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_connection_tests_index_.html">connection/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module connection/tests/index</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_connection_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>test: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_connection_tests_index_.html">connection/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_connection_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
197
modules/_content_routing_types_.html
Normal file
197
modules/_content_routing_types_.html
Normal file
@ -0,0 +1,197 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"content-routing/types" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_content_routing_types_.html">content-routing/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module content-routing/types</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_content_routing_types_.html">content-routing/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
221
modules/_crypto_errors_.html
Normal file
221
modules/_crypto_errors_.html
Normal file
@ -0,0 +1,221 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"crypto/errors" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module crypto/errors</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_crypto_errors_.invalidcryptoexchangeerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Exchange<wbr>Error</a></li>
|
||||
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_crypto_errors_.invalidcryptotransmissionerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Transmission<wbr>Error</a></li>
|
||||
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_crypto_errors_.unexpectedpeererror.html" class="tsd-kind-icon">Unexpected<wbr>Peer<wbr>Error</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_crypto_errors_.html">crypto/errors</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="../classes/_crypto_errors_.invalidcryptoexchangeerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Exchange<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="../classes/_crypto_errors_.invalidcryptotransmissionerror.html" class="tsd-kind-icon">Invalid<wbr>Crypto<wbr>Transmission<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="../classes/_crypto_errors_.unexpectedpeererror.html" class="tsd-kind-icon">Unexpected<wbr>Peer<wbr>Error</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_crypto_tests_index_.html
Normal file
236
modules/_crypto_tests_index_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"crypto/tests/index" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_crypto_tests_index_.html">crypto/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module crypto/tests/index</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_crypto_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_crypto_tests_index_.html">crypto/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_crypto_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
246
modules/_crypto_types_.html
Normal file
246
modules/_crypto_types_.html
Normal file
@ -0,0 +1,246 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"crypto/types" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_crypto_types_.html">crypto/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module crypto/types</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_crypto_types_.crypto.html" class="tsd-kind-icon">Crypto</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_crypto_types_.html#secureoutbound" class="tsd-kind-icon">Secure<wbr>Outbound</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a name="secureoutbound" class="tsd-anchor"></a>
|
||||
<h3>Secure<wbr>Outbound</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Secure<wbr>Outbound<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>conn<span class="tsd-signature-symbol">: </span><a href="_transport_types_.html#multiaddrconnection" class="tsd-signature-type">MultiaddrConnection</a><span class="tsd-signature-symbol">; </span>remoteEarlyData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>remotePeer<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>conn<span class="tsd-signature-symbol">: </span><a href="_transport_types_.html#multiaddrconnection" class="tsd-signature-type">MultiaddrConnection</a></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>remote<wbr>Early<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>remote<wbr>Peer<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_crypto_types_.html">crypto/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="../interfaces/_crypto_types_.crypto.html" class="tsd-kind-icon">Crypto</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="_crypto_types_.html#secureoutbound" class="tsd-kind-icon">Secure<wbr>Outbound</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_peer_discovery_tests_index_.html
Normal file
236
modules/_peer_discovery_tests_index_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"peer-discovery/tests/index" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_peer_discovery_tests_index_.html">peer-discovery/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module peer-discovery/tests/index</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_peer_discovery_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_peer_discovery_tests_index_.html">peer-discovery/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_peer_discovery_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
319
modules/_pubsub_errors_.codes.html
Normal file
319
modules/_pubsub_errors_.codes.html
Normal file
@ -0,0 +1,319 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>codes | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_errors_.html">pubsub/errors</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_pubsub_errors_.codes.html">codes</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Namespace codes</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="_pubsub_errors_.codes.html#err_invalid_signature" class="tsd-kind-icon">ERR_<wbr>INVALID_<wbr>SIGNATURE</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="_pubsub_errors_.codes.html#err_invalid_signature_policy" class="tsd-kind-icon">ERR_<wbr>INVALID_<wbr>SIGNATURE_<wbr>POLICY</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="_pubsub_errors_.codes.html#err_missing_seqno" class="tsd-kind-icon">ERR_<wbr>MISSING_<wbr>SEQNO</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="_pubsub_errors_.codes.html#err_missing_signature" class="tsd-kind-icon">ERR_<wbr>MISSING_<wbr>SIGNATURE</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="_pubsub_errors_.codes.html#err_unexpected_from" class="tsd-kind-icon">ERR_<wbr>UNEXPECTED_<wbr>FROM</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="_pubsub_errors_.codes.html#err_unexpected_key" class="tsd-kind-icon">ERR_<wbr>UNEXPECTED_<wbr>KEY</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="_pubsub_errors_.codes.html#err_unexpected_seqno" class="tsd-kind-icon">ERR_<wbr>UNEXPECTED_<wbr>SEQNO</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="_pubsub_errors_.codes.html#err_unexpected_signature" class="tsd-kind-icon">ERR_<wbr>UNEXPECTED_<wbr>SIGNATURE</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="_pubsub_errors_.codes.html#err_unhandled_signature_policy" class="tsd-kind-icon">ERR_<wbr>UNHANDLED_<wbr>SIGNATURE_<wbr>POLICY</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a name="err_invalid_signature" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> ERR_<wbr>INVALID_<wbr>SIGNATURE</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">ERR_<wbr>INVALID_<wbr>SIGNATURE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a name="err_invalid_signature_policy" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> ERR_<wbr>INVALID_<wbr>SIGNATURE_<wbr>POLICY</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">ERR_<wbr>INVALID_<wbr>SIGNATURE_<wbr>POLICY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a name="err_missing_seqno" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> ERR_<wbr>MISSING_<wbr>SEQNO</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">ERR_<wbr>MISSING_<wbr>SEQNO<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a name="err_missing_signature" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> ERR_<wbr>MISSING_<wbr>SIGNATURE</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">ERR_<wbr>MISSING_<wbr>SIGNATURE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a name="err_unexpected_from" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> ERR_<wbr>UNEXPECTED_<wbr>FROM</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">ERR_<wbr>UNEXPECTED_<wbr>FROM<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a name="err_unexpected_key" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> ERR_<wbr>UNEXPECTED_<wbr>KEY</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">ERR_<wbr>UNEXPECTED_<wbr>KEY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a name="err_unexpected_seqno" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> ERR_<wbr>UNEXPECTED_<wbr>SEQNO</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">ERR_<wbr>UNEXPECTED_<wbr>SEQNO<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a name="err_unexpected_signature" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> ERR_<wbr>UNEXPECTED_<wbr>SIGNATURE</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">ERR_<wbr>UNEXPECTED_<wbr>SIGNATURE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a name="err_unhandled_signature_policy" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> ERR_<wbr>UNHANDLED_<wbr>SIGNATURE_<wbr>POLICY</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">ERR_<wbr>UNHANDLED_<wbr>SIGNATURE_<wbr>POLICY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_errors_.html">pubsub/errors</a>
|
||||
<ul>
|
||||
<li class="current tsd-kind-namespace tsd-parent-kind-module">
|
||||
<a href="_pubsub_errors_.codes.html">codes</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a href="_pubsub_errors_.codes.html#err_invalid_signature" class="tsd-kind-icon">ERR_<wbr>INVALID_<wbr>SIGNATURE</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a href="_pubsub_errors_.codes.html#err_invalid_signature_policy" class="tsd-kind-icon">ERR_<wbr>INVALID_<wbr>SIGNATURE_<wbr>POLICY</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a href="_pubsub_errors_.codes.html#err_missing_seqno" class="tsd-kind-icon">ERR_<wbr>MISSING_<wbr>SEQNO</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a href="_pubsub_errors_.codes.html#err_missing_signature" class="tsd-kind-icon">ERR_<wbr>MISSING_<wbr>SIGNATURE</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a href="_pubsub_errors_.codes.html#err_unexpected_from" class="tsd-kind-icon">ERR_<wbr>UNEXPECTED_<wbr>FROM</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a href="_pubsub_errors_.codes.html#err_unexpected_key" class="tsd-kind-icon">ERR_<wbr>UNEXPECTED_<wbr>KEY</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a href="_pubsub_errors_.codes.html#err_unexpected_seqno" class="tsd-kind-icon">ERR_<wbr>UNEXPECTED_<wbr>SEQNO</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a href="_pubsub_errors_.codes.html#err_unexpected_signature" class="tsd-kind-icon">ERR_<wbr>UNEXPECTED_<wbr>SIGNATURE</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a href="_pubsub_errors_.codes.html#err_unhandled_signature_policy" class="tsd-kind-icon">ERR_<wbr>UNHANDLED_<wbr>SIGNATURE_<wbr>POLICY</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
215
modules/_pubsub_errors_.html
Normal file
215
modules/_pubsub_errors_.html
Normal file
@ -0,0 +1,215 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/errors" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_errors_.html">pubsub/errors</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/errors</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Namespaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="_pubsub_errors_.codes.html" class="tsd-kind-icon">codes</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_errors_.html">pubsub/errors</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-namespace tsd-parent-kind-module">
|
||||
<a href="_pubsub_errors_.codes.html">codes</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
422
modules/_pubsub_index_.html
Normal file
422
modules/_pubsub_index_.html
Normal file
@ -0,0 +1,422 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/index" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_index_.html">pubsub/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/index</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_pubsub_index_.pubsubbaseprotocol.html" class="tsd-kind-icon">Pubsub<wbr>Base<wbr>Protocol</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#bufferlist" class="tsd-kind-icon">Buffer<wbr>List</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#connection" class="tsd-kind-icon">Connection</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#inmessage" class="tsd-kind-icon">In<wbr>Message</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#libp2p" class="tsd-kind-icon">Libp2p</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#rpc" class="tsd-kind-icon">RPC</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#rpcmessage" class="tsd-kind-icon">RPCMessage</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#rpcsubopts" class="tsd-kind-icon">RPCSub<wbr>Opts</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#signaturepolicytype" class="tsd-kind-icon">Signature<wbr>Policy<wbr>Type</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#pubsubbaseprotocol_base" class="tsd-kind-icon">Pubsub<wbr>Base<wbr>Protocol_<wbr>base</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#signaturepolicy" class="tsd-kind-icon">Signature<wbr>Policy</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#message" class="tsd-kind-icon">message</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_index_.html#utils" class="tsd-kind-icon">utils</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="bufferlist" class="tsd-anchor"></a>
|
||||
<h3>Buffer<wbr>List</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Buffer<wbr>List<span class="tsd-signature-symbol">:</span> <a href="_pubsub_index_.html#bufferlist" class="tsd-signature-type">BufferList</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="connection" class="tsd-anchor"></a>
|
||||
<h3>Connection</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Connection<span class="tsd-signature-symbol">:</span> <a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="inmessage" class="tsd-anchor"></a>
|
||||
<h3>In<wbr>Message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">In<wbr>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">; </span>from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>receivedFrom<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seqno<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>signature<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>topicIDs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>received<wbr>From<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> seqno<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> signature<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>topicIDs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="libp2p" class="tsd-anchor"></a>
|
||||
<h3>Libp2p</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Libp2p<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="muxedstream" class="tsd-anchor"></a>
|
||||
<h3>Muxed<wbr>Stream</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Muxed<wbr>Stream<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="peerid" class="tsd-anchor"></a>
|
||||
<h3>Peer<wbr>Id</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Peer<wbr>Id<span class="tsd-signature-symbol">:</span> <a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="rpc" class="tsd-anchor"></a>
|
||||
<h3>RPC</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">RPC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="rpcmessage" class="tsd-anchor"></a>
|
||||
<h3>RPCMessage</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">RPCMessage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="rpcsubopts" class="tsd-anchor"></a>
|
||||
<h3>RPCSub<wbr>Opts</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">RPCSub<wbr>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="signaturepolicytype" class="tsd-anchor"></a>
|
||||
<h3>Signature<wbr>Policy<wbr>Type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Signature<wbr>Policy<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"StrictSign"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"StrictNoSign"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="pubsubbaseprotocol_base" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> Pubsub<wbr>Base<wbr>Protocol_<wbr>base</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Pubsub<wbr>Base<wbr>Protocol_<wbr>base<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventEmitter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="signaturepolicy" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> Signature<wbr>Policy</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Signature<wbr>Policy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>StrictNoSign<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"StrictNoSign"</span><span class="tsd-signature-symbol">; </span>StrictSign<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"StrictSign"</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>Strict<wbr>NoSign<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"StrictNoSign"</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>Strict<wbr>Sign<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"StrictSign"</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="message" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <a href="_pubsub_message_index_.html" class="tsd-signature-type">"pubsub/message/index"</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="utils" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> utils</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">utils<span class="tsd-signature-symbol">:</span> <a href="_pubsub_utils_.html" class="tsd-signature-type">"pubsub/utils"</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_index_.html">pubsub/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="../classes/_pubsub_index_.pubsubbaseprotocol.html" class="tsd-kind-icon">Pubsub<wbr>Base<wbr>Protocol</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#bufferlist" class="tsd-kind-icon">Buffer<wbr>List</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#connection" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#inmessage" class="tsd-kind-icon">In<wbr>Message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#libp2p" class="tsd-kind-icon">Libp2p</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#rpc" class="tsd-kind-icon">RPC</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#rpcmessage" class="tsd-kind-icon">RPCMessage</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#rpcsubopts" class="tsd-kind-icon">RPCSub<wbr>Opts</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#signaturepolicytype" class="tsd-kind-icon">Signature<wbr>Policy<wbr>Type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#pubsubbaseprotocol_base" class="tsd-kind-icon">Pubsub<wbr>Base<wbr>Protocol_<wbr>base</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#signaturepolicy" class="tsd-kind-icon">Signature<wbr>Policy</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#message" class="tsd-kind-icon">message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_index_.html#utils" class="tsd-kind-icon">utils</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
267
modules/_pubsub_message_index_.html
Normal file
267
modules/_pubsub_message_index_.html
Normal file
@ -0,0 +1,267 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/message/index" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_message_index_.html">pubsub/message/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/message/index</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="_pubsub_message_index_.html#message" class="tsd-kind-icon">Message</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="_pubsub_message_index_.html#rpc" class="tsd-kind-icon">RPC</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="_pubsub_message_index_.html#subopts" class="tsd-kind-icon">Sub<wbr>Opts</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="_pubsub_message_index_.html#rpc-1" class="tsd-kind-icon">rpc</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="_pubsub_message_index_.html#td" class="tsd-kind-icon">td</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
||||
<a name="message" class="tsd-anchor"></a>
|
||||
<h3>Message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
||||
<a name="rpc" class="tsd-anchor"></a>
|
||||
<h3>RPC</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">RPC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
||||
<a name="subopts" class="tsd-anchor"></a>
|
||||
<h3>Sub<wbr>Opts</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Sub<wbr>Opts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
||||
<a name="rpc-1" class="tsd-anchor"></a>
|
||||
<h3>rpc</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">rpc<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
||||
<a name="td" class="tsd-anchor"></a>
|
||||
<h3>td</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">td<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_message_index_.html">pubsub/message/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
||||
<a href="_pubsub_message_index_.html#message" class="tsd-kind-icon">Message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
||||
<a href="_pubsub_message_index_.html#rpc" class="tsd-kind-icon">RPC</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
||||
<a href="_pubsub_message_index_.html#subopts" class="tsd-kind-icon">Sub<wbr>Opts</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
||||
<a href="_pubsub_message_index_.html#rpc-1" class="tsd-kind-icon">rpc</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
||||
<a href="_pubsub_message_index_.html#td" class="tsd-kind-icon">td</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
223
modules/_pubsub_message_rpc_proto_.html
Normal file
223
modules/_pubsub_message_rpc_proto_.html
Normal file
@ -0,0 +1,223 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/message/rpc.proto" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_message_rpc_proto_.html">pubsub/message/rpc.proto</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/message/rpc.proto</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_message_rpc_proto_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> _exports</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_message_rpc_proto_.html">pubsub/message/rpc.proto</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_message_rpc_proto_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
378
modules/_pubsub_message_sign_.html
Normal file
378
modules/_pubsub_message_sign_.html
Normal file
@ -0,0 +1,378 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/message/sign" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_message_sign_.html">pubsub/message/sign</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/message/sign</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_pubsub_message_sign_.html#inmessage" class="tsd-kind-icon">In<wbr>Message</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_pubsub_message_sign_.html#publickey" class="tsd-kind-icon">Public<wbr>Key</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="_pubsub_message_sign_.html#signprefix" class="tsd-kind-icon">Sign<wbr>Prefix</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_pubsub_message_sign_.html#messagepublickey" class="tsd-kind-icon">message<wbr>Public<wbr>Key</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_pubsub_message_sign_.html#signmessage" class="tsd-kind-icon">sign<wbr>Message</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_pubsub_message_sign_.html#verifysignature" class="tsd-kind-icon">verify<wbr>Signature</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a name="inmessage" class="tsd-anchor"></a>
|
||||
<h3>In<wbr>Message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">In<wbr>Message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">; </span>from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>receivedFrom<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seqno<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>signature<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>topicIDs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>received<wbr>From<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> seqno<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> signature<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>topicIDs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a name="publickey" class="tsd-anchor"></a>
|
||||
<h3>Public<wbr>Key</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PublicKey</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
|
||||
<a name="signprefix" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> Sign<wbr>Prefix</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Sign<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="messagepublickey" class="tsd-anchor"></a>
|
||||
<h3>message<wbr>Public<wbr>Key</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">message<wbr>Public<wbr>Key<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><a href="_pubsub_message_sign_.html#inmessage" class="tsd-signature-type">InMessage</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Returns the PublicKey associated with the given message.
|
||||
If no, valid PublicKey can be retrieved an error will be returned.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>message: <a href="_pubsub_message_sign_.html#inmessage" class="tsd-signature-type">InMessage</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PublicKey</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="signmessage" class="tsd-anchor"></a>
|
||||
<h3>sign<wbr>Message</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">sign<wbr>Message<span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Signs the provided message with the given <code>peerId</code></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>peerId: <a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>message: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="verifysignature" class="tsd-anchor"></a>
|
||||
<h3>verify<wbr>Signature</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">verify<wbr>Signature<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><a href="_pubsub_message_sign_.html#inmessage" class="tsd-signature-type">InMessage</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Verifies the signature of the given message</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>message: <a href="_pubsub_message_sign_.html#inmessage" class="tsd-signature-type">InMessage</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_message_sign_.html">pubsub/message/sign</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="_pubsub_message_sign_.html#inmessage" class="tsd-kind-icon">In<wbr>Message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="_pubsub_message_sign_.html#publickey" class="tsd-kind-icon">Public<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module">
|
||||
<a href="_pubsub_message_sign_.html#signprefix" class="tsd-kind-icon">Sign<wbr>Prefix</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="_pubsub_message_sign_.html#messagepublickey" class="tsd-kind-icon">message<wbr>Public<wbr>Key</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="_pubsub_message_sign_.html#signmessage" class="tsd-kind-icon">sign<wbr>Message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="_pubsub_message_sign_.html#verifysignature" class="tsd-kind-icon">verify<wbr>Signature</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
223
modules/_pubsub_message_topic_descriptor_proto_.html
Normal file
223
modules/_pubsub_message_topic_descriptor_proto_.html
Normal file
@ -0,0 +1,223 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/message/topic-descriptor.proto" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_message_topic_descriptor_proto_.html">pubsub/message/topic-descriptor.proto</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/message/topic-descriptor.proto</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_message_topic_descriptor_proto_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> _exports</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_message_topic_descriptor_proto_.html">pubsub/message/topic-descriptor.proto</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_message_topic_descriptor_proto_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
273
modules/_pubsub_peer_streams_.html
Normal file
273
modules/_pubsub_peer_streams_.html
Normal file
@ -0,0 +1,273 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/peer-streams" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_peer_streams_.html">pubsub/peer-streams</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/peer-streams</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_pubsub_peer_streams_.peerstreams.html" class="tsd-kind-icon">Peer<wbr>Streams</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_peer_streams_.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_peer_streams_.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_peer_streams_.html#pushablestream" class="tsd-kind-icon">Pushable<wbr>Stream</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_peer_streams_.html#peerstreams_base" class="tsd-kind-icon">Peer<wbr>Streams_<wbr>base</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="muxedstream" class="tsd-anchor"></a>
|
||||
<h3>Muxed<wbr>Stream</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Muxed<wbr>Stream<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="peerid" class="tsd-anchor"></a>
|
||||
<h3>Peer<wbr>Id</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Peer<wbr>Id<span class="tsd-signature-symbol">:</span> <a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="pushablestream" class="tsd-anchor"></a>
|
||||
<h3>Pushable<wbr>Stream</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Pushable<wbr>Stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pushable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="peerstreams_base" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> Peer<wbr>Streams_<wbr>base</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Peer<wbr>Streams_<wbr>base<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventEmitter</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_peer_streams_.html">pubsub/peer-streams</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="../classes/_pubsub_peer_streams_.peerstreams.html" class="tsd-kind-icon">Peer<wbr>Streams</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_peer_streams_.html#muxedstream" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_peer_streams_.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_peer_streams_.html#pushablestream" class="tsd-kind-icon">Pushable<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_peer_streams_.html#peerstreams_base" class="tsd-kind-icon">Peer<wbr>Streams_<wbr>base</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
234
modules/_pubsub_signature_policy_.html
Normal file
234
modules/_pubsub_signature_policy_.html
Normal file
@ -0,0 +1,234 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/signature-policy" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_signature_policy_.html">pubsub/signature-policy</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/signature-policy</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Namespaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="_pubsub_signature_policy_.signaturepolicy.html" class="tsd-kind-icon">Signature<wbr>Policy</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_pubsub_signature_policy_.html#signaturepolicytype" class="tsd-kind-icon">Signature<wbr>Policy<wbr>Type</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a name="signaturepolicytype" class="tsd-anchor"></a>
|
||||
<h3>Signature<wbr>Policy<wbr>Type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Signature<wbr>Policy<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"StrictSign"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"StrictNoSign"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_signature_policy_.html">pubsub/signature-policy</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-namespace tsd-parent-kind-module">
|
||||
<a href="_pubsub_signature_policy_.signaturepolicy.html">SignaturePolicy</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="_pubsub_signature_policy_.html#signaturepolicytype" class="tsd-kind-icon">Signature<wbr>Policy<wbr>Type</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
242
modules/_pubsub_signature_policy_.signaturepolicy.html
Normal file
242
modules/_pubsub_signature_policy_.signaturepolicy.html
Normal file
@ -0,0 +1,242 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>SignaturePolicy | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_signature_policy_.html">pubsub/signature-policy</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="_pubsub_signature_policy_.signaturepolicy.html">SignaturePolicy</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Namespace SignaturePolicy</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="_pubsub_signature_policy_.signaturepolicy.html#strictnosign" class="tsd-kind-icon">Strict<wbr>NoSign</a></li>
|
||||
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="_pubsub_signature_policy_.signaturepolicy.html#strictsign" class="tsd-kind-icon">Strict<wbr>Sign</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a name="strictnosign" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> Strict<wbr>NoSign</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Strict<wbr>NoSign<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"StrictNoSign"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a name="strictsign" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> Strict<wbr>Sign</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Strict<wbr>Sign<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"StrictSign"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_signature_policy_.html">pubsub/signature-policy</a>
|
||||
<ul>
|
||||
<li class="current tsd-kind-namespace tsd-parent-kind-module">
|
||||
<a href="_pubsub_signature_policy_.signaturepolicy.html">SignaturePolicy</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a href="_pubsub_signature_policy_.signaturepolicy.html#strictnosign" class="tsd-kind-icon">Strict<wbr>NoSign</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
||||
<a href="_pubsub_signature_policy_.signaturepolicy.html#strictsign" class="tsd-kind-icon">Strict<wbr>Sign</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_pubsub_tests_api_.html
Normal file
236
modules/_pubsub_tests_api_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/tests/api" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_tests_api_.html">pubsub/tests/api</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/tests/api</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_tests_api_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_tests_api_.html">pubsub/tests/api</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_tests_api_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_pubsub_tests_emit_self_.html
Normal file
236
modules/_pubsub_tests_emit_self_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/tests/emit-self" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_tests_emit_self_.html">pubsub/tests/emit-self</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/tests/emit-self</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_tests_emit_self_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_tests_emit_self_.html">pubsub/tests/emit-self</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_tests_emit_self_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_pubsub_tests_index_.html
Normal file
236
modules/_pubsub_tests_index_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/tests/index" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_tests_index_.html">pubsub/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/tests/index</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_tests_index_.html">pubsub/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_pubsub_tests_messages_.html
Normal file
236
modules/_pubsub_tests_messages_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/tests/messages" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_tests_messages_.html">pubsub/tests/messages</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/tests/messages</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_tests_messages_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_tests_messages_.html">pubsub/tests/messages</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_tests_messages_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_pubsub_tests_multiple_nodes_.html
Normal file
236
modules/_pubsub_tests_multiple_nodes_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/tests/multiple-nodes" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_tests_multiple_nodes_.html">pubsub/tests/multiple-nodes</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/tests/multiple-nodes</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_tests_multiple_nodes_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_tests_multiple_nodes_.html">pubsub/tests/multiple-nodes</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_tests_multiple_nodes_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_pubsub_tests_two_nodes_.html
Normal file
236
modules/_pubsub_tests_two_nodes_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/tests/two-nodes" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_tests_two_nodes_.html">pubsub/tests/two-nodes</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/tests/two-nodes</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_pubsub_tests_two_nodes_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_tests_two_nodes_.html">pubsub/tests/two-nodes</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_pubsub_tests_two_nodes_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
263
modules/_pubsub_tests_utils_.html
Normal file
263
modules/_pubsub_tests_utils_.html
Normal file
@ -0,0 +1,263 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/tests/utils" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_tests_utils_.html">pubsub/tests/utils</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/tests/utils</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_pubsub_tests_utils_.html#expectset" class="tsd-kind-icon">expect<wbr>Set</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_pubsub_tests_utils_.html#first" class="tsd-kind-icon">first</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="expectset" class="tsd-anchor"></a>
|
||||
<h3>expect<wbr>Set</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">expect<wbr>Set<span class="tsd-signature-symbol">(</span>set<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, subs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>set: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>subs: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="first" class="tsd-anchor"></a>
|
||||
<h3>first</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">first<span class="tsd-signature-symbol">(</span>map<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>map: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_tests_utils_.html">pubsub/tests/utils</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="_pubsub_tests_utils_.html#expectset" class="tsd-kind-icon">expect<wbr>Set</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="_pubsub_tests_utils_.html#first" class="tsd-kind-icon">first</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
401
modules/_pubsub_utils_.html
Normal file
401
modules/_pubsub_utils_.html
Normal file
@ -0,0 +1,401 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"pubsub/utils" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_pubsub_utils_.html">pubsub/utils</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module pubsub/utils</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_pubsub_utils_.html#anymatch" class="tsd-kind-icon">any<wbr>Match</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="_pubsub_utils_.html#ensurearray" class="tsd-kind-icon">ensure<wbr>Array</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_pubsub_utils_.html#msgid" class="tsd-kind-icon">msg<wbr>Id</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_pubsub_utils_.html#nosignmsgid" class="tsd-kind-icon">no<wbr>Sign<wbr>Msg<wbr>Id</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="_pubsub_utils_.html#normalizeinrpcmessage" class="tsd-kind-icon">normalize<wbr>InRpc<wbr>Message</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="_pubsub_utils_.html#normalizeoutrpcmessage" class="tsd-kind-icon">normalize<wbr>Out<wbr>Rpc<wbr>Message</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_pubsub_utils_.html#randomseqno" class="tsd-kind-icon">random<wbr>Seqno</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="anymatch" class="tsd-anchor"></a>
|
||||
<h3>any<wbr>Match</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">any<wbr>Match<span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, b<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>a: <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>b: <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a name="ensurearray" class="tsd-anchor"></a>
|
||||
<h3>ensure<wbr>Array</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">ensure<wbr>Array<T><span class="tsd-signature-symbol">(</span>maybeArray<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T</h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>maybeArray: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="msgid" class="tsd-anchor"></a>
|
||||
<h3>msg<wbr>Id</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">msg<wbr>Id<span class="tsd-signature-symbol">(</span>from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, seqno<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>from: <span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>seqno: <span class="tsd-signature-type">Uint8Array</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="nosignmsgid" class="tsd-anchor"></a>
|
||||
<h3>no<wbr>Sign<wbr>Msg<wbr>Id</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">no<wbr>Sign<wbr>Msg<wbr>Id<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>data: <span class="tsd-signature-type">Uint8Array</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a name="normalizeinrpcmessage" class="tsd-anchor"></a>
|
||||
<h3>normalize<wbr>InRpc<wbr>Message</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">normalize<wbr>InRpc<wbr>Message<T><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>receivedFrom<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span>, peerId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>peerId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>message: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>receivedFrom<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> peerId: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>peerId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a name="normalizeoutrpcmessage" class="tsd-anchor"></a>
|
||||
<h3>normalize<wbr>Out<wbr>Rpc<wbr>Message</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<li class="tsd-signature tsd-kind-icon">normalize<wbr>Out<wbr>Rpc<wbr>Message<T><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
||||
<ul class="tsd-type-parameters">
|
||||
<li>
|
||||
<h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>message: <span class="tsd-signature-type">T</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>from<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="randomseqno" class="tsd-anchor"></a>
|
||||
<h3>random<wbr>Seqno</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">random<wbr>Seqno<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_pubsub_utils_.html">pubsub/utils</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="_pubsub_utils_.html#anymatch" class="tsd-kind-icon">any<wbr>Match</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="_pubsub_utils_.html#ensurearray" class="tsd-kind-icon">ensure<wbr>Array</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="_pubsub_utils_.html#msgid" class="tsd-kind-icon">msg<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="_pubsub_utils_.html#nosignmsgid" class="tsd-kind-icon">no<wbr>Sign<wbr>Msg<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="_pubsub_utils_.html#normalizeinrpcmessage" class="tsd-kind-icon">normalize<wbr>InRpc<wbr>Message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
|
||||
<a href="_pubsub_utils_.html#normalizeoutrpcmessage" class="tsd-kind-icon">normalize<wbr>Out<wbr>Rpc<wbr>Message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="_pubsub_utils_.html#randomseqno" class="tsd-kind-icon">random<wbr>Seqno</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_record_tests_index_.html
Normal file
236
modules/_record_tests_index_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"record/tests/index" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_record_tests_index_.html">record/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module record/tests/index</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_record_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>test: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_record_tests_index_.html">record/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_record_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
213
modules/_record_types_.html
Normal file
213
modules/_record_types_.html
Normal file
@ -0,0 +1,213 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"record/types" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_record_types_.html">record/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module record/types</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_record_types_.record.html" class="tsd-kind-icon">Record</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_record_types_.html">record/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="../interfaces/_record_types_.record.html" class="tsd-kind-icon">Record</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_stream_muxer_tests_base_test_.html
Normal file
236
modules/_stream_muxer_tests_base_test_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"stream-muxer/tests/base-test" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_stream_muxer_tests_base_test_.html">stream-muxer/tests/base-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module stream-muxer/tests/base-test</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_stream_muxer_tests_base_test_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_stream_muxer_tests_base_test_.html">stream-muxer/tests/base-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_stream_muxer_tests_base_test_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_stream_muxer_tests_close_test_.html
Normal file
236
modules/_stream_muxer_tests_close_test_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"stream-muxer/tests/close-test" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_stream_muxer_tests_close_test_.html">stream-muxer/tests/close-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module stream-muxer/tests/close-test</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_stream_muxer_tests_close_test_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_stream_muxer_tests_close_test_.html">stream-muxer/tests/close-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_stream_muxer_tests_close_test_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_stream_muxer_tests_index_.html
Normal file
236
modules/_stream_muxer_tests_index_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"stream-muxer/tests/index" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_stream_muxer_tests_index_.html">stream-muxer/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module stream-muxer/tests/index</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_stream_muxer_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_stream_muxer_tests_index_.html">stream-muxer/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_stream_muxer_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_stream_muxer_tests_mega_stress_test_.html
Normal file
236
modules/_stream_muxer_tests_mega_stress_test_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"stream-muxer/tests/mega-stress-test" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_stream_muxer_tests_mega_stress_test_.html">stream-muxer/tests/mega-stress-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module stream-muxer/tests/mega-stress-test</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_stream_muxer_tests_mega_stress_test_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_stream_muxer_tests_mega_stress_test_.html">stream-muxer/tests/mega-stress-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_stream_muxer_tests_mega_stress_test_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
245
modules/_stream_muxer_tests_spawner_.html
Normal file
245
modules/_stream_muxer_tests_spawner_.html
Normal file
@ -0,0 +1,245 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"stream-muxer/tests/spawner" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_stream_muxer_tests_spawner_.html">stream-muxer/tests/spawner</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module stream-muxer/tests/spawner</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_stream_muxer_tests_spawner_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>Muxer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, nStreams<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, nMsg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, limit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>Muxer: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>nStreams: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>nMsg: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5>limit: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_stream_muxer_tests_spawner_.html">stream-muxer/tests/spawner</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_stream_muxer_tests_spawner_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_stream_muxer_tests_stress_test_.html
Normal file
236
modules/_stream_muxer_tests_stress_test_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"stream-muxer/tests/stress-test" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_stream_muxer_tests_stress_test_.html">stream-muxer/tests/stress-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module stream-muxer/tests/stress-test</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_stream_muxer_tests_stress_test_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_stream_muxer_tests_stress_test_.html">stream-muxer/tests/stress-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_stream_muxer_tests_stress_test_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
344
modules/_stream_muxer_types_.html
Normal file
344
modules/_stream_muxer_types_.html
Normal file
@ -0,0 +1,344 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"stream-muxer/types" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_stream_muxer_types_.html">stream-muxer/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module stream-muxer/types</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-kind-icon">Muxed<wbr>Stream</a></li>
|
||||
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_stream_muxer_types_.muxer.html" class="tsd-kind-icon">Muxer</a></li>
|
||||
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_stream_muxer_types_.muxerfactory.html" class="tsd-kind-icon">Muxer<wbr>Factory</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_stream_muxer_types_.html#muxedtimeline" class="tsd-kind-icon">Muxed<wbr>Timeline</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_stream_muxer_types_.html#muxeroptions" class="tsd-kind-icon">Muxer<wbr>Options</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_stream_muxer_types_.html#sink" class="tsd-kind-icon">Sink</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a name="muxedtimeline" class="tsd-anchor"></a>
|
||||
<h3>Muxed<wbr>Timeline</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Muxed<wbr>Timeline<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>close<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>open<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> close<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>open<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a name="muxeroptions" class="tsd-anchor"></a>
|
||||
<h3>Muxer<wbr>Options</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Muxer<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>maxMsgSize<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>onStream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">; </span>onStreamEnd<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Msg<wbr>Size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>on<wbr>Stream<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>stream: <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>on<wbr>Stream<wbr>End<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-variable">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>stream: <a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-signature-type">MuxedStream</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a name="sink" class="tsd-anchor"></a>
|
||||
<h3>Sink</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Sink<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter-signature">
|
||||
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias">
|
||||
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>source: <span class="tsd-signature-type">Uint8Array</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_stream_muxer_types_.html">stream-muxer/types</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="../interfaces/_stream_muxer_types_.muxedstream.html" class="tsd-kind-icon">Muxed<wbr>Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="../interfaces/_stream_muxer_types_.muxer.html" class="tsd-kind-icon">Muxer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface tsd-parent-kind-module">
|
||||
<a href="../interfaces/_stream_muxer_types_.muxerfactory.html" class="tsd-kind-icon">Muxer<wbr>Factory</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="_stream_muxer_types_.html#muxedtimeline" class="tsd-kind-icon">Muxed<wbr>Timeline</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="_stream_muxer_types_.html#muxeroptions" class="tsd-kind-icon">Muxer<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
|
||||
<a href="_stream_muxer_types_.html#sink" class="tsd-kind-icon">Sink</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
318
modules/_topology_index_.html
Normal file
318
modules/_topology_index_.html
Normal file
@ -0,0 +1,318 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"topology/index" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_topology_index_.html">topology/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module topology/index</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_topology_index_.topology.html" class="tsd-kind-icon">Topology</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_index_.html#connection" class="tsd-kind-icon">Connection</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_index_.html#handlers" class="tsd-kind-icon">Handlers</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_index_.html#options" class="tsd-kind-icon">Options</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_index_.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="connection" class="tsd-anchor"></a>
|
||||
<h3>Connection</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Connection<span class="tsd-signature-symbol">:</span> <a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="handlers" class="tsd-anchor"></a>
|
||||
<h3>Handlers</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Handlers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>onConnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>onDisconnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="../classes/_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Connect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>protocol "onConnect" handler</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Disconnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="../classes/_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>protocol "onDisconnect" handler</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="options" class="tsd-anchor"></a>
|
||||
<h3>Options</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>handlers<span class="tsd-signature-symbol">?: </span><a href="_topology_index_.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>max<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>min<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> handlers<span class="tsd-signature-symbol">?: </span><a href="_topology_index_.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> max<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>maximum needed connections.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> min<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>minimum needed connections.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="peerid" class="tsd-anchor"></a>
|
||||
<h3>Peer<wbr>Id</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Peer<wbr>Id<span class="tsd-signature-symbol">:</span> <a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_topology_index_.html">topology/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="../classes/_topology_index_.topology.html" class="tsd-kind-icon">Topology</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_index_.html#connection" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_index_.html#handlers" class="tsd-kind-icon">Handlers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_index_.html#options" class="tsd-kind-icon">Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_index_.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
377
modules/_topology_multicodec_topology_.html
Normal file
377
modules/_topology_multicodec_topology_.html
Normal file
@ -0,0 +1,377 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"topology/multicodec-topology" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_topology_multicodec_topology_.html">topology/multicodec-topology</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module topology/multicodec-topology</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_topology_multicodec_topology_.multicodectopology.html" class="tsd-kind-icon">Multicodec<wbr>Topology</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Type aliases</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_multicodec_topology_.html#connection" class="tsd-kind-icon">Connection</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_multicodec_topology_.html#handlers" class="tsd-kind-icon">Handlers</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_multicodec_topology_.html#multiaddr" class="tsd-kind-icon">Multiaddr</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_multicodec_topology_.html#multicodecoptions" class="tsd-kind-icon">Multicodec<wbr>Options</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_multicodec_topology_.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a></li>
|
||||
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_multicodec_topology_.html#topologyoptions" class="tsd-kind-icon">Topology<wbr>Options</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_multicodec_topology_.html#multicodectopology_base" class="tsd-kind-icon">Multicodec<wbr>Topology_<wbr>base</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Type aliases</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="connection" class="tsd-anchor"></a>
|
||||
<h3>Connection</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Connection<span class="tsd-signature-symbol">:</span> <a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="handlers" class="tsd-anchor"></a>
|
||||
<h3>Handlers</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Handlers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>onConnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>onDisconnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="../classes/_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Connect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>protocol "onConnect" handler</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Disconnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="../classes/_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>protocol "onDisconnect" handler</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="multiaddr" class="tsd-anchor"></a>
|
||||
<h3>Multiaddr</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Multiaddr<span class="tsd-signature-symbol">:</span> <a href="_topology_multicodec_topology_.html#multiaddr" class="tsd-signature-type">Multiaddr</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="multicodecoptions" class="tsd-anchor"></a>
|
||||
<h3>Multicodec<wbr>Options</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Multicodec<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>handlers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><a href="_topology_multicodec_topology_.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>multicodecs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>handlers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Required</span><span class="tsd-signature-symbol"><</span><a href="_topology_multicodec_topology_.html#handlers" class="tsd-signature-type">Handlers</a><span class="tsd-signature-symbol">></span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>multicodecs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>protocol multicodecs</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="peerid" class="tsd-anchor"></a>
|
||||
<h3>Peer<wbr>Id</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Peer<wbr>Id<span class="tsd-signature-symbol">:</span> <a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="topologyoptions" class="tsd-anchor"></a>
|
||||
<h3>Topology<wbr>Options</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Topology<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>handlers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>onConnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>onDisconnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="../classes/_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>max<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>min<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> handlers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>onConnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, conn<span class="tsd-signature-symbol">: </span><a href="../classes/_connection_connection_.connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">; </span>onDisconnect<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>peerId<span class="tsd-signature-symbol">: </span><a href="_pubsub_peer_streams_.html#peerid" class="tsd-signature-type">PeerId</a>, error<span class="tsd-signature-symbol">?: </span><a href="../classes/_crypto_errors_.unexpectedpeererror.html#error" class="tsd-signature-type">Error</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> max<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>maximum needed connections.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> min<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>minimum needed connections.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="multicodectopology_base" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> Multicodec<wbr>Topology_<wbr>base</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Multicodec<wbr>Topology_<wbr>base<span class="tsd-signature-symbol">:</span> <a href="../classes/_topology_index_.topology.html" class="tsd-signature-type">Topology</a></div>
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_topology_multicodec_topology_.html">topology/multicodec-topology</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="../classes/_topology_multicodec_topology_.multicodectopology.html" class="tsd-kind-icon">Multicodec<wbr>Topology</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_multicodec_topology_.html#connection" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_multicodec_topology_.html#handlers" class="tsd-kind-icon">Handlers</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_multicodec_topology_.html#multiaddr" class="tsd-kind-icon">Multiaddr</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_multicodec_topology_.html#multicodecoptions" class="tsd-kind-icon">Multicodec<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_multicodec_topology_.html#peerid" class="tsd-kind-icon">Peer<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_multicodec_topology_.html#topologyoptions" class="tsd-kind-icon">Topology<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_multicodec_topology_.html#multicodectopology_base" class="tsd-kind-icon">Multicodec<wbr>Topology_<wbr>base</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_topology_tests_multicodec_topology_.html
Normal file
236
modules/_topology_tests_multicodec_topology_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"topology/tests/multicodec-topology" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_topology_tests_multicodec_topology_.html">topology/tests/multicodec-topology</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module topology/tests/multicodec-topology</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_tests_multicodec_topology_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>test: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_topology_tests_multicodec_topology_.html">topology/tests/multicodec-topology</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_tests_multicodec_topology_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_topology_tests_topology_.html
Normal file
236
modules/_topology_tests_topology_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"topology/tests/topology" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_topology_tests_topology_.html">topology/tests/topology</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module topology/tests/topology</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_topology_tests_topology_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>test: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_topology_tests_topology_.html">topology/tests/topology</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_topology_tests_topology_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
213
modules/_transport_errors_.html
Normal file
213
modules/_transport_errors_.html
Normal file
@ -0,0 +1,213 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"transport/errors" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_transport_errors_.html">transport/errors</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module transport/errors</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_transport_errors_.aborterror.html" class="tsd-kind-icon">Abort<wbr>Error</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_transport_errors_.html">transport/errors</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||||
<a href="../classes/_transport_errors_.aborterror.html" class="tsd-kind-icon">Abort<wbr>Error</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_transport_tests_dial_test_.html
Normal file
236
modules/_transport_tests_dial_test_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"transport/tests/dial-test" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_transport_tests_dial_test_.html">transport/tests/dial-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module transport/tests/dial-test</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_transport_tests_dial_test_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_transport_tests_dial_test_.html">transport/tests/dial-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_transport_tests_dial_test_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_transport_tests_filter_test_.html
Normal file
236
modules/_transport_tests_filter_test_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"transport/tests/filter-test" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_transport_tests_filter_test_.html">transport/tests/filter-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module transport/tests/filter-test</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_transport_tests_filter_test_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_transport_tests_filter_test_.html">transport/tests/filter-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_transport_tests_filter_test_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_transport_tests_index_.html
Normal file
236
modules/_transport_tests_index_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"transport/tests/index" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_transport_tests_index_.html">transport/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module transport/tests/index</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_transport_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_transport_tests_index_.html">transport/tests/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_transport_tests_index_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
236
modules/_transport_tests_listen_test_.html
Normal file
236
modules/_transport_tests_listen_test_.html
Normal file
@ -0,0 +1,236 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"transport/tests/listen-test" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_transport_tests_listen_test_.html">transport/tests/listen-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module transport/tests/listen-test</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_transport_tests_listen_test_.html#_exports" class="tsd-kind-icon">_exports</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a name="_exports" class="tsd-anchor"></a>
|
||||
<h3>_exports</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<li class="tsd-signature tsd-kind-icon">_exports<span class="tsd-signature-symbol">(</span>common<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>common: <span class="tsd-signature-type">any</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_transport_tests_listen_test_.html">transport/tests/listen-test</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
|
||||
<a href="_transport_tests_listen_test_.html#_exports" class="tsd-kind-icon">_exports</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
239
modules/_transport_tests_utils_index_.html
Normal file
239
modules/_transport_tests_utils_index_.html
Normal file
@ -0,0 +1,239 @@
|
||||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>"transport/tests/utils/index" | libp2p-interfaces - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for libp2p-interfaces - v0.8.0">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
|
||||
<style>
|
||||
.toolbar-icon {
|
||||
display: inline-block;
|
||||
vertical-align: middle;
|
||||
margin-left: 10px;
|
||||
cursor: pointer;
|
||||
}
|
||||
.toolbar-icon-search {
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
overflow: hidden;
|
||||
right: -40px;
|
||||
width: 40px;
|
||||
height: 40px;
|
||||
display: flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
@media (min-width: 901px){
|
||||
display: none
|
||||
}
|
||||
}
|
||||
@media (min-width: 901px){
|
||||
.toolbar-icon-menu {
|
||||
display: none
|
||||
}
|
||||
.toolbar-icon-options {
|
||||
display: none
|
||||
}
|
||||
}
|
||||
|
||||
.gg-menu {
|
||||
transform: scale(var(--ggs,1))
|
||||
}
|
||||
.gg-menu,
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
width: 20px;
|
||||
height: 2px;
|
||||
border-radius: 3px;
|
||||
background: currentColor
|
||||
}
|
||||
.gg-menu::after,
|
||||
.gg-menu::before {
|
||||
content: "";
|
||||
position: absolute;
|
||||
top: -6px
|
||||
}
|
||||
.gg-menu::after {
|
||||
top: 6px
|
||||
}
|
||||
.gg-options {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 10px;
|
||||
height: 2px;
|
||||
box-shadow:
|
||||
-3px 4px 0 0,
|
||||
3px -4px 0 0
|
||||
}
|
||||
.gg-options::after,
|
||||
.gg-options::before {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%
|
||||
}
|
||||
.gg-options::before {
|
||||
top: -7px;
|
||||
left: -4px
|
||||
}
|
||||
.gg-options::after {
|
||||
bottom: -7px;
|
||||
right: -4px
|
||||
}
|
||||
.gg-search {
|
||||
box-sizing: border-box;
|
||||
position: relative;
|
||||
display: block;
|
||||
transform: scale(var(--ggs,1));
|
||||
width: 16px;
|
||||
height: 16px;
|
||||
border: 2px solid;
|
||||
border-radius: 100%;
|
||||
margin-left: -4px;
|
||||
margin-top: -4px
|
||||
}
|
||||
.gg-search::after {
|
||||
content: "";
|
||||
display: block;
|
||||
box-sizing: border-box;
|
||||
position: absolute;
|
||||
border-radius: 3px;
|
||||
width: 2px;
|
||||
height: 8px;
|
||||
background: currentColor;
|
||||
transform: rotate(-45deg);
|
||||
top: 10px;
|
||||
left: 12px
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">libp2p-interfaces - v0.8.0</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="_transport_tests_utils_index_.html">transport/tests/utils/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Module transport/tests/utils/index</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_transport_tests_utils_index_.html#isvalidtick" class="tsd-kind-icon">is<wbr>Valid<wbr>Tick</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Functions</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="isvalidtick" class="tsd-anchor"></a>
|
||||
<h3>is<wbr>Valid<wbr>Tick</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Valid<wbr>Tick<span class="tsd-signature-symbol">(</span>date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, ms<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>date: <span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ms: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="_transport_tests_utils_index_.html">transport/tests/utils/index</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="_transport_tests_utils_index_.html#isvalidtick" class="tsd-kind-icon">is<wbr>Valid<wbr>Tick</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer>
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user