diff --git a/CHANGELOG.md b/CHANGELOG.md index 1a70550..70c4a17 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.7.6](https://github.com/amplitude/experiment-node-server/compare/v1.7.5...v1.7.6) (2023-10-23) + +**Note:** Version bump only for package experiment-node-server-root + + + + + ## [1.7.5](https://github.com/amplitude/experiment-node-server/compare/v1.7.4...v1.7.5) (2023-10-02) diff --git a/docs/classes/AmplitudeCookie.html b/docs/classes/AmplitudeCookie.html index f660540..4bc266f 100644 --- a/docs/classes/AmplitudeCookie.html +++ b/docs/classes/AmplitudeCookie.html @@ -1,4 +1,4 @@ -AmplitudeCookie | Experiment JS Server Documentation - v1.7.5
+AmplitudeCookie | Experiment JS Server Documentation - v1.7.6
  • Preparing search index...
    • -
  • The search index is not available
Experiment JS Server Documentation - v1.7.5
+
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Class AmplitudeCookie

    @@ -51,7 +51,7 @@

    Methods

    Static cookieName

      - +

    • Returns

      The cookie name that Amplitude sets for the provided @@ -63,12 +63,16 @@

      Parameters

    • amplitudeApiKey: string

      The Amplitude API Key

      +
      • +
    • +
      newFormat: boolean = false
      +

      True if the cookie is in the Browser SDK 2.0 format

    Returns string

    Static generate

      - +

    • Generates a cookie string to set for the Amplitude Javascript SDK

      @@ -80,12 +84,16 @@

      Parameters

    • deviceId: string

      A device id to set

      +
      • +
    • +
      newFormat: boolean = false
      +

      True if the cookie is in the Browser SDK 2.0 format

    Returns string

    Static parse

    Returns ExperimentUser

    @@ -116,7 +128,7 @@

    Theme

    @@ -6,13 +6,13 @@ Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Class ExperimentClient

    @@ -97,7 +97,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Class FlagConfigFetcher

    @@ -105,7 +105,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Class FlagConfigPoller

    @@ -150,7 +150,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Class InMemoryFlagConfigCache

    @@ -164,7 +164,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Class LocalEvaluationClient

    @@ -133,7 +133,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Class RemoteEvaluationClient

    @@ -100,7 +100,7 @@

    Theme

    @@ -6,12 +6,12 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6
    -

    Experiment JS Server Documentation - v1.7.5

    +

    Experiment JS Server Documentation - v1.7.6

    This is the API Reference for the Experiment Node.js Server SDK. For more details on implementing this SDK, view the [documentation] @@ -69,7 +69,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Interface FlagConfigCache

    @@ -141,7 +141,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Type alias AssignmentConfig

    AssignmentConfig: {
        apiKey: string;
        cacheCapacity?: number;
    } & NodeOptions
    @@ -33,7 +33,7 @@

    Theme

    @@ -6,13 +6,13 @@ Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Type alias ExperimentConfig

    ExperimentConfig: RemoteEvaluationConfig
    @@ -36,7 +36,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Type alias ExperimentUser

    ExperimentUser: {
        carrier?: string;
        city?: string;
        country?: string;
        device_brand?: string;
        device_id?: string;
        device_manufacturer?: string;
        device_model?: string;
        dma?: string;
        group_properties?: {
            [groupType: string]: {
                [groupName: string]: {
                    [propertyName: string]: string | number | boolean | (string | number | boolean)[];
                };
            };
        };
        groups?: {
            [groupType: string]: string[];
        };
        language?: string;
        library?: string;
        os?: string;
        platform?: string;
        region?: string;
        user_id?: string;
        user_properties?: {
            [propertyName: string]: string | number | boolean | (string | number | boolean)[];
        };
        version?: string;
    }
    @@ -124,7 +124,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Type alias FetchOptions

    FetchOptions: {
        flagKeys?: string[];
    }
    @@ -42,7 +42,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Type alias FlagConfig

    FlagConfig: Record<string, unknown>
    @@ -37,7 +37,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Type alias LocalEvaluationConfig

    LocalEvaluationConfig: {
        assignmentConfig?: AssignmentConfig;
        bootstrap?: Record<string, FlagConfig>;
        debug?: boolean;
        flagConfigPollingIntervalMillis?: number;
        httpAgent?: https.Agent;
        serverUrl?: string;
    }
    @@ -67,7 +67,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Type alias RemoteEvaluationConfig

    RemoteEvaluationConfig: {
        debug?: boolean;
        fetchRetries?: number;
        fetchRetryBackoffMaxMillis?: number;
        fetchRetryBackoffMinMillis?: number;
        fetchRetryBackoffScalar?: number;
        fetchRetryTimeoutMillis?: number;
        fetchTimeoutMillis?: number;
        httpAgent?: https.Agent;
        serverUrl?: string;
    }
    @@ -74,7 +74,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Type alias Variant

    Variant: {
        payload?: any;
        value: string;
    }
    @@ -44,7 +44,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Type alias Variants

    Variants: {
        [flagKey: string]: Variant;
    }
    @@ -38,7 +38,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Variable DefaultsConst

    Defaults: ExperimentConfig = ...
    @@ -36,7 +36,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Variable ExperimentConst

    Experiment: {
        initialize: ((apiKey: string, config?: RemoteEvaluationConfig) => ExperimentClient);
        initializeLocal: ((apiKey: string, config?: LocalEvaluationConfig) => LocalEvaluationClient);
        initializeRemote: ((apiKey: string, config?: RemoteEvaluationConfig) => RemoteEvaluationClient);
    } = ...
    @@ -110,7 +110,7 @@

    Theme

    @@ -6,13 +6,13 @@
    Experiment JS Server Documentation - v1.7.5 +
  • The search index is not available
    • Experiment JS Server Documentation - v1.7.6

    Variable RemoteEvaluationDefaultsConst

    RemoteEvaluationDefaults: RemoteEvaluationConfig = ...
    @@ -83,7 +83,7 @@

    Theme