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

glitch-api

v3.1.0

Published

Library for using Glitch API ⚙️

Downloads

9

Readme

glitch-api

GitHub package.json dynamic CircleCI npm bundle size

A Node.js module that allows you to easily interact with the Glitch API

| 📖 Documentation | ✨ Examples | | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |

Features

  • 99% coverage of the known Glitch API
  • Uses TypeScript that provides hints in editor, type checking, etc.
  • Supports WebSocket connection to the Glitch editor
  • Support for authorization
  • Only two dependencies: node-fetch and algoliasearch
  • Class abstraction
  • Works with both API versions
Warning: this module uses unstable API that hasn't been officially released yet. Described only world-open methods from this unofficial site and my researches

Installation

Node.js 8.0.0 or newer is required

NPM
npm i glitch-api -s

Example usage

// Require using ES6 syntax
import { Glitch } from 'glitch-api'

// Or using old fancy style
const { Glitch } = require('glitch-api')

// Init main class
const glitch = new Glitch({ token: 'xxx' })  // Put here your Glitch token or use glitch.setAnonToken()
const { api } = glitch

// Get a user profile
api.users.get({ id: 1 }).then(user => console.log) // → User

❗ Migration from 2.x to 3.x

  • Any search method now follows the same syntax:
    .search(s: string) → Algolia result
  • Remixing a project doesn't return joinLink. Now it is a Project instance. Consider getting project data with token via api.projects.get()
  • Token is absolutely required. If you don't have a token, consider using Glitch.setAnonToken(). For more info, see examples/anonymous.js

Q&A

How do I get Glitch token?

Paste the following code to the browser's console on the Glitch editor page:

(JSON.parse(localStorage.getItem('cachedUser'))).persistentToken

Also you can use Glitch.setAnonToken() → Promise<string> method to login as an anonymous user and use its token.


Why *api-method* is not implemented?

Because I'm also human and I might not have seen the recent changes in Glitch's API. Anyway, PRs are open for anyone :)


The *api-method* is not working.

It could be that Glitch devs removed the support for that method. Or it's just a my fault. Open a new issue and describe what's happend.

Contribution

Feel free to open new Pull request or an issue!

Credits

Made by jarvis394 with ♥️