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

sinusbot-scripting-engine

v1.0.18

Published

SinusBot JavaScript based Scripting Engine documentation with examples.

Downloads

76

Readme

Scripting engine documentation

Build Status

This repository contains the JSDoc based javascript file from which the scripting engine documentation is generated.

Introduction

Check out our guide in the SinusBot Documentation for explanations on how to get started.

IntelliSense

There are TypeScript typings available which are generated out of the documentation. You can use them in IDEs like Visual Studio Code.

Visual Studio Code

Visual Studio Code IntelliSense demo

First of all you need to install the typings by executing: npm i sinusbot-scripting-engine or yarn add sinusbot-scripting-engine.

After you have the typings installed, you need to create a jsconfig.json in the folder where you develop your scripts with the following content:

{
    "compilerOptions": {
        "checkJs": true,
        "target": "es2018",
        "types" : ["sinusbot-scripting-engine"]
    },
    "typeAcquisition": {"enable": false, "include": ["sinusbot-scripting-engine"]},
    "exclude": [
        "node_modules",
        "**/node_modules/*"
    ]
}

For reference, you can check out this repository.

Build

Install dependencies

npm install

Generate html files

npm run generate-docs

Serve locally

npm run serve-docs

Generate d.ts

npm run generate-ts