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 🙏

© 2024 – Pkg Stats / Ryan Hefner

@discolytics/core

v2.0.0

Published

The JavaScript core package is where all other JS packages are built off of. If you have a custom implementation that doesn't fit in the other libraries, use the core package.

Downloads

5

Readme

The JavaScript core package is where all other JS packages are built off of. If you have a custom implementation that doesn't fit in the other libraries, use the core package.

1. Installation

npm install @discolytics/core

2. Get API Key

Under the API Keys tab of your dashboard, create a new API key. Copy this key and your bot ID to connect within your codebase.

3. Example Usage

Initiate the client library in your codebase. Enter your bot ID and API key from the previous step to connect, as well as your bot token under the token option. The example code below showcases how to connect and the methods you need to implement.

Your bot token is never sent to Discolytics servers. It is used by our client libraries on your machine to make requests to Discord on your behalf for metadata and analytics (such as to request your bot profile, guild count, etc).

require('dotenv').config();
const { Discolytics } = require('@discolytics/core');

const discolytics = new Discolytics({
	botId: 'YOUR_BOT_ID', // your bot ID from the Discolytics dashboard, not your bot user
	auth: `Bot ${process.env.TOKEN}`,
	apiKey: process.env.DISCOLYTICS_KEY,
});

// use discolytics.sendEvent() to send an event. Pass the event name and guild id (optional)
discolytics.sendEvent('MESSAGE_CREATE', 'GUILD_ID');

// use discolytics.postInteraction() to post an interaction. Pass the interaction type and guild id (optional)
discolytics.postInteraction(1, 'GUILD_ID');

// use discolytics.postShards() to send a heartbeat and send an array of shards. If you are clustering your bot, you can also use discolytics.postCluster() which accepts the same arguments.
// valid shard statuses include: 'ready' | 'connecting' | 'reconnecting' | 'resuming' | 'disconnected'
discolytics.postShards([{ id: 0, status: 'ready', latency: 20 }]);

// start a new command with discolytics.startCommand()
const command = discolytics.startCommand({
	name: 'help',
	userId: '123',
	guildId: '123', // optional
});

setTimeout(() => {
	// run the .end() method on the command to end it, posts the command with the calculated duration
	command.end();
}, 5000);

Support

Join our Discord server for help and support.

  • https://discord.gg/aDPeJDcumz