The Frigade class is the main entry point for the Frigade JS SDK. It is used to create a new instance of the Frigade SDK and to interact with the Frigade API. The Step type is a representation of a step in a Flow. It contains all the data and methods needed to build custom components with Frigade and to interact with the Frigade API without writing a single custom network call.

​

Properties

​

getCollections

▸ getCollections(): Promise<CollectionsList>

---

​

getConfig

▸ getConfig(): FrigadeConfig Gets the current configuration. See FrigadeConfig for a list of available options.

---

​

getFlow

▸ getFlow(flowId): Promise<Flow> Get a Flow by its ID. Parameters

Name	Type
flowId	string

---

​

getFlows

▸ getFlows(): Promise<Flow[]>

---

​

group

▸ group(groupId?, properties?): Promise<void> Set the group for the current user. Parameters

Name	Type
groupId?	string
properties?	PropertyPayload

---

​

hasFailedToLoad

▸ hasFailedToLoad(): boolean Returns true if the JS SDK failed to connect to the Frigade API.

---

​

identify

▸ identify(userId, properties?): Promise<void> Set the current user. Parameters

Name	Type
userId	string
properties?	PropertyPayload

---

​

off

▸ off(event, handler): Promise<void> Removes the given handler. Parameters

Name	Type	Description
event	FlowChangeEvent	flow.any | flow.complete | flow.restart | flow.skip | flow.start | step.complete | step.skip | step.reset | step.start
handler	FlowChangeEventHandler

---

​

on

▸ on(event, handler): Promise<void> Event handler that captures all changes that happen to the state of the Flows. Use flow.any to capture all events. Parameters

Name	Type	Description
event	FlowChangeEvent	flow.any | flow.complete | flow.restart | flow.skip | flow.start | step.complete | step.skip | step.reset | step.start
handler	FlowChangeEventHandler

---

​

onStateChange

▸ onStateChange(handler): Promise<void> Event handler that captures all changes that happen to the state of the Flows. Parameters

Name	Type
handler	(flow: Flow, previousFlow?: Flow) => void

Deprecated Use frigade.on instead.

---

​

registerCollection

▸ registerCollection(collectionId): Promise<void> Parameters

Name	Type
collectionId	string

---

​

reload

▸ reload(config?): Promise<void> Reload the current state of the flows by calling the Frigade API. This will trigger all event handlers. Parameters

Name	Type	Description
config?	FrigadeConfig	optional config to use when reloading. If not passed, the current config will be used.

---

​

removeStateChangeHandler

▸ removeStateChangeHandler(handler): Promise<void> Removes the given handler from the list of event handlers. Parameters

Name	Type
handler	(flow: Flow, previousFlow?: Flow) => void

---

​

resync

▸ resync(): Promise<void>

---

​

track

▸ track(event, properties?): Promise<void> Track an event for the current user (and group if set). Parameters

Name	Type
event	string
properties?	PropertyPayload

---

​

triggerAllEventHandlers

▸ triggerAllEventHandlers(): void View definition