Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@api-components/api-console-github-resolver
Advanced tools
Changelog
Readme
A npm module to get information about Mulesoft's API console release.
This module is mainly used in the @api-components/api-console-builder.
Shorthand functions:
latestInfo(logger)
-> new GithubResolver#getLatestInfo()
tagInfo(tag, logger)
-> new GithubResolver#getTagInfo(tag)
releasesInfo(logger)
-> new GithubResolver#getReleasesList()
The module exposes 4 classes:
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);
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.
<Promise>
A promise resolved to a JavaScript Object
if compatible content type is detected or to Buffer
otherwise.
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);
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.
<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.
<Promise>
Promise resolves to an array of releases information.
getTagInfo(tag)
Gets information about tagged release.
tag String
- Release tag name
<Promise>
Promise resolved to an Object
with release information.
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.
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.
// 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
FAQs
Gets information about Mulesoft's API console releases.
The npm package @api-components/api-console-github-resolver receives a total of 15 weekly downloads. As such, @api-components/api-console-github-resolver popularity was classified as not popular.
We found that @api-components/api-console-github-resolver demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.