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

@tfadev/discord.js-docs

v2.1.1

Published

A simple & powerful parser and wrapper for discord.js docs.

Downloads

1

Readme

A simple & powerful parser and wrapper for discord.js documentation website. This package uses axios as the main HTTP requests handler.

Installation

npm install @tfadev/discord.js-docs axios

Usage

Create a new parser using the class Docs. The parameter is based discord.js docs URL, by default it's "discord.js.org".

import { Docs as DiscordJSDocs } from '@tfadev/discord.js-docs';

const parser = new DiscordJSDocs();

Fetch from a source:

Get everything from a discord.js docs source using the method fetch().

await parser.fetch('main');

Search from a source by query:

The method to do this job is search().

The options of this method:

  • rate (number - 0.8): The rate of similarity of the keyword and the query, must be in this following condition: 0 < rate ≤ 1
  • include (KeywordTypes[] - undefined): Include single or multiple specific types, like classex, typedefs... etc
  • sort (boolean - false): Sort the response by points of each keyword or not?
  • strict (boolean - false): Enable strict mode; The keyword and the query must be exactly similar (not similar to rate: 1).
await parser.search('main', 'Client');

await parser.search('builders', 'SlashCommand', {
    rate: 0.5
    include: [
        'classes',
        'typedefs',
        ...
    ],
    sort: false,
    strict: true
});

Get a keyword's data:

To get a keyword's data (such as class properties, functions... etc), use get() method. If the keyword is not found, it will return null.

await parser.get('main', 'Client');

Format searched data:

Format the keywords using the method search(), it will return an objects array with some symbols.

The options of this method:

  • symbols (object - {}): Set the symbols of each keyword's type.
  • sort (boolean - false): Sort the response by points of each keyword or not?
  • pretty: (boolean - false): Make the JSDoc comments pretty; removes brackets ({ and }) and any prefixes starts with @ (@link, @see... etc).
import { DocsUtils } from '@tfadev/discord.js-docs';

DocsUtils.format([...]);

DocsUtils.format([...], {
    symbols: {
        classes: 'C',
        functions: 'F',
        ...
    },
    sort: true,
    pretty: true
});

Example

Here is a simple example using the search and format method.

import { Docs as DiscordJSDocs, DocsUtils } from '@tfadev/discord.js-docs';

const parser = new DiscordJSDocs();

(async () => {
    const searched = await parser.search('main', 'Channel', { rate: 0.7 });

    const formatted = DocsUtils.format(searched, {
        symbols: {
            classes: 'C',
            typedefs: 'T',
            interfaces: 'I',
            externals: 'E',
            functions: 'F'
        },
        sort: true,
        pretty: true
    }); 

    const result = formatted.map((v) => `[${v.symbol}] ${v.name}`);

    console.log(result);
})();

Expected output in terminal:

[
  '[C] DMChannel',
  '[E] APIChannel',
  '[C] BaseChannel',
  '[C] NewsChannel',
  '[C] TextChannel',
  '[F] channelLink',
  '[E] ChannelType',
  '[C] ForumChannel',
  '[C] GuildChannel',
  '[C] MediaChannel',
  '[C] StageChannel',
  '[C] VoiceChannel',
  '[E] ChannelFlags'
]

Known bugs

  • The url property (defined in the type DiscordJSDocsFormatOutput) has a chance to return an invalid URL, from the both base URLs.

License

GNU General Public License v3 (View here)