UNPKG

textiot

Version:

A framework for building web and native (IoT) Dapps on the IPFS network

722 lines 34.4 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Textile | @textile/js-http-client</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </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.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</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">@textile/js-http-client</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Globals</a> </li> <li> <a href="textile.html">Textile</a> </li> </ul> <h1>Class Textile</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>Textile is the main client class</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Textile</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-class"><a href="textile.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="textile.html#account" class="tsd-kind-icon">account</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#blocks" class="tsd-kind-icon">blocks</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#cafes" class="tsd-kind-icon">cafes</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#comments" class="tsd-kind-icon">comments</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#config" class="tsd-kind-icon">config</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#contacts" class="tsd-kind-icon">contacts</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#events" class="tsd-kind-icon">events</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#feed" class="tsd-kind-icon">feed</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#file" class="tsd-kind-icon">file</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#files" class="tsd-kind-icon">files</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#invites" class="tsd-kind-icon">invites</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#ipfs" class="tsd-kind-icon">ipfs</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#likes" class="tsd-kind-icon">likes</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#logs" class="tsd-kind-icon">logs</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#messages" class="tsd-kind-icon">messages</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#notifications" class="tsd-kind-icon">notifications</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#observe" class="tsd-kind-icon">observe</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#profile" class="tsd-kind-icon">profile</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#schemas" class="tsd-kind-icon">schemas</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#threads" class="tsd-kind-icon">threads</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#tokens" class="tsd-kind-icon">tokens</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="textile.html#utils" class="tsd-kind-icon">utils</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 tsd-is-static"><a href="textile.html#create" class="tsd-kind-icon">create</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>Textile<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/textileoptions.html" class="tsd-signature-type">TextileOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="textile.html" class="tsd-signature-type">Textile</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L82">index.ts:82</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/textileoptions.html" class="tsd-signature-type">TextileOptions</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="textile.html" class="tsd-signature-type">Textile</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="account" class="tsd-anchor"></a> <h3>account</h3> <div class="tsd-signature tsd-kind-icon">account<span class="tsd-signature-symbol">:</span> <a href="account.html" class="tsd-signature-type">Account</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L40">index.ts:40</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Account} account - Manage Textile node account</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="blocks" class="tsd-anchor"></a> <h3>blocks</h3> <div class="tsd-signature tsd-kind-icon">blocks<span class="tsd-signature-symbol">:</span> <a href="blocks.html" class="tsd-signature-type">Blocks</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L42">index.ts:42</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Blocks} blocks - Manage Textile Blocks</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="cafes" class="tsd-anchor"></a> <h3>cafes</h3> <div class="tsd-signature tsd-kind-icon">cafes<span class="tsd-signature-symbol">:</span> <a href="cafes.html" class="tsd-signature-type">Cafes</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L44">index.ts:44</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Cafes} account - Manage Textile Cafes</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="comments" class="tsd-anchor"></a> <h3>comments</h3> <div class="tsd-signature tsd-kind-icon">comments<span class="tsd-signature-symbol">:</span> <a href="comments.html" class="tsd-signature-type">Comments</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L48">index.ts:48</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Comments} comments - Manage Textile block Comments</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="config" class="tsd-anchor"></a> <h3>config</h3> <div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <a href="config.html" class="tsd-signature-type">Config</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L46">index.ts:46</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Config} config - Manage Textile Config settings</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="contacts" class="tsd-anchor"></a> <h3>contacts</h3> <div class="tsd-signature tsd-kind-icon">contacts<span class="tsd-signature-symbol">:</span> <a href="contacts.html" class="tsd-signature-type">Contacts</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L50">index.ts:50</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Contacts} contacts - Manage Textile peer Contacts</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="events" class="tsd-anchor"></a> <h3>events</h3> <div class="tsd-signature tsd-kind-icon">events<span class="tsd-signature-symbol">:</span> <a href="events.html" class="tsd-signature-type">Events</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L52">index.ts:52</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Events} events - Manage the Textile Events</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="feed" class="tsd-anchor"></a> <h3>feed</h3> <div class="tsd-signature tsd-kind-icon">feed<span class="tsd-signature-symbol">:</span> <a href="feed.html" class="tsd-signature-type">Feed</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L54">index.ts:54</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Feed} feed - Manage the Textile Feed</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="file" class="tsd-anchor"></a> <h3>file</h3> <div class="tsd-signature tsd-kind-icon">file<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">File</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L56">index.ts:56</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{File} file - Manage a Textile File</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="files" class="tsd-anchor"></a> <h3>files</h3> <div class="tsd-signature tsd-kind-icon">files<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Files</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L58">index.ts:58</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Files} files - Manage Textile Files</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="invites" class="tsd-anchor"></a> <h3>invites</h3> <div class="tsd-signature tsd-kind-icon">invites<span class="tsd-signature-symbol">:</span> <a href="invites.html" class="tsd-signature-type">Invites</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L60">index.ts:60</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Invites} invites - Manage Textile Invites</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="ipfs" class="tsd-anchor"></a> <h3>ipfs</h3> <div class="tsd-signature tsd-kind-icon">ipfs<span class="tsd-signature-symbol">:</span> <a href="ipfs.html" class="tsd-signature-type">IPFS</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L62">index.ts:62</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{IPFS} ipfs - Manage the underlying IPFS peer</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="likes" class="tsd-anchor"></a> <h3>likes</h3> <div class="tsd-signature tsd-kind-icon">likes<span class="tsd-signature-symbol">:</span> <a href="likes.html" class="tsd-signature-type">Likes</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L64">index.ts:64</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Likes} likes - Manage Textile block Likes</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="logs" class="tsd-anchor"></a> <h3>logs</h3> <div class="tsd-signature tsd-kind-icon">logs<span class="tsd-signature-symbol">:</span> <a href="logs.html" class="tsd-signature-type">Logs</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L66">index.ts:66</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Logs} logs - Manage Textile subsystem logs</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="messages" class="tsd-anchor"></a> <h3>messages</h3> <div class="tsd-signature tsd-kind-icon">messages<span class="tsd-signature-symbol">:</span> <a href="messages.html" class="tsd-signature-type">Messages</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L68">index.ts:68</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Messages} messages - Manage Textile thread Messages</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="notifications" class="tsd-anchor"></a> <h3>notifications</h3> <div class="tsd-signature tsd-kind-icon">notifications<span class="tsd-signature-symbol">:</span> <a href="notifications.html" class="tsd-signature-type">Notifications</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L70">index.ts:70</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Notifications} notifications - Manage Textile Notifications</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="observe" class="tsd-anchor"></a> <h3>observe</h3> <div class="tsd-signature tsd-kind-icon">observe<span class="tsd-signature-symbol">:</span> <a href="observe.html" class="tsd-signature-type">Observe</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L76">index.ts:76</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Observe} observe - Observe (real-time) thread updates</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="profile" class="tsd-anchor"></a> <h3>profile</h3> <div class="tsd-signature tsd-kind-icon">profile<span class="tsd-signature-symbol">:</span> <a href="profile.html" class="tsd-signature-type">Profile</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L72">index.ts:72</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Profile} profile - Manage a Textile node&#39;s public profile</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="schemas" class="tsd-anchor"></a> <h3>schemas</h3> <div class="tsd-signature tsd-kind-icon">schemas<span class="tsd-signature-symbol">:</span> <a href="schemas.html" class="tsd-signature-type">Schemas</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L74">index.ts:74</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Schemas} schemas - Manage Textile Schemas</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="threads" class="tsd-anchor"></a> <h3>threads</h3> <div class="tsd-signature tsd-kind-icon">threads<span class="tsd-signature-symbol">:</span> <a href="threads.html" class="tsd-signature-type">Threads</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L78">index.ts:78</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Threads} threads - Manage Textile Threads</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="tokens" class="tsd-anchor"></a> <h3>tokens</h3> <div class="tsd-signature tsd-kind-icon">tokens<span class="tsd-signature-symbol">:</span> <a href="tokens.html" class="tsd-signature-type">Tokens</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L80">index.ts:80</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Tokens} tokens - Manage Textile Threads</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="utils" class="tsd-anchor"></a> <h3>utils</h3> <div class="tsd-signature tsd-kind-icon">utils<span class="tsd-signature-symbol">:</span> <a href="utils.html" class="tsd-signature-type">Utils</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L82">index.ts:82</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>property</dt> <dd><p>{Utils} utils - Get information about the Textile node</p> </dd> </dl> </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-class tsd-is-static"> <a name="create" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/textileoptions.html" class="tsd-signature-type">TextileOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="textile.html" class="tsd-signature-type">Textile</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/textileio/js-http-client/blob/master/src/index.ts#L36">index.ts:36</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns a new instance of Textile</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/textileoptions.html" class="tsd-signature-type">TextileOptions</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="textile.html" class="tsd-signature-type">Textile</a></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="globals "> <a href="../globals.html"><em>Globals</em></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"> <a href="textile.html" class="tsd-kind-icon">Textile</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="textile.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#account" class="tsd-kind-icon">account</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#blocks" class="tsd-kind-icon">blocks</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#cafes" class="tsd-kind-icon">cafes</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#comments" class="tsd-kind-icon">comments</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#config" class="tsd-kind-icon">config</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#contacts" class="tsd-kind-icon">contacts</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#events" class="tsd-kind-icon">events</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#feed" class="tsd-kind-icon">feed</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#file" class="tsd-kind-icon">file</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#files" class="tsd-kind-icon">files</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#invites" class="tsd-kind-icon">invites</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#ipfs" class="tsd-kind-icon">ipfs</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#likes" class="tsd-kind-icon">likes</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#logs" class="tsd-kind-icon">logs</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#messages" class="tsd-kind-icon">messages</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#notifications" class="tsd-kind-icon">notifications</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#observe" class="tsd-kind-icon">observe</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#profile" class="tsd-kind-icon">profile</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#schemas" class="tsd-kind-icon">schemas</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#threads" class="tsd-kind-icon">threads</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#tokens" class="tsd-kind-icon">tokens</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="textile.html#utils" class="tsd-kind-icon">utils</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a href="textile.html#create" class="tsd-kind-icon">create</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-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</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-index-signature"><span class="tsd-kind-icon">Index signature</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-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><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> <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> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</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> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <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> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</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> <li class="tsd-kind-call-signature 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> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>