FeatureFlag.md

FeatureFlag

Properties

Name	Type	Description	Notes
name	string	A human-friendly name for the feature flag	[default to undefined]
kind	string	Kind of feature flag	[default to undefined]
description	string	Description of the feature flag	[optional] [default to undefined]
key	string	A unique key used to reference the flag in your code	[default to undefined]
_version	number	Version of the feature flag	[default to undefined]
creationDate	number		[default to undefined]
includeInSnippet	boolean	Deprecated, use <code>clientSideAvailability</code>. Whether this flag should be made available to the client-side JavaScript SDK	[optional] [default to undefined]
clientSideAvailability	ClientSideAvailability		[optional] [default to undefined]
variations	Array<Variation>	An array of possible variations for the flag	[default to undefined]
temporary	boolean	Whether the flag is a temporary flag	[default to undefined]
tags	Array<string>	Tags for the feature flag	[default to undefined]
_links	{ [key: string]: Link; }	The location and content type of related resources	[default to undefined]
maintainerId	string	Associated maintainerId for the feature flag	[optional] [default to undefined]
_maintainer	MemberSummary		[optional] [default to undefined]
maintainerTeamKey	string	The key of the associated team that maintains this feature flag	[optional] [default to undefined]
_maintainerTeam	MaintainerTeam		[optional] [default to undefined]
goalIds	Array<string>	Deprecated, use <code>experiments</code> instead	[optional] [default to undefined]
experiments	ExperimentInfoRep		[default to undefined]
customProperties	{ [key: string]: CustomProperty; }		[default to undefined]
archived	boolean	Boolean indicating if the feature flag is archived	[default to undefined]
archivedDate	number		[optional] [default to undefined]
deprecated	boolean	Boolean indicating if the feature flag is deprecated	[optional] [default to undefined]
deprecatedDate	number		[optional] [default to undefined]
defaults	Defaults		[optional] [default to undefined]
_purpose	string		[optional] [default to undefined]
migrationSettings	FlagMigrationSettingsRep		[optional] [default to undefined]
environments	{ [key: string]: FeatureFlagConfig; }	Details on the environments for this flag. Only returned if the request is filtered by environment, using the <code>filterEnv</code> query parameter.	[optional] [default to undefined]

Example

import { FeatureFlag } from 'launchdarkly-api-typescript';

const instance: FeatureFlag = {
    name,
    kind,
    description,
    key,
    _version,
    creationDate,
    includeInSnippet,
    clientSideAvailability,
    variations,
    temporary,
    tags,
    _links,
    maintainerId,
    _maintainer,
    maintainerTeamKey,
    _maintainerTeam,
    goalIds,
    experiments,
    customProperties,
    archived,
    archivedDate,
    deprecated,
    deprecatedDate,
    defaults,
    _purpose,
    migrationSettings,
    environments,
};

[Back to Model list] [Back to API list] [Back to README]