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

udes-node-orchestrator

v2.4.3

Published

Orchestrator server. Handles routes and HTTP traffic.

Downloads

12

Readme

UdeS Node Orchestrator

Greenkeeper badge CircleCI npm Node

Introduction

This node server acts as an API to simplify calls made to a server that has a complicated infrastructure.

Prerequisites

  • Node 6.10.1 (it is recommended to install it via NVM)
  • Ensure you have a development environment setup to use the orchestrator. Since it uses a socket you cannot run it on a local machine.

Getting started

Setup development machine

  1. git clone https://github.com/UdeS-STI/udes-node-orchestrator.git
  2. cd udes-node-orchestrator
  3. npm install

Usage

Scripts

  • Start app
    • npm start
  • Run eslint
    • npm run lint
  • Run unit tests
    • npm run test
  • Run code coverage
    • npm run coverage
  • Security check dependencies
    • npm run audit
  • Build library for distribution
    • npm run build
  • Generate documentation for public API
    • npm run documentation

API

import Orchestrator, { ResponseHelper } from 'udes-node-orchestrator'
import config from './config'

const getPostInfo = async (req, res) => {
  const responseHelper = new ResponseHelper(req, res, config)
  const { post } = responseHelper.getQueryParameters()
  const options = {
    method: 'GET',
    url: `${config.apiUrl}/posts/${post}`,
  }

  try {
    const data = await responseHelper.fetch(options)
    // Send response data back to user.
    responseHelper.handleResponse({ data })
  } catch (err) {
    // Send error back to user.
    responseHelper.handleError(err)
  }
}

// Instantiate an orchestrator with your server configuration.
const orchestrator = new Orchestrator(config)

// Set routes with an array of objects containing route info.
orchestrator.setRoutes([
  { method: 'GET', url: '/post*', fn: getPostInfo },
])

// Your server is now up and running, listening on set routes.

Logging

The logging system uses Pino. Log levels used are:

  • error to display only errors;
  • warn to display errors and warnings;
  • info to display all above and request information;
  • debug to display all above and response information;
  • trace to display all logs;
  • silent to disable logs;
  • NOTE: fatal is not used as it exits node process;

Documentation

JSDocs documentation

Example

A minimalist usage example is available in /boilerplate

Release

These steps consider that version bump has already been done.

git tag vX.X.X
git push origin --tags
npm run build
# Change `main` field in `package.json` from `src/index.js` to `dist/index.js`
npm publish
# Revert change to `main` field in `package.json`

Contributing

You must use the following guides:

This project contains a linting config, you should setup eslint into your editors with .eslintrc.js.