featurehub-eventsource-sdk
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.4 • Public • Published

    Javascript/Typescript Client SDK for FeatureHub

    NOTE: This library is deprecated

    Please use the Browser SDK for React/Angular/Vue applications, or Node SDK for nodejs applications.

    The documentation is the same for both and is in the Browser SDK, just the implementations of http/https related functionality differ.

    Overview

    Welcome to the Javascript/Typescript SDK for FeatureHub.io - Open source Feature flags management, A/B testing and remote configuration platform.

    Below explains how you can use the FeatureHub SDK in Javascript or Typescript for applications like Node.js backend server, Web front-end (e.g. React) or Mobile apps (React Native, Ionic, etc.).

    To control the feature flags from the FeatureHub Admin console, either use our demo version for evaluation or install the app using our guide here

    There are 2 ways to request for feature updates via this SDK:

    • SSE (Server Sent Events) realtime updates mechanism

      In this mode, you will make a connection to the FeatureHub Edge server using the EventSource library which this SDK is based on, and any updates to any features will come through to you in near realtime, automatically updating the feature values in the repository. Note, there is a known issues in the browsers with Kaspersky antivirus potentially blocking SSE events. GitHub issue

    • FeatureHub polling client (GET request updates)

      In this mode, you make a GET request, which you can choose to either do once, when specific things happen in your application, (such as navigation change) or on a regular basis (say every 5 minutes) and the changes will be passed into the FeatureHub repository for processing.

    Install

    npm i featurehub-eventsource-sdk

    DownloadsWeekly Downloads

    21

    Version

    2.0.4

    License

    MIT

    Unpacked Size

    16.3 kB

    Total Files

    14

    Last publish

    Collaborators

    • irinasouth
    • rvowles_featurehub