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

@saihtun/jsapi

v1.0.8

Published

A quick way to access the Javascript API with examples ๐Ÿš€

Downloads

7

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

saihtunsaihtun

Keywords

oclifnode.jstypescriptcheeriochalkapiexamplesjsapiprototypes

Readme

jsapi (Node.js Cli)

The fastest way to learn the Javascript APIs with examples.

oclif

Installation

$ npm install -g @saihtun/jsapi

Usage

$ npm install -g @saihtun/jsapi
$ jsapi COMMAND
running command...
$ jsapi (--version)
@saihtun/jsapi/1.0.8 darwin-arm64 node-v21.6.2
$ jsapi --help [COMMAND]
USAGE
  $ jsapi COMMAND
...

Jsapi Cli gif

Commands

jsapi help [COMMANDS]

Display help for jsapi.

USAGE
  $ jsapi help [COMMANDS...] [-n]

ARGUMENTS
  COMMANDS...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for jsapi.

See code: @oclif/plugin-help

jsapi plugins

List installed plugins.

USAGE
  $ jsapi plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ jsapi plugins

See code: @oclif/plugin-plugins

jsapi plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ jsapi plugins add plugins:install PLUGIN...

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ jsapi plugins add

EXAMPLES
  $ jsapi plugins:install myplugin 

  $ jsapi plugins:install https://github.com/someuser/someplugin

  $ jsapi plugins:install someuser/someplugin

jsapi plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ jsapi plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ jsapi plugins:inspect myplugin

See code: @oclif/plugin-plugins

jsapi plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ jsapi plugins install PLUGIN...

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ jsapi plugins add

EXAMPLES
  $ jsapi plugins:install myplugin 

  $ jsapi plugins:install https://github.com/someuser/someplugin

  $ jsapi plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

jsapi plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ jsapi plugins link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ jsapi plugins:link myplugin

See code: @oclif/plugin-plugins

jsapi plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ jsapi plugins remove plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ jsapi plugins unlink
  $ jsapi plugins remove

jsapi plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ jsapi plugins uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ jsapi plugins unlink
  $ jsapi plugins remove

See code: @oclif/plugin-plugins

jsapi plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ jsapi plugins unlink plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ jsapi plugins unlink
  $ jsapi plugins remove

jsapi plugins update

Update installed plugins.

USAGE
  $ jsapi plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

jsapi <command> [flags]

search JavaScript prototype methods quickly ๐Ÿš€

USAGE
  $ jsapi search <command> [flags]
  $ jsapi search <command> --help
  $ jsapi search <command> --version

FLAGS
  -n, --name=<value>  Specify Javascript method name
  -t, --type=<value>  Specify Javascript object type

DESCRIPTION
  search JavaScript prototype methods quickly ๐Ÿš€

EXAMPLES
  $ jsapi search -t array -n filter

  $ jsapi search -t string -n split

  $ jsapi search โคต  Prompting interactive shell

See code: src/commands/search/index.ts

Motivation:

  • reading the code examples to learn how the API works are way faster than browsing a bunch of texts.
  • For Javascript's beginners by a beginner.
  • This is my very first opensource project. Hence, I'm super excited to received some feedbacks and potential PR from you all! ๐Ÿ”ฅ

Features:

  • Interactive shell propmt will walk you through to find the respected API.

Inspiration:

  • You would see the blue and yellow colors within the code examples. Yeah you are right! that's the colors from Ukraine's flag. ๐Ÿ‡บ๐Ÿ‡ฆ โ˜ฎ๏ธ

Build with:

  • node.js, typescript, oclif, cheerio, enquirer, chalk