Options
All
  • Public
  • Public/Protected
  • All
Menu

A client for managing flags

const { FlagClient } = require('tog-node')

const tog = new FlagClient('redis://127.0.0.1:6379')

Hierarchy

  • FlagClient

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

redis

redis: Redis | Cluster

Methods

deleteFlag

  • deleteFlag(namespace: string, name: string): Promise<boolean>
  • Deletes a flag from a namespace

    Parameters

    • namespace: string

      Flag namespace

    • name: string

      Flag name

    Returns Promise<boolean>

    Whether a flag existed and was deleted (true), or not (false)

getFlag

  • getFlag(namespace: string, name: string): Promise<Flag>
  • Gets a single flag from a namespace

    Parameters

    • namespace: string

      Flag namespace

    • name: string

      Flag name

    Returns Promise<Flag>

listFlags

  • listFlags(namespace: string): Promise<Flag[]>
  • Lists flags in a namespace

    Parameters

    • namespace: string

      Flags namespace

    Returns Promise<Flag[]>

saveFlag

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc