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

@api-components/api-console-github-resolver

v2.0.0

Published

Gets information about Mulesoft's API console releases.

Downloads

78

Readme

api-console-github-resolver

Build Status

A npm module to get information about Mulesoft's API console release.

This module is mainly used in the @api-components/api-console-builder.

API

Shorthand functions:

  • latestInfo(logger) -> new GithubResolver#getLatestInfo()
  • tagInfo(tag, logger) -> new GithubResolver#getTagInfo(tag)
  • releasesInfo(logger) -> new GithubResolver#getReleasesList()

The module exposes 4 classes:

Example

import { latestInfo } from '@api-components/api-console-github-resolver';

const winstonLogger = new winston.createLogger({...});
const info = await latestInfo(winstonLogger);
console.log(info);

equivalent to

import { GithubResolver }  from '@api-components/api-console-github-resolver';

const resolver = new GithubResolver({
  logger: winstonLogger
});
const info = await resolver.getLatestInfo();
console.log(info);

Transport

GitHub transport class. The transport is based on the HTTPS protocol.

get(resource, headers)

Gets a resource from given location. This function fallows redirects.

resource String - URL to the resource.

headers Object - A list of headers to send.

Returns <Promise>

A promise resolved to a JavaScript Object if compatible content type is detected or to Buffer otherwise.

Example

import { Transport } from '@api-components/api-console-github-resolver';

const winstonLogger = new winston.createLogger({...});
const transport = new Transport(winstonLogger);
const response = await transport.get('https://...', {'etag': 'abc'});
console.log(response);

GithubResolver

A class to resolve GitHub repositories versions. It allows to get latest release version and the url to the release's zip file or list available versions.

getLatestInfo()

Gets information about latest release.

Returns <Promise>

Promise resolved to a JavaScript object with the response from GitHub.

getReleasesList()

Gets information about releases. GitHub allows 30 items per page by default and this is exactly how much you will get when calling this function.

Returns <Promise>

Promise resolves to an array of releases information.

getTagInfo(tag)

Gets information about tagged release.

tag String - Release tag name

Returns <Promise>

Promise resolved to an Object with release information.

GitHub rate limit

GitHub allows to make up to 60 requests per hour. To increate the limit you can use GitHub personal token as an option passed to the ApiConsoleGithubResolver class constructor.

Example

import { GithubResolver } from '@api-components/api-console-github-resolver';

const TOKEN = 'ABC';
const resolver = new GithubResolver({
  token: TOKEN
});
const info = await resolver.getLatestInfo();
console.log(info);

Module's shorthand functions reads GITHUB_TOKEN environmental variable and sets it as a configuration option by default.

Example

// index.js
import { latestInfo } from '@api-components/api-console-github-resolver';

const info = await latestInfo();
console.log(info);
$ export GITHUB_TOKEN="ABC"
$ node index.js