Function DoptProvider

  • Alpha

    Returns the appropriate DoptProvider based on the props provided.

    Remarks

    The BaseProvider (exposed as DoptProvder) can currently be configured to support two distinct usages

    Using ProviderConfig

    Example

     import { DoptProvider } from '@dopt/react';
    import Application from './application';

    export function Index() {
    return (
    <DoptProvider userId={userId} apikey={apiKey}>
    <Application />
    </DoptProvider>
    );
    }

    Using MockProviderConfig

    Example

     import { DoptProvider } from '@dopt/react';
    import Application from './application';

    const blocks: Blocks = {
    'HNWvcT78tyTwygnbzU6SW': {
    active: true,
    started: false,
    completed: false,
    stopped: false,
    exited: false,
    },
    };

    export function Index() {
    return (
    <DoptProvider mocks={{ blocks }}>
    <Application />
    </DoptProvider>
    );
    }

    Returns

    props is MockProviderConfig ? MockDoptProvider : DoptProvider

    Returns ReturnType<typeof MockDoptProvider> | ReturnType<typeof DoptProvider>

Generated using TypeDoc