Class FPUser

A collection of attributes that can affect toggle evaluation, usually corresponding to a user of your application.

Hierarchy

FPUser

Index

Constructors

Properties

Accessors

Methods

extendAttrs getAttr stableRollout with

Constructors

constructor

new FPUser(stableRollout?: string): FPUser
Creates a new FPUser.
Parameters
- Optional stableRollout: string
  
  sets user with a unique id for percentage rollout, by default, a timestamp will be assigned as the key
Returns FPUser
- Defined in FPUser.ts:33

Properties

`Private` `Readonly` _attrs

_attrs: {
[key: string]: string;
}

Type declaration

[key: string]: string

`Private` _key

_key: string

Accessors

attrs

get attrs(): {
[key: string]: string;
}
Gets a copy of the user's attributions (custom values).

Returns {
[key: string]: string;
}
- [key: string]: string
- Defined in FPUser.ts:50

key

get key(): string
Gets the key of user.

The key may be manually defined for stableRollout, or auto generated (timestamp).

Returns string
- Defined in FPUser.ts:43

Methods

extendAttrs

extendAttrs(attrs: {
[key: string]: string;
}): FPUser
Adds multiple attributes to the user.

Returns
the FPUser
Parameters
- attrs: {
  [key: string]: string;
  }
  
  a map of attributions
  - [key: string]: string
Returns FPUser
- Defined in FPUser.ts:79

getAttr

getAttr(attrName: string): undefined | string
Parameters
- attrName: string
Returns undefined | string
- Defined in FPUser.ts:86

stableRollout

stableRollout(key: string): FPUser
Sets user with a unique id for percentage rollout.
Parameters
- key: string
  
  user unique id for percentage rollout
Returns FPUser
- Defined in FPUser.ts:58

with

with(attrName: string, attrValue: string): FPUser
Adds an attribute to the user.

Returns
the FPUser
Parameters
- attrName: string
  
  attribute name
- attrValue: string
  
  attribute value
Returns FPUser
- Defined in FPUser.ts:69

Generated using TypeDoc