Guides

JavaScript, Node, Deno

Suggest Edits

Welcome to the Flagship JS SDK documentation!

The following article will guide you through the steps to get Flagship up and running on your JavaScript environment (client-side or server-side) using our client library with preconfigured methods to implement the Decision API.

Wants to have a look at the GitHub repo? Link here.

Feel free to contact us if you have any questions regarding this documentation.

📘

That SDK is compatible with NodeJS, JS, TS & Deno Environment.
Any question? Contact our support

Release notes

3.2.6 (Latest version)

Added

  • campaignName, variationGroupName and variationName in Flag metadata

3.2.5

Added

  • fetchFlagsBufferingTime property in config object.
  • trackingManagerConfig property in config object.
  • New warning logs

Deprecated

  • trackingMangerConfig property of config object.

3.2.4

Added

  • qt field in activate batch. It represents the time delta (in milliseconds) between when the hit reported occurred and the time it was sent.
  • nextFetchConfig property in config object.

Improved

  • The flow of Visitor consent hit in Periodic strategy

3.2.3

Fixed

  • Deno issue

3.2.2

Improved

  • SDK logs

3.2.1

Fixed

  • vitejs build issue

3.2.0

Added

  • Third party integration in bucketing mode

3.1.4

Added

Deprecated

  • onUserExposure property in SDK
  • flag.userExposure method

Changed

  • logLevel for non-consent mode and panic mode

3.1.3

Fixed

  • webpack 5 compilation error targeting web

3.1.2

Fixed

  • default logs manager timestamp

3.1.1

Added

  • BUCKETING_EDGE mode see
  • exports field in package.json

3.1.0

Added

Changed

Removed

  • activateDeduplicationTime option from SDK Config

Deprecated

  • DecisionMode.API use DecisionMode.DECISION_API instead of

3.0.15

Added

  • onLog property in SDK Config

3.0.14

Added

  • Flagship ReactJS and React-native SDK can now override SDK code version with their own

3.0.13

Added

  • visitor_consent key in the body of the campaign request

Removed

  • sendContextEvent query param from the campaign request

3.0.12

Added

  • onUserExposure property in SDK Config

3.0.11

Fixed

  • When flag value from Flagship is false or 0, Flag.getValue() always returns the default value instead of flag value

Updated

  • package dependencies to the latest version

3.0.10

Added

  • react-native Property in package.json file

Changed

  • Event hit property value can now only accept an integer and must not be a negative value

3.0.9

Fixed

  • Flagship.Start method returns a null instead of Flagship instance when API_KEY or ENV_ID is null,

3.0.8

Fixed

  • Flagship.Start method returns null instead of Flagship instance when API_KEY or ENV_ID is null,

3.0.8

Added

  • esm support

3.0.7

Added

  • slug property in flag.metadata

Changed

  • Now lookupVisitor and lookupHits methods will be called each time visitor.fetchFlags method is called
  • When the default flag value is "null", no type checking will be performed anymore

3.0.6

Built

  • deno package

3.0.5

Improved

  • Performance of Flag.exists method

Removed

  • flag.GetValue log message when value of flagDTO is null

3.0.4

Added

  • Deno as SDK_LANGUAGE in x-sdk-client http header when running in Deno environment

Fixed

  • Batch hit length

3.0.3

Changed

  • No SEGMENT hits will be sent when visitor context is empty

3.0.2

Fixed

  • Reset visitor cache data when visitorId property has changed

3.0.1

Added

  • AssignmentsHistory property in VisitorCacheDTO type

Fixed

  • Variation Re-allocation in bucketing mode

3.0.0

Added

  • Visitor.fetchFlags method
  • Visitor.getFlag method
  • Flag class
  • FlagMetadata class
  • Managing visitor cache
  • SDK Status / Status changed callback.
  • Visitor consent.
  • Predefined context.
  • Custom log manager
  • Visitor.getFlagsDataArray method
  • Visitor.getAllFlagsData method
  • Visitor.getFlatsDataForCampaign method

Deprecated

  • visitor.synchronizeModifications method
  • Visitor.getModification method
  • Visitor.getModificationSync method
  • Visitor.getModificationInfoSync method
  • Visitor.getModificationInfo method
  • Visitor.activateModifications method
  • Visitor.getModificationsForCampaign method
  • Visitor.getAllModifications method

Changed

  • Flagship.newVisitor signature.
  • Visitor.sendHit and Visitor.sendHits signature
  • Visitor.activateModifications signature

Removed

  • Flagship.startBucketingPolling method
  • Flagship.stopBucketingPolling method

2.2.13

Fixed

  • fix authenticate and unauthenticate unhandle error

2.2.12

Added

  • Save VisitorData at each synchronizeModifications

Updated 14 days ago

What’s Next