Merge branch 'gh-pages' of https://github.com/launchdarkly/js-core into gh-pages

Author: github-actions[bot]

packages/shared/akamai-edgeworker-sdk/docs/assets/search.js

@@ -26,7 +26,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-type ">BaseSDKParams</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">LDClient</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/20e6e63/packages/shared/akamai-edgeworker-sdk/src/index.ts#L40">packages/shared/akamai-edgeworker-sdk/src/index.ts:40</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/1a6cac7/packages/shared/akamai-edgeworker-sdk/src/index.ts#L40">packages/shared/akamai-edgeworker-sdk/src/index.ts:40</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

packages/shared/akamai-edgeworker-sdk/docs/classes/EdgeFeatureStore.html

@@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">EdgeProvider</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/20e6e63/packages/shared/akamai-edgeworker-sdk/src/featureStore/index.ts#L13">packages/shared/akamai-edgeworker-sdk/src/featureStore/index.ts:13</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/1a6cac7/packages/shared/akamai-edgeworker-sdk/src/featureStore/index.ts#L13">packages/shared/akamai-edgeworker-sdk/src/featureStore/index.ts:13</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -49,7 +49,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">rootKey</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/20e6e63/packages/shared/akamai-edgeworker-sdk/src/featureStore/index.ts#L14">packages/shared/akamai-edgeworker-sdk/src/featureStore/index.ts:14</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/launchdarkly/js-core/blob/1a6cac7/packages/shared/akamai-edgeworker-sdk/src/featureStore/index.ts#L14">packages/shared/akamai-edgeworker-sdk/src/featureStore/index.ts:14</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

packages/shared/akamai-edgeworker-sdk/docs/functions/init.html

@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">EventSourceCapabilities</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:68</li></ul></aside>
+<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:73</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -43,15 +43,15 @@ <h3 class="tsd-anchor-link"><span>custom<wbr/>Method</span><a href="#customMetho
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:84</li></ul></aside></section>
+<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:89</li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="headers" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>headers</span><a href="#headers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">headers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
 <div class="tsd-comment tsd-typography"><p>If true the event source supports setting HTTP headers.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:88</li></ul></aside></section>
+<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:93</li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="readTimeout" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>read<wbr/>Timeout</span><a href="#readTimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">read<wbr/>Timeout</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -65,7 +65,7 @@ <h3 class="tsd-anchor-link"><span>read<wbr/>Timeout</span><a href="#readTimeout"
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:79</li></ul></aside></section></section></div>
+<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:84</li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

packages/shared/akamai-edgeworker-sdk/docs/interfaces/EdgeProvider.html

@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">HttpErrorResponse</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:103</li></ul></aside>
+<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:108</li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,12 +38,12 @@ <h2>Properties</h2>
 <h3 class="tsd-anchor-link"><span>message</span><a href="#message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:104</li></ul></aside></section>
+<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:109</li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:105</li></ul></aside></section></section></div>
+<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:110</li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

packages/shared/akamai-edgeworker-sdk/docs/interfaces/platform-1.EventSourceCapabilities.html

@@ -30,6 +30,7 @@ <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabI
 <section class="tsd-index-section">
 <h3 class="tsd-index-heading">Properties</h3>
 <div class="tsd-index-list"><a href="platform-1.Options.html#body" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g></svg><span>body?</span></a>
+<a href="platform-1.Options.html#compressBodyIfPossible" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>compress<wbr/>Body<wbr/>If<wbr/>Possible?</span></a>
 <a href="platform-1.Options.html#headers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>headers?</span></a>
 <a href="platform-1.Options.html#keepalive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>keepalive?</span></a>
 <a href="platform-1.Options.html#method" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>method?</span></a>
@@ -42,6 +43,15 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 <div class="tsd-signature"><span class="tsd-kind-property">body</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
 <ul>
 <li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:60</li></ul></aside></section>
+<section class="tsd-panel tsd-member"><a id="compressBodyIfPossible" class="tsd-anchor"></a>
+<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>compress<wbr/>Body<wbr/>If<wbr/>Possible</span><a href="#compressBodyIfPossible" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
+<div class="tsd-signature"><span class="tsd-kind-property">compress<wbr/>Body<wbr/>If<wbr/>Possible</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
+<div class="tsd-comment tsd-typography"><p>Gzip compress the post body only if the underlying SDK framework supports it
+and the config option enableEventCompression is set to true.</p>
+</div>
+<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
+<ul>
+<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:65</li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="headers" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>headers</span><a href="#headers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">headers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
@@ -55,7 +65,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 </div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:66</li></ul></aside></section>
+<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:71</li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="method" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>method</span><a href="#method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">method</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
@@ -65,7 +75,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>timeout</span><a href="#timeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:61</li></ul></aside></section></section></div>
+<li>Defined in packages/shared/common/dist/esm/api/platform/Requests.d.ts:66</li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -86,6 +96,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
 <div class="tsd-accordion-details">
 <ul>
 <li><a href="#body" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>body</span></a></li>
+<li><a href="#compressBodyIfPossible" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>compress<wbr/>Body<wbr/>If<wbr/>Possible</span></a></li>
 <li><a href="#headers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>headers</span></a></li>
 <li><a href="#keepalive" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>keepalive</span></a></li>
 <li><a href="#method" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>method</span></a></li>