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

@hoobs/sdk

v5.0.2

Published

HOOBS SDK for building applications that talk with the HOOBS API.

Downloads

304

Readme

HOOBS JavaScript SDK for building applications that talk with the HOOBS API.

Installing

HOOBS recommends Yarn. From your project's root run;

yarn add @hoobs/sdk

Or using NPM.

npm install @hoobs/sdk

Usage

First you need to import the SDK

import SDK from "@hoobs/sdk";

Then create an bridge.

const hoobs = SDK();

Authorization Token

The HOOBS SDK manages authorization tokens for you. To do this you need to define the functions used to get and set the token. This is usefull, because it allows you to intergrate the authorization token into your projects state management.

hoobs.config.token.get(() => {
    // fetch and return the stored token
});

hoobs.config.token.set((token) => {
    // store token logic
});

Without this you will not be able to login to the HOOBS API.

Intergrating with Vue

The HOOBS SDK is designed to be used with Vue. To setup the mixin, modify your main.ts|js file. This example uses Vuex for managing the authorization token.

import Vue from "vue";
import Vuex from "vuex";
import SDK from "@hoobs/sdk";

import app from "./app.vue";

Vue.use(Vuex);

const store = new Vuex.Store({
    state: {
        session: "",
        user: {
            permissions: {},
        },
    },

    mutations: {
        "SESSION:SET": (state: { [key: string]: any }, token: string) => {
            state.session = token;

            if (token && token !== "") {
                const user = JSON.parse(atob(token));

                state.user = {
                    id: user.id,
                    name: user.name,
                    username: user.username,
                    permissions: user.permissions || {},
                };
            } else {
                state.user = {
                    permissions: {},
                };
            }
        }
    }
};

const hoobs = SDK();

hoobs.config.token.get(() => store.state.session);
hoobs.config.token.set((token) => { store.commit("SESSION:SET", token); });

Vue.mixin(hoobs.mixin());

new Vue({
    store,
    render: (h) => h(app),
}).$mount("#app");

Now you will be able to access the SDK via this.$hoobs in your components.

<script>
    export default {
        data() {
            return {
                version: "",
            }
        },

        async mounted() {
            this.version = await this.$hoobs.version();
        }
    }
</script>

Documentation

SDK documentation can be found here.
SDK Documentation

Legal

HOOBS and the HOOBS logo are registered trademarks of HOOBS Inc. Copyright (C) 2020 HOOBS Inc. All rights reserved.