@indigov/flags-api
TypeScript icon, indicating that this package has built-in type declarations

0.0.22 • Public • Published

F.L.A.G.S. API Client

Cross-platform Typescript SDK for the Flags service.

Usage

Installation

yarn:

yarn add @indigov/flags-api

Instantiation

import Flags from '@indigov/flags-api'

const flags = new Flags('API_TOKEN', 'OFFICE_NAME', 'SOURCE_OF_REQUEST')
// e.g. 
flags = new Flags('435234sdfgswdasdf', 'indigovstaging', 'northstar')

Making requests

The SDK exposes 3 endpoints - documentation is in source code:

  1. getFlag
  2. getFlagValue
  3. getFlags
// Uses office supplied in instanttiation
flags.getFlag('bulkapi:flags:minifiedhtmlenabled').then(console.log)
// Uses supplied office AND cohort
flags.getFlag('bulkapi:flags:minifiedhtmlenabled', { cohort: 'tests' }).then(console.log)
// Fetching raw flag value
flags.getFlagValue('bulkapi:flags:minifiedhtmlenabled').then(console.log)

Local Development

TODO

Testing

Tests are run using jest backed by ts-jest to avoid the need for transpilation.

yarn test

Publishing

Run:

yarn publish

And pick a sensible SemVer.

Note: You must be logged into npm through the CLI and part of the Indigov org.

/@indigov/flags-api/

    Package Sidebar

    Install

    npm i @indigov/flags-api

    Weekly Downloads

    11

    Version

    0.0.22

    License

    ISC

    Unpacked Size

    13.8 kB

    Total Files

    19

    Last publish

    Collaborators

    • lsapoz-indigov
    • dmarg
    • josephemswiler
    • ishwaryav
    • indigovadmin
    • derjacques
    • elindigov
    • christopher.silver
    • jezgo