440 lines
24 KiB
HTML
440 lines
24 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>megalodon</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">megalodon</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>
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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>
|
|
</ul>
|
|
<h1>megalodon</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="#megalodon" id="megalodon" style="color: inherit; text-decoration: none;">
|
|
<h1>Megalodon</h1>
|
|
</a>
|
|
<p><a href="https://travis-ci.com/h3poteto/megalodon"><img src="https://travis-ci.com/h3poteto/megalodon.svg?branch=master" alt="Build Status"></a>
|
|
<a href="https://www.npmjs.com/package/megalodon"><img src="https://img.shields.io/npm/v/megalodon.svg" alt="NPM Version"></a>
|
|
<a href="https://github.com/h3poteto/megalodon/releases"><img src="https://img.shields.io/github/release/h3poteto/megalodon.svg" alt="GitHub release"></a>
|
|
<a href="https://www.npmjs.com/package/megalodon"><img src="https://img.shields.io/npm/dm/megalodon" alt="npm"></a>
|
|
<a href="/LICENSE.txt"><img src="https://img.shields.io/npm/l/megalodon" alt="NPM"></a></p>
|
|
<p>A Mastodon, Pleroma and Misskey API Client library for node.js and browser. It provides REST API and streaming methods.
|
|
By using this library, you can take Mastodon, Pleroma and Misskey with the same interface.</p>
|
|
<a href="#migrate-v2x-to-v300" id="migrate-v2x-to-v300" style="color: inherit; text-decoration: none;">
|
|
<h2>!!Migrate v2.x to v3.0.0</h2>
|
|
</a>
|
|
<p>There are some breaking changes, so you can not update megalodon out of the box.
|
|
Please refer <a href="migration_guide.md">migration guide</a> before you update megalodon version.</p>
|
|
<a href="#features" id="features" style="color: inherit; text-decoration: none;">
|
|
<h2>Features</h2>
|
|
</a>
|
|
<ul>
|
|
<li>REST API</li>
|
|
<li>Streaming with Server-Sent Event</li>
|
|
<li>Streaming with WebSocket</li>
|
|
<li>Promisified methods</li>
|
|
<li>Proxy support</li>
|
|
<li>Support node.js and browser</li>
|
|
<li>Written in typescript</li>
|
|
</ul>
|
|
<a href="#install" id="install" style="color: inherit; text-decoration: none;">
|
|
<h2>Install</h2>
|
|
</a>
|
|
<pre><code>$ npm <span class="hljs-keyword">install</span> -S megalodon</code></pre><p>or</p>
|
|
<pre><code>$ yarn <span class="hljs-keyword">add</span><span class="bash"> megalodon</span></code></pre>
|
|
<a href="#build-for-browser" id="build-for-browser" style="color: inherit; text-decoration: none;">
|
|
<h3>Build for browser</h3>
|
|
</a>
|
|
<p><strong>Important</strong>: In browser, you can not use proxy.</p>
|
|
<p>If you want to build for browser, please use Webpack and set empty value for these libraries.</p>
|
|
<ul>
|
|
<li>net</li>
|
|
<li>tls</li>
|
|
<li>dns</li>
|
|
</ul>
|
|
<pre><code class="language-javascript"> node: {
|
|
<span class="hljs-attr">net</span>: <span class="hljs-string">'empty'</span>,
|
|
<span class="hljs-attr">tls</span>: <span class="hljs-string">'empty'</span>,
|
|
<span class="hljs-attr">dns</span>: <span class="hljs-string">'empty'</span>
|
|
}</code></pre>
|
|
<p>These libraries are for node.js, so can not use in browser.</p>
|
|
<p><a href="example/browser/webpack.config.js">Here</a> is example Webpack configuration.</p>
|
|
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
|
|
<h2>Usage</h2>
|
|
</a>
|
|
<p>I prepared <a href="example">examples</a>, and please refer <a href="https://h3poteto.github.io/megalodon/">documents</a> about each methods.</p>
|
|
<p>I explain some typical methods.
|
|
At first, please get your access token for a fediverse server.
|
|
If you don't have access token, or you want to register applications and get access token programmably, please refer <a href="#authorization">Authorization section</a>.</p>
|
|
<a href="#home-timeline" id="home-timeline" style="color: inherit; text-decoration: none;">
|
|
<h3>Home timeline</h3>
|
|
</a>
|
|
<pre><code class="language-typescript"><span class="hljs-keyword">import</span> generator, { Entity, Response } <span class="hljs-keyword">from</span> <span class="hljs-string">'megalodon'</span>
|
|
|
|
<span class="hljs-keyword">const</span> BASE_URL: <span class="hljs-built_in">string</span> = <span class="hljs-string">'https://mastodon.social'</span>
|
|
<span class="hljs-keyword">const</span> access_token: <span class="hljs-built_in">string</span> = <span class="hljs-string">'...'</span>
|
|
|
|
<span class="hljs-keyword">const</span> client = generator(<span class="hljs-string">'mastodon'</span>, BASE_URL, access_token)
|
|
client.getHomeTimeline()
|
|
.then(<span class="hljs-function">(<span class="hljs-params">res: Response<<span class="hljs-built_in">Array</span><Entity.Status>></span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.log(res.data)
|
|
})</code></pre>
|
|
<a href="#post-toot" id="post-toot" style="color: inherit; text-decoration: none;">
|
|
<h3>Post toot</h3>
|
|
</a>
|
|
<pre><code class="language-typescript"><span class="hljs-keyword">import</span> generator, { Entity, Response } <span class="hljs-keyword">from</span> <span class="hljs-string">'megalodon'</span>
|
|
|
|
<span class="hljs-keyword">const</span> BASE_URL: <span class="hljs-built_in">string</span> = <span class="hljs-string">'https://mastodon.social'</span>
|
|
<span class="hljs-keyword">const</span> access_token: <span class="hljs-built_in">string</span> = <span class="hljs-string">'...'</span>
|
|
<span class="hljs-keyword">const</span> toot: <span class="hljs-built_in">string</span> = <span class="hljs-string">'test toot'</span>
|
|
|
|
<span class="hljs-keyword">const</span> client = generator(<span class="hljs-string">'mastodon'</span>, BASE_URL, access_token)
|
|
client.postStatus(toot)
|
|
.then(<span class="hljs-function">(<span class="hljs-params">res: Response<Entity.Status></span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.log(res.data)
|
|
})</code></pre>
|
|
<a href="#post-medias" id="post-medias" style="color: inherit; text-decoration: none;">
|
|
<h3>Post medias</h3>
|
|
</a>
|
|
<p>Please provide a file to the argument.</p>
|
|
<pre><code class="language-typescript"><span class="hljs-keyword">import</span> generator, { Entity, Response } <span class="hljs-keyword">from</span> <span class="hljs-string">'megalodon'</span>
|
|
<span class="hljs-keyword">import</span> fs <span class="hljs-keyword">from</span> <span class="hljs-string">'fs'</span>
|
|
|
|
<span class="hljs-keyword">const</span> BASE_URL: <span class="hljs-built_in">string</span> = <span class="hljs-string">'https://mastodon.social'</span>
|
|
<span class="hljs-keyword">const</span> access_token: <span class="hljs-built_in">string</span> = <span class="hljs-string">'...'</span>
|
|
<span class="hljs-keyword">const</span> image = fs.readFileSync(<span class="hljs-string">"test.image"</span>)
|
|
|
|
<span class="hljs-keyword">const</span> client = generator(<span class="hljs-string">'mastodon'</span>, BASE_URL, access_token)
|
|
client.uploadMedia(image)
|
|
.then(<span class="hljs-function">(<span class="hljs-params">res: Response<Entity.Attachment></span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.log(res.data)
|
|
})</code></pre>
|
|
<a href="#websocket-streaming" id="websocket-streaming" style="color: inherit; text-decoration: none;">
|
|
<h3>WebSocket streaming</h3>
|
|
</a>
|
|
<p>Mastodon, Pleroma and Misskey provide WebSocket for streaming.</p>
|
|
<pre><code class="language-typescript"><span class="hljs-keyword">import</span> generator, { Entity, WebSocketInterface } <span class="hljs-keyword">from</span> <span class="hljs-string">'megalodon'</span>
|
|
|
|
<span class="hljs-keyword">const</span> BASE_URL: <span class="hljs-built_in">string</span> = <span class="hljs-string">'wss://pleroma.io'</span>
|
|
<span class="hljs-keyword">const</span> access_token: <span class="hljs-built_in">string</span> = <span class="hljs-string">'...'</span>
|
|
|
|
<span class="hljs-keyword">const</span> client = generator(<span class="hljs-string">'pleroma'</span>, BASE_URL, access_token)
|
|
<span class="hljs-keyword">const</span> stream: WebSocketInterface = client.userSocket()
|
|
|
|
stream.on(<span class="hljs-string">'connect'</span>, <span class="hljs-function"><span class="hljs-params">()</span> =></span> {
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">'connect'</span>)
|
|
})
|
|
|
|
stream.on(<span class="hljs-string">'update'</span>, <span class="hljs-function">(<span class="hljs-params">status: Entity.Status</span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.log(status)
|
|
})
|
|
|
|
stream.on(<span class="hljs-string">'notification'</span>, <span class="hljs-function">(<span class="hljs-params">notification: Entity.Notification</span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.log(notification)
|
|
})
|
|
|
|
stream.on(<span class="hljs-string">'delete'</span>, <span class="hljs-function">(<span class="hljs-params">id: <span class="hljs-built_in">number</span></span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.log(id)
|
|
})
|
|
|
|
stream.on(<span class="hljs-string">'error'</span>, <span class="hljs-function">(<span class="hljs-params">err: <span class="hljs-built_in">Error</span></span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.error(err)
|
|
})
|
|
|
|
stream.on(<span class="hljs-string">'heartbeat'</span>, <span class="hljs-function"><span class="hljs-params">()</span> =></span> {
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">'thump.'</span>)
|
|
})
|
|
|
|
stream.on(<span class="hljs-string">'close'</span>, <span class="hljs-function"><span class="hljs-params">()</span> =></span> {
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">'close'</span>)
|
|
})
|
|
|
|
stream.on(<span class="hljs-string">'parser-error'</span>, <span class="hljs-function">(<span class="hljs-params">err: <span class="hljs-built_in">Error</span></span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.error(err)
|
|
})</code></pre>
|
|
<a href="#http-streaming" id="http-streaming" style="color: inherit; text-decoration: none;">
|
|
<h3>HTTP Streaming</h3>
|
|
</a>
|
|
<p>Mastodon provides HTTP streaming.</p>
|
|
<pre><code class="language-typescript"><span class="hljs-keyword">import</span> generator, { Entity, StreamListenerInterface } <span class="hljs-keyword">from</span> <span class="hljs-string">'megalodon'</span>
|
|
|
|
<span class="hljs-keyword">const</span> BASE_URL: <span class="hljs-built_in">string</span> = <span class="hljs-string">'https://mastodon.social'</span>
|
|
<span class="hljs-keyword">const</span> access_token: <span class="hljs-built_in">string</span> = <span class="hljs-string">'...'</span>
|
|
|
|
<span class="hljs-keyword">const</span> client = generator(<span class="hljs-string">'mastodon'</span>, BASE_URL, access_token)
|
|
<span class="hljs-keyword">const</span> stream: StreamListenerInterface
|
|
|
|
stream.on(<span class="hljs-string">'update'</span>, <span class="hljs-function">(<span class="hljs-params">status: Entity.Status</span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.log(status)
|
|
})
|
|
|
|
stream.on(<span class="hljs-string">'notification'</span>, <span class="hljs-function">(<span class="hljs-params">notification: Entity.Notification</span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.log(notification)
|
|
})
|
|
|
|
stream.on(<span class="hljs-string">'delete'</span>, <span class="hljs-function">(<span class="hljs-params">id: <span class="hljs-built_in">number</span></span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.log(id)
|
|
})
|
|
|
|
stream.on(<span class="hljs-string">'error'</span>, <span class="hljs-function">(<span class="hljs-params">err: <span class="hljs-built_in">Error</span></span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.error(err)
|
|
})
|
|
|
|
stream.on(<span class="hljs-string">'heartbeat'</span>, <span class="hljs-function"><span class="hljs-params">()</span> =></span> {
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">'thump.'</span>)
|
|
})</code></pre>
|
|
<a href="#authorization" id="authorization" style="color: inherit; text-decoration: none;">
|
|
<h3>Authorization</h3>
|
|
</a>
|
|
<p>You can register applications, and get access tokens to use this method.</p>
|
|
<pre><code class="language-typescript"><span class="hljs-keyword">import</span> generator, { OAuth } <span class="hljs-keyword">from</span> <span class="hljs-string">'megalodon'</span>
|
|
|
|
<span class="hljs-keyword">const</span> BASE_URL: <span class="hljs-built_in">string</span> = <span class="hljs-string">'https://mastodon.social'</span>
|
|
|
|
<span class="hljs-keyword">let</span> clientId: <span class="hljs-built_in">string</span>
|
|
<span class="hljs-keyword">let</span> clientSecret: <span class="hljs-built_in">string</span>
|
|
|
|
<span class="hljs-keyword">const</span> client = generator(<span class="hljs-string">'mastodon'</span>, BASE_URL)
|
|
|
|
client.registerApp(<span class="hljs-string">'Test App'</span>)
|
|
.then(<span class="hljs-function"><span class="hljs-params">appData</span> =></span> {
|
|
clientId = appData.clientId
|
|
clientSecret = appData.clientSecret
|
|
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">'Authorization URL is generated.'</span>)
|
|
<span class="hljs-built_in">console</span>.log(appData.url)
|
|
})</code></pre>
|
|
<p>Please open <code>Autorhization URL</code> in your browser, and authorize this app.
|
|
In this time, you can get authorization code.</p>
|
|
<p>After that, get an access token.</p>
|
|
<pre><code class="language-typescript"><span class="hljs-keyword">const</span> code = <span class="hljs-string">'...'</span> <span class="hljs-comment">// Authorization code</span>
|
|
|
|
client.fetchAccessToken(clientId, clientSecret, code)
|
|
})
|
|
.then(<span class="hljs-function">(<span class="hljs-params">tokenData: OAuth.TokenData</span>) =></span> {
|
|
<span class="hljs-built_in">console</span>.log(tokenData.accessToken)
|
|
<span class="hljs-built_in">console</span>.log(tokenData.refreshToken)
|
|
})
|
|
.catch(<span class="hljs-function">(<span class="hljs-params">err: <span class="hljs-built_in">Error</span></span>) =></span> <span class="hljs-built_in">console</span>.error(err))</code></pre>
|
|
<a href="#detect-each-sns" id="detect-each-sns" style="color: inherit; text-decoration: none;">
|
|
<h3>Detect each SNS</h3>
|
|
</a>
|
|
<p>You have to provide SNS name <code>mastodon</code>, <code>pleroma</code> or <code>misskey</code> to <code>generator</code> function.
|
|
But when you only know the URL and not the SNS, <code>detector</code> function can detect the SNS.</p>
|
|
<pre><code class="language-typescript"><span class="hljs-keyword">import</span> { detector } <span class="hljs-keyword">from</span> <span class="hljs-string">'megalodon'</span>
|
|
|
|
<span class="hljs-keyword">const</span> URL = <span class="hljs-string">'https://misskey.io'</span>
|
|
|
|
<span class="hljs-keyword">const</span> sns = <span class="hljs-keyword">await</span> detector(URL)
|
|
<span class="hljs-built_in">console</span>.log(sns)</code></pre>
|
|
<a href="#license" id="license" style="color: inherit; text-decoration: none;">
|
|
<h2>License</h2>
|
|
</a>
|
|
<p>The software is available as open source under the terms of the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
</div>
|
|
</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>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="modules/entity.html">Entity</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="modules/mastodonapi.html">MastodonAPI</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="modules/mastodonentity.html">Mastodon<wbr>Entity</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="modules/misskeyapi.html">MisskeyAPI</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="modules/misskeyentity.html">Misskey<wbr>Entity</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="modules/oauth.html">OAuth</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="modules/pleromaapi.html">PleromaAPI</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-enum">
|
|
<a href="enums/notificationtype.html" class="tsd-kind-icon">Notification<wbr>Type</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/argumenterror.html" class="tsd-kind-icon">Argument<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/mastodon.html" class="tsd-kind-icon">Mastodon</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/misskey.html" class="tsd-kind-icon">Misskey</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/noimplementederror.html" class="tsd-kind-icon">No<wbr>Implemented<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/parser.html" class="tsd-kind-icon">Parser</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/pleroma.html" class="tsd-kind-icon">Pleroma</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/proxyprotocolerror.html" class="tsd-kind-icon">Proxy<wbr>Protocol<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/requestcancelederror.html" class="tsd-kind-icon">Request<wbr>Canceled<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/streamlistener.html" class="tsd-kind-icon">Stream<wbr>Listener</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/streamlistenererror.html" class="tsd-kind-icon">Stream<wbr>Listener<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/unexpectederror.html" class="tsd-kind-icon">Unexpected<wbr>Error</a>
|
|
</li>
|
|
<li class=" tsd-kind-class">
|
|
<a href="classes/websocket.html" class="tsd-kind-icon">Web<wbr>Socket</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/megalodoninterface.html" class="tsd-kind-icon">Megalodon<wbr>Interface</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/streamlistenerinterface.html" class="tsd-kind-icon">Stream<wbr>Listener<wbr>Interface</a>
|
|
</li>
|
|
<li class=" tsd-kind-interface">
|
|
<a href="interfaces/websocketinterface.html" class="tsd-kind-icon">Web<wbr>Socket<wbr>Interface</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#instance" class="tsd-kind-icon">Instance</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias">
|
|
<a href="globals.html#proxyconfig" class="tsd-kind-icon">Proxy<wbr>Config</a>
|
|
</li>
|
|
<li class=" tsd-kind-type-alias tsd-has-type-parameter">
|
|
<a href="globals.html#response" class="tsd-kind-icon">Response</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#default_scope" class="tsd-kind-icon">DEFAULT_<wbr>SCOPE</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#default_ua" class="tsd-kind-icon">DEFAULT_<wbr>UA</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#no_redirect" class="tsd-kind-icon">NO_<wbr>REDIRECT</a>
|
|
</li>
|
|
<li class=" tsd-kind-variable">
|
|
<a href="globals.html#status_codes_to_abort_on" class="tsd-kind-icon">STATUS_<wbr>CODES_<wbr>TO_<wbr>ABORT_<wbr>ON</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#detector" class="tsd-kind-icon">detector</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#generator" class="tsd-kind-icon">generator</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#iscancel" class="tsd-kind-icon">is<wbr>Cancel</a>
|
|
</li>
|
|
<li class=" tsd-kind-function">
|
|
<a href="globals.html#proxyagent" class="tsd-kind-icon">proxy<wbr>Agent</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<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-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>
|
|
</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>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<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-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<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> |