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

featurehub-solid-sdk

v1.2.0

Published

The Solid SDK for FeatureHub

Downloads

9

Readme

FeatureHub Solid SDK

Build featurehub-solid-sdk npm version

Installation

Both featurehub-javascript-client-sdk and solid-js are peer dependencies of featurehub-solid-sdk and need to be installed alongside it.

npm install featurehub-solid-sdk featurehub-javascript-client-sdk solid-js
// or
yarn install featurehub-solid-sdk featurehub-javascript-client-sdk solid-js
// or
pnpm install featurehub-solid-sdk featurehub-javascript-client-sdk solid-js

General Usage

The FeatureHub Solid SDK provides the following:

  1. FeatureHub Solid top-level component to wrap your application with
  2. useFeature Solid hook to subscribe to feature keys within Solid components
  3. useFeatureHub Solid hook providing access to the FeatureHub config and client objects

Configuring FeatureHub for your Solid app is very straight forward.

// App.tsx
import { FeatureHub } from "featurehub-solid-sdk";

function AppContainer() {
  return (
    <FeatureHub url="..." apiKey="...">
      <App />
    </FeatureHub>
  );
}

The url and apiKey props are required as per FeatureHub configuration requirements. By doing the above, you are injecting the FeatureHub client into your Solid application tree (via Solid Context) which then allows you to use any of the additionally provided hooks (useFeatureHub and useFeature) anywhere within your child Solid components.

Hooks

useFeature<T>

// Navbar.tsx
import { useFeature } from "featurehub-solid-sdk";

// This NavBar component should be within some parent wrapped by the top-level <FeatureHub> component
function NavBar() {
  const showNewNavTab = useFeature("new_nav_tab");

  return <nav>{showNewNavTab() ? <a>New Nav</a> : null}</nav>;
}

The useFeature is a very simple convenience hook that allows you to subscribe to a feature key defined within FeatureHub and fetch its value. All it does is subscribe to the key on component mount and unsubscribes when the component unmounts from view.

The implementation of useFeature leverages TypeScript generics (default is boolean) which allows you to set the value type you would expect given a feature key. So to return a non-binary type like string / number or a complex object type, simply pass that information in as part of the invocation.

  • const someStr = useFeature<string>("key")
  • const someNum = useFeature<number>("key")
  • const someObj = useFeature<CustomType>("key")

useFeatureHub

// Navbar.tsx
import { useFeatureHub } from "featurehub-solid-sdk";

// This NavBar component should be within some parent wrapped by the top-level <FeatureHub> component
function NavBar() {
  // Returns the FeatureHub config and client objects
  const { config, client } = useFeatureHub();

  return <nav>...</nav>;
}

If for some reason useFeature is not sufficient and you require access to the underlying FeatureHub config or client context objects, you can do so via this hook.

Bundling

We use tsup to bundle this SDK.