156 lines
34 KiB
HTML
156 lines
34 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>megalodon</title><meta name="description" content="Documentation for megalodon"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
|
<div class="tsd-toolbar-contents container">
|
|
<div class="table-cell" id="tsd-search" data-base=".">
|
|
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
|
<div class="field">
|
|
<div id="tsd-toolbar-links"></div></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"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
<div class="container container-main">
|
|
<div class="col-8 col-content">
|
|
<div class="tsd-page-title">
|
|
<h2>megalodon</h2></div>
|
|
<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://github.com/h3poteto/megalodon/actions?query=branch%3Amaster+workflow%3ATest"><img src="https://github.com/h3poteto/megalodon/workflows/Test/badge.svg" alt="Test"></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>
|
|
<p>The Rust version is <a href="https://github.com/h3poteto/megalodon-rs">megalodon-rs</a>.</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><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-0">install</span><span class="hl-1"> -</span><span class="hl-2">S</span><span class="hl-1"> </span><span class="hl-0">megalodon</span>
|
|
</code></pre>
|
|
<p>or</p>
|
|
<pre><code><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-0">yarn</span><span class="hl-1"> </span><span class="hl-0">add</span><span class="hl-1"> </span><span class="hl-0">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 some libraries which are not supported in Node.js.
|
|
<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="hl-3">import</span><span class="hl-1"> </span><span class="hl-0">generator</span><span class="hl-1">, { </span><span class="hl-0">Entity</span><span class="hl-1">, </span><span class="hl-0">Response</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-4">'megalodon'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">BASE_URL</span><span class="hl-1">: </span><span class="hl-6">string</span><span class="hl-1"> = </span><span class="hl-4">'https://mastodon.social'</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">access_token</span><span class="hl-1">: </span><span class="hl-6">string</span><span class="hl-1"> = </span><span class="hl-4">'...'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1"> = </span><span class="hl-7">generator</span><span class="hl-1">(</span><span class="hl-4">'mastodon'</span><span class="hl-1">, </span><span class="hl-2">BASE_URL</span><span class="hl-1">, </span><span class="hl-0">access_token</span><span class="hl-1">)</span><br/><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-7">getHomeTimeline</span><span class="hl-1">()</span><br/><span class="hl-1"> .</span><span class="hl-7">then</span><span class="hl-1">((</span><span class="hl-0">res</span><span class="hl-1">: </span><span class="hl-6">Response</span><span class="hl-1"><</span><span class="hl-6">Array</span><span class="hl-1"><</span><span class="hl-6">Entity</span><span class="hl-1">.</span><span class="hl-6">Status</span><span class="hl-1">>>) </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">res</span><span class="hl-1">.</span><span class="hl-0">data</span><span class="hl-1">)</span><br/><span class="hl-1"> })</span>
|
|
</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="hl-3">import</span><span class="hl-1"> </span><span class="hl-0">generator</span><span class="hl-1">, { </span><span class="hl-0">Entity</span><span class="hl-1">, </span><span class="hl-0">Response</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-4">'megalodon'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">BASE_URL</span><span class="hl-1">: </span><span class="hl-6">string</span><span class="hl-1"> = </span><span class="hl-4">'https://mastodon.social'</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">access_token</span><span class="hl-1">: </span><span class="hl-6">string</span><span class="hl-1"> = </span><span class="hl-4">'...'</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">toot</span><span class="hl-1">: </span><span class="hl-6">string</span><span class="hl-1"> = </span><span class="hl-4">'test toot'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1"> = </span><span class="hl-7">generator</span><span class="hl-1">(</span><span class="hl-4">'mastodon'</span><span class="hl-1">, </span><span class="hl-2">BASE_URL</span><span class="hl-1">, </span><span class="hl-0">access_token</span><span class="hl-1">)</span><br/><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-7">postStatus</span><span class="hl-1">(</span><span class="hl-0">toot</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-7">then</span><span class="hl-1">((</span><span class="hl-0">res</span><span class="hl-1">: </span><span class="hl-6">Response</span><span class="hl-1"><</span><span class="hl-6">Entity</span><span class="hl-1">.</span><span class="hl-6">Status</span><span class="hl-1">>) </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">res</span><span class="hl-1">.</span><span class="hl-0">data</span><span class="hl-1">)</span><br/><span class="hl-1"> })</span>
|
|
</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="hl-3">import</span><span class="hl-1"> </span><span class="hl-0">generator</span><span class="hl-1">, { </span><span class="hl-0">Entity</span><span class="hl-1">, </span><span class="hl-0">Response</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-4">'megalodon'</span><br/><span class="hl-3">import</span><span class="hl-1"> </span><span class="hl-0">fs</span><span class="hl-1"> </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-4">'fs'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">BASE_URL</span><span class="hl-1">: </span><span class="hl-6">string</span><span class="hl-1"> = </span><span class="hl-4">'https://mastodon.social'</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">access_token</span><span class="hl-1">: </span><span class="hl-6">string</span><span class="hl-1"> = </span><span class="hl-4">'...'</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">image</span><span class="hl-1"> = </span><span class="hl-0">fs</span><span class="hl-1">.</span><span class="hl-7">readFileSync</span><span class="hl-1">(</span><span class="hl-4">"test.image"</span><span class="hl-1">)</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1"> = </span><span class="hl-7">generator</span><span class="hl-1">(</span><span class="hl-4">'mastodon'</span><span class="hl-1">, </span><span class="hl-2">BASE_URL</span><span class="hl-1">, </span><span class="hl-0">access_token</span><span class="hl-1">)</span><br/><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-7">uploadMedia</span><span class="hl-1">(</span><span class="hl-0">image</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-7">then</span><span class="hl-1">((</span><span class="hl-0">res</span><span class="hl-1">: </span><span class="hl-6">Response</span><span class="hl-1"><</span><span class="hl-6">Entity</span><span class="hl-1">.</span><span class="hl-6">Attachment</span><span class="hl-1">>) </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">res</span><span class="hl-1">.</span><span class="hl-0">data</span><span class="hl-1">)</span><br/><span class="hl-1"> })</span>
|
|
</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="hl-3">import</span><span class="hl-1"> </span><span class="hl-0">generator</span><span class="hl-1">, { </span><span class="hl-0">Entity</span><span class="hl-1">, </span><span class="hl-0">WebSocketInterface</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-4">'megalodon'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">BASE_URL</span><span class="hl-1">: </span><span class="hl-6">string</span><span class="hl-1"> = </span><span class="hl-4">'wss://pleroma.io'</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">access_token</span><span class="hl-1">: </span><span class="hl-6">string</span><span class="hl-1"> = </span><span class="hl-4">'...'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1"> = </span><span class="hl-7">generator</span><span class="hl-1">(</span><span class="hl-4">'pleroma'</span><span class="hl-1">, </span><span class="hl-2">BASE_URL</span><span class="hl-1">, </span><span class="hl-0">access_token</span><span class="hl-1">)</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">stream</span><span class="hl-1">: </span><span class="hl-6">WebSocketInterface</span><span class="hl-1"> = </span><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-7">userSocket</span><span class="hl-1">()</span><br/><br/><span class="hl-0">stream</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-4">'connect'</span><span class="hl-1">, () </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-4">'connect'</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-0">stream</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-4">'update'</span><span class="hl-1">, (</span><span class="hl-0">status</span><span class="hl-1">: </span><span class="hl-6">Entity</span><span class="hl-1">.</span><span class="hl-6">Status</span><span class="hl-1">) </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">status</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-0">stream</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-4">'notification'</span><span class="hl-1">, (</span><span class="hl-0">notification</span><span class="hl-1">: </span><span class="hl-6">Entity</span><span class="hl-1">.</span><span class="hl-6">Notification</span><span class="hl-1">) </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">notification</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-0">stream</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-4">'delete'</span><span class="hl-1">, (</span><span class="hl-0">id</span><span class="hl-1">: </span><span class="hl-6">number</span><span class="hl-1">) </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">id</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-0">stream</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-4">'error'</span><span class="hl-1">, (</span><span class="hl-0">err</span><span class="hl-1">: </span><span class="hl-6">Error</span><span class="hl-1">) </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">error</span><span class="hl-1">(</span><span class="hl-0">err</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-0">stream</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-4">'heartbeat'</span><span class="hl-1">, () </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-4">'thump.'</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-0">stream</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-4">'close'</span><span class="hl-1">, () </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-4">'close'</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><br/><span class="hl-0">stream</span><span class="hl-1">.</span><span class="hl-7">on</span><span class="hl-1">(</span><span class="hl-4">'parser-error'</span><span class="hl-1">, (</span><span class="hl-0">err</span><span class="hl-1">: </span><span class="hl-6">Error</span><span class="hl-1">) </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">error</span><span class="hl-1">(</span><span class="hl-0">err</span><span class="hl-1">)</span><br/><span class="hl-1">})</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="hl-3">import</span><span class="hl-1"> </span><span class="hl-0">generator</span><span class="hl-1">, { </span><span class="hl-0">OAuth</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-4">'megalodon'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">BASE_URL</span><span class="hl-1">: </span><span class="hl-6">string</span><span class="hl-1"> = </span><span class="hl-4">'https://mastodon.social'</span><br/><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">clientId</span><span class="hl-1">: </span><span class="hl-6">string</span><br/><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-0">clientSecret</span><span class="hl-1">: </span><span class="hl-6">string</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1"> = </span><span class="hl-7">generator</span><span class="hl-1">(</span><span class="hl-4">'mastodon'</span><span class="hl-1">, </span><span class="hl-2">BASE_URL</span><span class="hl-1">)</span><br/><br/><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-7">registerApp</span><span class="hl-1">(</span><span class="hl-4">'Test App'</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-7">then</span><span class="hl-1">(</span><span class="hl-0">appData</span><span class="hl-1"> </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">clientId</span><span class="hl-1"> = </span><span class="hl-0">appData</span><span class="hl-1">.</span><span class="hl-0">clientId</span><br/><span class="hl-1"> </span><span class="hl-0">clientSecret</span><span class="hl-1"> = </span><span class="hl-0">appData</span><span class="hl-1">.</span><span class="hl-0">clientSecret</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-4">'Authorization URL is generated.'</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">appData</span><span class="hl-1">.</span><span class="hl-0">url</span><span class="hl-1">)</span><br/><span class="hl-1"> })</span>
|
|
</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="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">code</span><span class="hl-1"> = </span><span class="hl-4">'...'</span><span class="hl-1"> </span><span class="hl-8">// Authorization code</span><br/><br/><span class="hl-0">client</span><span class="hl-1">.</span><span class="hl-7">fetchAccessToken</span><span class="hl-1">(</span><span class="hl-0">clientId</span><span class="hl-1">, </span><span class="hl-0">clientSecret</span><span class="hl-1">, </span><span class="hl-0">code</span><span class="hl-1">)</span><br/><span class="hl-1">})</span><br/><span class="hl-1"> .</span><span class="hl-7">then</span><span class="hl-1">((</span><span class="hl-0">tokenData</span><span class="hl-1">: </span><span class="hl-6">OAuth</span><span class="hl-1">.</span><span class="hl-6">TokenData</span><span class="hl-1">) </span><span class="hl-5">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">tokenData</span><span class="hl-1">.</span><span class="hl-0">accessToken</span><span class="hl-1">)</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">tokenData</span><span class="hl-1">.</span><span class="hl-0">refreshToken</span><span class="hl-1">)</span><br/><span class="hl-1"> })</span><br/><span class="hl-1"> .</span><span class="hl-7">catch</span><span class="hl-1">((</span><span class="hl-0">err</span><span class="hl-1">: </span><span class="hl-6">Error</span><span class="hl-1">) </span><span class="hl-5">=></span><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">error</span><span class="hl-1">(</span><span class="hl-0">err</span><span class="hl-1">))</span>
|
|
</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="hl-3">import</span><span class="hl-1"> { </span><span class="hl-0">detector</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-4">'megalodon'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">URL</span><span class="hl-1"> = </span><span class="hl-4">'https://misskey.io'</span><br/><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-2">sns</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-7">detector</span><span class="hl-1">(</span><span class="hl-2">URL</span><span class="hl-1">)</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-0">sns</span><span class="hl-1">)</span>
|
|
</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">
|
|
<div class="tsd-navigation settings">
|
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<div class="tsd-filter-visibility">
|
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
<ul id="tsd-filter-options">
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
|
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
|
<div class="tsd-theme-toggle">
|
|
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
<nav class="tsd-navigation primary">
|
|
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<ul>
|
|
<li class="current selected"><a href="modules.html">megalodon</a>
|
|
<ul>
|
|
<li class="tsd-kind-namespace"><a href="modules/Entity.html">Entity</a></li>
|
|
<li class="tsd-kind-namespace"><a href="modules/FilterContext.html">Filter<wbr/>Context</a></li>
|
|
<li class="tsd-kind-namespace"><a href="modules/NotificationType.html">Notification<wbr/>Type</a></li>
|
|
<li class="tsd-kind-namespace"><a href="modules/OAuth.html">OAuth</a></li></ul></li></ul></div></details></nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul>
|
|
<li class="tsd-kind-class"><a href="classes/Mastodon.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg>Mastodon</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/Misskey.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Misskey</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/Pleroma.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Pleroma</a></li>
|
|
<li class="tsd-kind-class"><a href="classes/RequestCanceledError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Request<wbr/>Canceled<wbr/>Error</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/MegalodonInterface.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>Megalodon<wbr/>Interface</a></li>
|
|
<li class="tsd-kind-interface"><a href="interfaces/WebSocketInterface.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Web<wbr/>Socket<wbr/>Interface</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="types/ProxyConfig.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>Proxy<wbr/>Config</a></li>
|
|
<li class="tsd-kind-type-alias"><a href="types/Response.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Response</a></li>
|
|
<li class="tsd-kind-function"><a href="functions/default.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>default</a></li>
|
|
<li class="tsd-kind-function"><a href="functions/detector.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>detector</a></li>
|
|
<li class="tsd-kind-function"><a href="functions/isCancel.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>is<wbr/>Cancel</a></li></ul></nav></div></div>
|
|
<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/main.js"></script></body></html> |