@featbit/react-client-sdk/dist/withFbConsumer.d.ts

FeatBit client SDK for React

import * as React from 'react';
import { IFbClient } from '@featbit/js-client-sdk';
import { IFlagSet } from "./types";
/**
 * Controls the props the wrapped component receives from the `FbConsumer` HOC.
 */
export interface ConsumerOptions {
    /**
     * If true then the wrapped component only receives the `fbClient` instance
     * and nothing else.
     */
    clientOnly: boolean;
}
/**
 * The possible props the wrapped component can receive from the `FbConsumer` HOC.
 */
export interface FbProps {
    /**
     * A map of feature flags from their keys to their values.
     * Keys are camelCased using `lodash.camelcase`.
     */
    flags?: IFlagSet;
    /**
     * An instance of `FB` from the FeatBit JS Client SDK (`@featbit/js-client-sdk`)
     */
    fbClient?: IFbClient;
}
/**
 * withFbConsumer is a function which accepts an optional options object and returns a function
 * which accepts your React component. This function returns a HOC with flags
 * and the FB instance injected via props.
 *
 * @param options - If you need only the `fbClient` instance and not flags, then set `{ clientOnly: true }`
 * to only pass the fbClient prop to your component. Defaults to `{ clientOnly: false }`.
 * @return A HOC with flags and the `fbClient` instance injected via props
 */
declare function withFbConsumer(options?: ConsumerOptions): <P>(WrappedComponent: React.ComponentType<P & FbProps>) => (props: P) => React.JSX.Element;
export default withFbConsumer;