npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2021 – Pkg Stats / Ryan Hefner

slack-sdk

v3.1.3

Published

Basic Slack Api SDK

Downloads

2,815

Readme

Slack SDK

Build Status Test Coverage Dependabot Status Dependencies NPM Downloads Semantic-Release Gardener

Basic Slack Api SDK using User Session Token

Install

npm i --save slack-sdk

Usage

const slack = require('slack-sdk')('workspace-name', 'user-session-token', {/* options */});

slack.channel.message('channel-name', 'message');

Options

cacheTtl

Cache duration in seconds. Optional, defaults to 60.

cacheMaxEntries

Maximum number of entries in cache at any given time. Optional, defaults to 100.

Obtaining User Session Token

  1. Go to https://YOURWORKSPACE.slack.com/home in Chrome
  2. Right click → Inspect
  3. Select the network tab
  4. Reload the page
  5. Type in api in the search
  6. Click rtm.start and then headers
  7. Scroll down until you find the token. It starts with xoxs-
  8. Copy it!

Functions

self.message(message: string)

Send message to self.

self.shareFiles(files: array)

Share files to self.

channel.meta(channel: string)

Get meta information about channel channel

channel.message(channel: string, message: string)

Send message to channel channel.

channel.setTopic(channel: string, topic: string)

Set topic of channel channel

channel.setPurpose(channel: string, purpose: string)

Set purpose of channel channel

channel.shareFiles(channel: string, files: array)

Share files to a channel channel.

workspace.details(cache: boolean = true)

Obtain details for workspace. Should usually be cached as it is easy to run into rate limits.

files.upload(filepath: string, title: string = null, filename: string = null)

Upload file. Title and filename default to basename of filepath. Returns file id.

Internal functions

call(endpoint: string, params: object, cache: boolean = false)

Send request to slack endpoint endpoint with parameters params.

E.g. call("rtm.start", {}, true) to obtain information about current user. Use cache if information was already obtained before.

Cache

Cache operates by matching the exact outgoing request signature.

Cached and non-cached requests operate separately. So making a non cached request does never alter the cache.