capacitor-launchdarkly 0.0.0-stage → 0.1.0

package/dist/docs.json

@@ -0,0 +1,1174 @@
+{
+  "api": {
+    "name": "LaunchDarklyPlugin",
+    "slug": "launchdarklyplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "initialize",
+        "signature": "(options: InitializeOptions) => Promise<LaunchDarklyState>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "InitializeOptions"
+          }
+        ],
+        "returns": "Promise<LaunchDarklyState>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Starts the client from JavaScript and waits for the first set of flags or\n`options.startWaitSeconds` (5 by default), whichever comes first.\n\n- **iOS, Android**: takes `mobileKey`. Needed only by an app that does not\n  put a `mobileKey` in `capacitor.config`; with one there, the client is\n  already running when the app's code starts, and this call only answers\n  its state.\n- **Web**: takes `clientSideId`, and is the only way to start the client.\n  Needs `@launchdarkly/js-client-sdk` installed (see the README).\n\n`context` plays the part of `initialContext`: when an earlier `identify()`\nstored a context, the client starts with the stored one instead, so the\napp does not flip to an anonymous context for a moment after a restart.\n\nThere is one client per process (per page on the web). A second call with\nthe same key, or a call after the native start-up already started a\nclient with that key, changes nothing: the client is not created again,\n`context` and `options` are ignored, and the current state is answered.\nUse `identify()` to switch the context. A call with a different key closes\nthe running client and starts a new one.",
+        "complexTypes": [
+          "LaunchDarklyState",
+          "InitializeOptions"
+        ],
+        "slug": "initialize"
+      },
+      {
+        "name": "waitForInitialization",
+        "signature": "(options?: WaitForInitializationOptions | undefined) => Promise<WaitForInitializationResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "WaitForInitializationOptions | undefined"
+          }
+        ],
+        "returns": "Promise<WaitForInitializationResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Answers whether the client has received its first set of flags, waiting\nup to `timeoutSeconds` (5 by default) for that when it has not yet.\n\nResolves `{ initialized: false }` straight away when no client was\nstarted, neither natively nor with `initialize()`.",
+        "complexTypes": [
+          "WaitForInitializationResult",
+          "WaitForInitializationOptions"
+        ],
+        "slug": "waitforinitialization"
+      },
+      {
+        "name": "getState",
+        "signature": "() => Promise<LaunchDarklyState>",
+        "parameters": [],
+        "returns": "Promise<LaunchDarklyState>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "The state of the native client: whether it has its flags, the current\ncontext and the value of every flag, read from the native SDK's own\nstore. Meant for bootstrapping the web layer at start without a second\nnetwork round trip.\n\nWhile the native start-up is still running, this waits until it is done:\nuntil the first set of flags is in, or `startWaitSeconds` has passed.\nWith no client at all it answers `initialized: false` and no flags.\n\nReading the flags this way sends no evaluation events.",
+        "complexTypes": [
+          "LaunchDarklyState"
+        ],
+        "slug": "getstate"
+      },
+      {
+        "name": "identify",
+        "signature": "(options: IdentifyOptions) => Promise<IdentifyResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "IdentifyOptions"
+          }
+        ],
+        "returns": "Promise<IdentifyResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Switches the client to another context and resolves when the flags for\nit are loaded, or when `timeoutSeconds` (5 by default) has passed.\n\nThe context the SDK accepted is stored natively, under a key of the\nplugin's own, and the next native start-up begins with it instead of\n`initialContext`. So an app logs out by identifying its anonymous\ncontext, which then becomes the stored one; `clearStoredContext()`\nforgets it altogether.\n\nAn anonymous context keeps the key it is given. The plugin never asks the\nSDK to generate one.",
+        "complexTypes": [
+          "IdentifyResult",
+          "IdentifyOptions"
+        ],
+        "slug": "identify"
+      },
+      {
+        "name": "variation",
+        "signature": "(options: VariationOptions) => Promise<VariationResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "VariationOptions"
+          }
+        ],
+        "returns": "Promise<VariationResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Evaluates one flag for the current context and answers its value, of any\nJSON type, or `defaultValue` (`null` when left out) when the flag is\nunknown or the client has not started. Goes through the SDK's JSON\nvariation call, so it records an evaluation event like any SDK call.",
+        "complexTypes": [
+          "VariationResult",
+          "VariationOptions"
+        ],
+        "slug": "variation"
+      },
+      {
+        "name": "allFlags",
+        "signature": "() => Promise<AllFlagsResult>",
+        "parameters": [],
+        "returns": "Promise<AllFlagsResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "The value of every flag for the current context, from the native SDK's\nstore. Sends no evaluation events. Empty when the client has not started.",
+        "complexTypes": [
+          "AllFlagsResult"
+        ],
+        "slug": "allflags"
+      },
+      {
+        "name": "setStreaming",
+        "signature": "(options: SetStreamingOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetStreamingOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Switches between streaming and polling. Neither native SDK can change its\ndata source while it runs, so the plugin closes the client and starts it\nagain with the same mobile key, options and current context, then waits as\nat start-up. Flag listeners stay registered. The web SDK switches in place\n(`setStreaming()`).",
+        "complexTypes": [
+          "SetStreamingOptions"
+        ],
+        "slug": "setstreaming"
+      },
+      {
+        "name": "setOnline",
+        "signature": "(options: SetOnlineOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetOnlineOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Takes the client online or offline (`setOnline()` / `setOffline()` on\nAndroid, `setOnline(_:)` on iOS). Offline, the client keeps answering the\nvalues it has.\n\nThe web SDK has no offline mode. There, going offline closes the stream so\nno flag updates arrive, and going online opens it again if `streaming` is\non; analytics events are still sent.",
+        "complexTypes": [
+          "SetOnlineOptions"
+        ],
+        "slug": "setonline"
+      },
+      {
+        "name": "flush",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Sends the analytics events the client has queued.",
+        "complexTypes": [],
+        "slug": "flush"
+      },
+      {
+        "name": "close",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Closes the client. It can be started again with `initialize()`; until\nthen, `variation()` answers the default value. The stored context is\nkept.",
+        "complexTypes": [],
+        "slug": "close"
+      },
+      {
+        "name": "clearStoredContext",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Forgets the context `identify()` stored, so the next native start-up\nbegins with `initialContext` again. The running client is not changed.",
+        "complexTypes": [],
+        "slug": "clearstoredcontext"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'flagChange', listenerFunc: (change: FlagChange) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'flagChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(change: FlagChange) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Called for every flag whose value changes: from the stream or a poll, and\nafter `identify()` for each flag whose value differs for the new context.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "FlagChange"
+        ],
+        "slug": "addlistenerflagchange-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'connectionModeChange', listenerFunc: (change: ConnectionModeChange) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'connectionModeChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(change: ConnectionModeChange) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Called when the SDK's connection mode changes, for example from streaming\nto offline. iOS and Android only: the web SDK has no connection mode, and\nthis is never called there.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "ConnectionModeChange"
+        ],
+        "slug": "addlistenerconnectionmodechange-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Removes every listener of this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "LaunchDarklyState",
+      "slug": "launchdarklystate",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "initialized",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the client has received its first set of flags, from the network\nor, when it was started offline, from its cache.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "context",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The current context. Absent when no client was started.",
+          "complexTypes": [
+            "LDContext"
+          ],
+          "type": "LDContext"
+        },
+        {
+          "name": "flags",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The value of every flag for the current context.",
+          "complexTypes": [
+            "LDFlagSet"
+          ],
+          "type": "LDFlagSet"
+        }
+      ]
+    },
+    {
+      "name": "LDSingleKindContext",
+      "slug": "ldsinglekindcontext",
+      "docs": "A context of one kind. Any other property is a custom attribute: a string,\nnumber, boolean, array or object.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "kind",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The context kind, for example `user` or `organization`.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "key",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The key. An anonymous context keeps the key it is given.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "anonymous",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Leaves the context out of the dashboard's context list. It is still\ncounted for billing by its key.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "_meta",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [
+            "LDContextMeta"
+          ],
+          "type": "LDContextMeta"
+        }
+      ]
+    },
+    {
+      "name": "LDContextMeta",
+      "slug": "ldcontextmeta",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "privateAttributes",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Attributes, by name or `/`-separated reference, that are not sent to\nLaunchDarkly in analytics events.",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "LDMultiKindContext",
+      "slug": "ldmultikindcontext",
+      "docs": "A context made of several kinds: `{ kind: 'multi', user: {...}, organization: {...} }`.\nEach kind's object has no `kind` of its own.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "kind",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "'multi'"
+        }
+      ]
+    },
+    {
+      "name": "LDFlagSet",
+      "slug": "ldflagset",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": []
+    },
+    {
+      "name": "InitializeOptions",
+      "slug": "initializeoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "mobileKey",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The mobile key of the LaunchDarkly environment, used on iOS and Android.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "clientSideId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The client-side ID of the LaunchDarkly environment, used on the web.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "context",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [
+            "LDContext"
+          ],
+          "type": "LDContext"
+        },
+        {
+          "name": "options",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [
+            "LaunchDarklyOptions"
+          ],
+          "type": "LaunchDarklyOptions"
+        }
+      ]
+    },
+    {
+      "name": "LaunchDarklyOptions",
+      "slug": "launchdarklyoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "streaming",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "default"
+            }
+          ],
+          "docs": "Streams flag updates when `true`, polls when `false`.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "evaluationReasons",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Asks LaunchDarkly for the reason behind each evaluation. The SDKs then\nattach it to their evaluation events.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "offline",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            }
+          ],
+          "docs": "Starts the client offline: it answers cached or default values and does\nnot connect until `setOnline({ online: true })`.\n\nThe web SDK has no offline mode: there `offline: true` starts without a\nstream, and the first flags are still fetched once.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "startWaitSeconds",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "5",
+              "name": "default"
+            }
+          ],
+          "docs": "How long the start waits for the first set of flags, in seconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "application",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Application metadata sent to LaunchDarkly with every request. It\ndescribes the app; it is not a context, and adds nothing to the contexts\ncounted for billing.",
+          "complexTypes": [
+            "LDApplicationInfo"
+          ],
+          "type": "LDApplicationInfo"
+        },
+        {
+          "name": "bootstrap",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Web only: flags to start with before LaunchDarkly answers. `'localStorage'`\nstarts from the flags the web SDK cached in `localStorage` for the context\non an earlier visit, which the SDK does on its own; a flag object (for\nexample rendered by your server) starts from those values. The native\nSDKs always start from their own cache and ignore this.",
+          "complexTypes": [
+            "LDFlagSet"
+          ],
+          "type": "'localStorage' | LDFlagSet | undefined"
+        }
+      ]
+    },
+    {
+      "name": "LDApplicationInfo",
+      "slug": "ldapplicationinfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "version",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "versionName",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "WaitForInitializationResult",
+      "slug": "waitforinitializationresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "initialized",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "WaitForInitializationOptions",
+      "slug": "waitforinitializationoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "timeoutSeconds",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "5",
+              "name": "default"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "IdentifyResult",
+      "slug": "identifyresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "timedOut",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "`true` when the flags of the new context did not arrive in time. The\ncontext is switched all the same, and the flags follow when they arrive.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "IdentifyOptions",
+      "slug": "identifyoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "context",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [
+            "LDContext"
+          ],
+          "type": "LDContext"
+        },
+        {
+          "name": "timeoutSeconds",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "5",
+              "name": "default"
+            }
+          ],
+          "docs": "How long to wait for the flags of the new context, in seconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "VariationResult",
+      "slug": "variationresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "value",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "unknown"
+        }
+      ]
+    },
+    {
+      "name": "VariationOptions",
+      "slug": "variationoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "key",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "defaultValue",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "null",
+              "name": "default"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "unknown"
+        }
+      ]
+    },
+    {
+      "name": "AllFlagsResult",
+      "slug": "allflagsresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "flags",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [
+            "LDFlagSet"
+          ],
+          "type": "LDFlagSet"
+        }
+      ]
+    },
+    {
+      "name": "SetStreamingOptions",
+      "slug": "setstreamingoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "enabled",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "SetOnlineOptions",
+      "slug": "setonlineoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "online",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "FlagChange",
+      "slug": "flagchange",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "key",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "value",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The new value; `null` when the flag was deleted.",
+          "complexTypes": [],
+          "type": "unknown"
+        },
+        {
+          "name": "previous",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The value before the change, when the plugin knew one.",
+          "complexTypes": [],
+          "type": "unknown"
+        }
+      ]
+    },
+    {
+      "name": "ConnectionModeChange",
+      "slug": "connectionmodechange",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "mode",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The SDK's own name for the mode, which differs between the platforms:\non iOS `streaming`, `polling`, `offline` or\n`establishingStreamingConnection`; on Android the name of the SDK's\n`ConnectionMode`, such as `STREAMING`, `POLLING`, `OFFLINE`,\n`SET_OFFLINE` or `BACKGROUND_POLLING`.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "LDContext",
+      "slug": "ldcontext",
+      "docs": "A context in the JSON shape LaunchDarkly's SDKs use: a single-kind context\nor a multi-context.",
+      "types": [
+        {
+          "text": "LDSingleKindContext",
+          "complexTypes": [
+            "LDSingleKindContext"
+          ]
+        },
+        {
+          "text": "LDMultiKindContext",
+          "complexTypes": [
+            "LDMultiKindContext"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": [
+    {
+      "name": "LaunchDarkly",
+      "slug": "launchdarkly",
+      "properties": [
+        {
+          "name": "mobileKey",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "\"mob-00000000-0000-0000-0000-000000000000\"",
+              "name": "example"
+            }
+          ],
+          "docs": "The mobile key of the LaunchDarkly environment. Without it there is\nno native start-up, and `initialize()` starts the client instead.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "initialContext",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "{ kind: 'user', key: 'anonymous_user', anonymous: true }",
+              "name": "default"
+            },
+            {
+              "text": "{ \"kind\": \"user\", \"key\": \"anonymous_user\", \"anonymous\": true }",
+              "name": "example"
+            }
+          ],
+          "docs": "The context the native start-up uses when no context was stored by an\nearlier `identify()`.",
+          "complexTypes": [
+            "LDContext"
+          ],
+          "type": "LDContext"
+        },
+        {
+          "name": "streaming",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "default"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "Streams flag updates when `true`, polls when `false`.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "evaluationReasons",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "false",
+              "name": "example"
+            }
+          ],
+          "docs": "Asks LaunchDarkly for the reason behind each evaluation.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "offline",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "false",
+              "name": "example"
+            }
+          ],
+          "docs": "Starts the client offline, until `setOnline({ online: true })`.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "startWaitSeconds",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "5",
+              "name": "default"
+            },
+            {
+              "text": "5",
+              "name": "example"
+            }
+          ],
+          "docs": "How long the start waits for the first set of flags, in seconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "application",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "{ \"id\": \"com.example.plugin\", \"version\": \"1.0.0\" }",
+              "name": "example"
+            }
+          ],
+          "docs": "Application metadata sent to LaunchDarkly with every request.",
+          "complexTypes": [
+            "LDApplicationInfo"
+          ],
+          "type": "LDApplicationInfo"
+        }
+      ],
+      "docs": "Starts the native LaunchDarkly client as the app launches, before the\nweb view runs any app code. Leave `mobileKey` out to start it from\nJavaScript with `initialize()` instead. iOS and Android only."
+    }
+  ]
+}