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

rivership-functions

v1.0.3

Published

A library of helpful functions to be used for the uShip Riverside (rivership) office

Downloads

3

Readme

rivership-functions

A library of helpful functions to be used for the uShip Riverside (rivership) office. Offers general information, such as:

  • Where is each conference room located?
  • Where does a team sit?
  • Where does an individual sit (or on what team)?
  • What's for lunch?

Installation

To install the rivership-functions in a node project:

npm install rivership-function

Configuration

You will need to set the following environment variables to use this library:

  • AIRTABLE_KEY - The API Key you use to access the Airtable api, which should have access to the below tables
  • AIRTABLE_CONFERENCEROOMS_ID - The table id representing the table collection holding conference rooms
  • AIRTABLE_LUNCH_ID - The table id representing the table collection holding the weekly lunch menu
  • AIRTABLE_PEOPLE_ID - The table id representing the table collection holding people and their respective teams

Example usage

To use the library, you can

Ask where a conference room resides

const rivership = request('rivership-functions');
rivership.whereIs('Lone Star'); // Returns a promise with the location of 'Lone Star' if it exists

Ask where a team resides

const rivership = request('rivership-functions');
rivership.whereIs('Starship'); // Returns a promise with the location of 'Starship' if the team exists

Ask where an individual room resides

const rivership = request('rivership-functions');
rivership.whereIs('Stephen Guerra'); // Returns a promise with the location of Stephen (he should exist)

Ask what is for lunch today

const rivership = request('rivership-functions');
rivership.whatIsLunch(); // Returns a promise with today's lunch menu

Ask what is for lunch today

const rivership = request('rivership-functions');
rivership.whatIsLunch('Tuesday'); // Returns a promise with a given day's lunch menu (hopefully not fish)

Troubleshooting

Configuring usage in stdlib

If you are using stdlib, you will need to set these variables in your env.json file before deploying, e.g.

{
    "local": {
        "AIRTABLE_KEY": "***",
        "AIRTABLE_CONFERENCEROOMS_ID": "***",
        "AIRTABLE_LUNCH_ID": "***",
        "AIRTABLE_PEOPLE_ID": "***"
    },
    "dev": {
        "AIRTABLE_KEY": "***",
        "AIRTABLE_CONFERENCEROOMS_ID": "***",
        "AIRTABLE_LUNCH_ID": "***",
        "AIRTABLE_PEOPLE_ID": "***"
    },
    "release": {
        "AIRTABLE_KEY": "***",
        "AIRTABLE_CONFERENCEROOMS_ID": "***",
        "AIRTABLE_LUNCH_ID": "***",
        "AIRTABLE_PEOPLE_ID": "***"
    }
}

Configuring usage in Visual Studio Code

If you are using visual studio code, it is recommended you set these variables in the .vscode/launch.json file, e.g.

{
    "version": "0.2.0",
    "configurations": [{
        "name": "Run mocha",
        "type": "node",
        "request": "launch",
        "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
        "stopOnEntry": false,
        "args": ["test/**/*.js", "--no-timeouts"],
        "cwd": "${workspaceRoot}",
        "runtimeExecutable": null,
        "env": {
            "NODE_ENV": "test",
            "AIRTABLE_KEY": "***",
            "AIRTABLE_CONFERENCEROOMS_ID": "***",
            "AIRTABLE_LUNCH_ID": "***",
            "AIRTABLE_PEOPLE_ID": "***"
        }
    }]
}