Skip to content

Function: getFeatureFlagById() ​

ts
function getFeatureFlagById(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  associations?: object[];
  details: object[];
  displayName?: string;
  id: string;
  key: string;
  schemaVersion?: string & object | "1.0";
  summary: {
   [key: string]: unknown;
     lastUpdated: Date;
     status: {
      [key: string]: unknown;
        defaultValue?: string;
        enabled: boolean;
        rollout?: {
         [key: string]: unknown;
           percentage?: number;
           rules?: number;
           text?: string;
        };
     };
     url?: string;
  };
  updateSequenceId: number;
}>;

Defined in: src/agile/api/featureFlags.ts:77

Retrieve the currently stored Feature Flag data for the given ID.

The result will be what is currently stored, ignoring any pending updates or deletes.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ featureFlagId: string; }-
parameters.featureFlagIdstringThe ID of the Feature Flag to fetch.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; associations?: object[]; details: object[]; displayName?: string; id: string; key: string; schemaVersion?: string & object | "1.0"; summary: { [key: string]: unknown; lastUpdated: Date; status: { [key: string]: unknown; defaultValue?: string; enabled: boolean; rollout?: { [key: string]: unknown; percentage?: number; rules?: number; text?: string; }; }; url?: string; }; updateSequenceId: number; }>