Skip to content

feat: Allow users to create type-safe/strictly typed feature flags with useFlags #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ewlsh wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: Allow users to create type-safe/strictly typed feature flags with useFlags #151

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56f5c66
Allow any object type for useFlags generic
ewlsh Aug 30, 2022
85f3882
Merge branch 'main' into ewlsh-modern-health-improve-useflags-types
kinyoklion Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions src/useFlags.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { LDFlagSet } from 'launchdarkly-js-client-sdk';
import { LDFlagSet, LDFlagValue } from 'launchdarkly-js-client-sdk';
import React, { useContext } from 'react';
import { defaultReactOptions, ReactSdkContext } from './types';

Expand All @@ -12,9 +12,10 @@ import { defaultReactOptions, ReactSdkContext } from './types';
*
* @return All the feature flags configured in your LaunchDarkly project
*/
const useFlags = <T extends LDFlagSet = LDFlagSet>(reactContext?: React.Context<ReactSdkContext>): T => {
function useFlags<T extends Record<string, LDFlagValue> = LDFlagSet>(reactContext?: React.Context<ReactSdkContext>): T {
const { flags } = useContext<ReactSdkContext>(reactContext ?? defaultReactOptions.reactContext);

return flags as T;
};
}

export default useFlags;