typed-slack
Version:
Type-safe slack client for TypeScript.
204 lines (203 loc) • 11.1 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>typed-slack</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">typed-slack</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>
</ul>
<h1> typed-slack</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<p align="center">
<img src="https://raw.githubusercontent.com/starhoshi/typed-slack/master/assets/logo.png" width='200px' />
</p>
<h1 id="typed-slack-npm-version-build-status-codacy-badge-license-mit">typed-slack <a href="https://badge.fury.io/js/typed-slack"><img src="https://badge.fury.io/js/typed-slack.svg" alt="npm version"></a> <a href="https://travis-ci.org/starhoshi/typed-slack"><img src="https://travis-ci.org/starhoshi/typed-slack.svg?branch=master" alt="Build Status"></a> <a href="https://www.codacy.com/app/kensuke1751/typed-slack?utm_source=github.com&utm_medium=referral&utm_content=starhoshi/typed-slack&utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/c7a8f750afbd40019c5c4f859dd64d19" alt="Codacy Badge"></a> <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License: MIT"></a></h1>
<p>Typed-slack is a type-safe slack client for TypeScript.</p>
<p><a href="https://github.com/slackapi/node-slack-sdk">slackapi/node-slack-sdk</a> is great slack client. However, it does not contain d.ts files. Typed-slack has type definitions, so you can handle slack-api easily and type-safely.</p>
<p>Code completion is enabled when using VSCode.</p>
<p><img src="https://raw.githubusercontent.com/starhoshi/typed-slack/master/assets/vscode.gif" alt="vscode\.gif \(898×298\)"></p>
<h2 id="todo">TODO</h2>
<ul>
<li>[x] Incoming Webhook</li>
<li>[ ] Web API</li>
<li>[ ] RTM API</li>
<li>[ ] Events API</li>
<li>[ ] Interactive Messages</li>
</ul>
<h2 id="install">Install</h2>
<pre><code>npm <span class="hljs-keyword">install</span> typed-slack
</code></pre><h2 id="usage">Usage</h2>
<h3 id="webhook">Webhook</h3>
<pre><code class="lang-ts"><span class="hljs-keyword">import</span> * <span class="hljs-keyword">as</span> Slack <span class="hljs-keyword">from</span> <span class="hljs-string">'typed-slack'</span>
<span class="hljs-keyword">let</span> slack = <span class="hljs-keyword">new</span> Slack.IncomingWebhook(<span class="hljs-string">'https://hooks.slack.com/services/.......'</span>)
slack.send({ text: <span class="hljs-string">'text'</span> }).then(<span class="hljs-function"><span class="hljs-params">e</span> =></span> {
<span class="hljs-built_in">console</span>.log(<span class="hljs-string">'success'</span>)
}).catch(<span class="hljs-function"><span class="hljs-params">e</span> =></span> {
<span class="hljs-built_in">console</span>.error(e)
})
</code></pre>
<h4 id="options">Options</h4>
<p>More optional parameters are <a href="https://github.com/starhoshi/typed-slack/blob/master/out/typed-slack.d.ts">here#typed-slack.d.ts</a></p>
<pre><code class="lang-ts"><span class="hljs-keyword">const</span> options = <Slack.IncomingWebhookOptions>{
text: <span class="hljs-string">'@star__hoshi Hi!'</span>,
channel: <span class="hljs-string">'debug'</span>,
icon_emoji: <span class="hljs-string">':smile:'</span>,
link_names: <span class="hljs-number">1</span>,
attachments: [
{
color: Slack.Color.Danger,
fields: [
{
title: <span class="hljs-string">'Priority'</span>,
value: <span class="hljs-string">'High'</span>,
short: <span class="hljs-literal">false</span>
}
],
image_url: <span class="hljs-string">'http://my-website.com/path/to/image.jpg'</span>,
ts: <span class="hljs-number">123456789</span>
}
]
}
<span class="hljs-keyword">await</span> slack.send(options)
</code></pre>
</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-external-module">
<a href="modules/_typed_slack_.html">"typed-<wbr>slack"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</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-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="container tsd-generator">
<p>Generated using <a href="http://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>