Skip to content

Commit 7c67f85

Browse files
author
Athira M
committed
Add result of running yarn docgen:all
1 parent ee703b9 commit 7c67f85

File tree

8 files changed

+123
-23
lines changed

8 files changed

+123
-23
lines changed

docs-devsite/_toc.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -649,6 +649,8 @@ toc:
649649
path: /docs/reference/js/remote-config.customsignals.md
650650
- title: FetchResponse
651651
path: /docs/reference/js/remote-config.fetchresponse.md
652+
- title: FirebaseExperimentDescription
653+
path: /docs/reference/js/remote-config.firebaseexperimentdescription.md
652654
- title: FirebaseRemoteConfigObject
653655
path: /docs/reference/js/remote-config.firebaseremoteconfigobject.md
654656
- title: RemoteConfig

docs-devsite/remote-config.fetchresponse.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ export interface FetchResponse
2626
| --- | --- | --- |
2727
| [config](./remote-config.fetchresponse.md#fetchresponseconfig) | [FirebaseRemoteConfigObject](./remote-config.firebaseremoteconfigobject.md#firebaseremoteconfigobject_interface) | Defines the map of parameters returned as "entries" in the fetch response body.<p>Only defined for 200 responses. |
2828
| [eTag](./remote-config.fetchresponse.md#fetchresponseetag) | string | Defines the ETag response header value.<p>Only defined for 200 and 304 responses. |
29+
| [experiments](./remote-config.fetchresponse.md#fetchresponseexperiments) | [FirebaseExperimentDescription](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescription_interface)<!-- -->\[\] | A/B Test and Rollout experiment metadata.<p>Only defined for 200 responses. |
2930
| [status](./remote-config.fetchresponse.md#fetchresponsestatus) | number | The HTTP status, which is useful for differentiating success responses with data from those without.<p>The Remote Config client is modeled after the native <code>Fetch</code> interface, so HTTP status is first-class.<p>Disambiguation: the fetch response returns a legacy "state" value that is redundant with the HTTP status code. The former is normalized into the latter. |
3031
| [templateVersion](./remote-config.fetchresponse.md#fetchresponsetemplateversion) | number | The version number of the config template fetched from the server. |
3132

@@ -53,6 +54,18 @@ Defines the ETag response header value.
5354
eTag?: string;
5455
```
5556

57+
## FetchResponse.experiments
58+
59+
A/B Test and Rollout experiment metadata.
60+
61+
<p>Only defined for 200 responses.
62+
63+
<b>Signature:</b>
64+
65+
```typescript
66+
experiments?: FirebaseExperimentDescription[];
67+
```
68+
5669
## FetchResponse.status
5770

5871
The HTTP status, which is useful for differentiating success responses with data from those without.
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# FirebaseExperimentDescription interface
13+
Defines experiment and variant attached to a config parameter.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export interface FirebaseExperimentDescription
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [affectedParameterKeys](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescriptionaffectedparameterkeys) | string\[\] | |
26+
| [experimentId](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescriptionexperimentid) | string | |
27+
| [experimentStartTime](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescriptionexperimentstarttime) | string | |
28+
| [timeToLiveMillis](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescriptiontimetolivemillis) | string | |
29+
| [triggerTimeoutMillis](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescriptiontriggertimeoutmillis) | string | |
30+
| [variantId](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescriptionvariantid) | string | |
31+
32+
## FirebaseExperimentDescription.affectedParameterKeys
33+
34+
<b>Signature:</b>
35+
36+
```typescript
37+
affectedParameterKeys?: string[];
38+
```
39+
40+
## FirebaseExperimentDescription.experimentId
41+
42+
<b>Signature:</b>
43+
44+
```typescript
45+
experimentId: string;
46+
```
47+
48+
## FirebaseExperimentDescription.experimentStartTime
49+
50+
<b>Signature:</b>
51+
52+
```typescript
53+
experimentStartTime: string;
54+
```
55+
56+
## FirebaseExperimentDescription.timeToLiveMillis
57+
58+
<b>Signature:</b>
59+
60+
```typescript
61+
timeToLiveMillis: string;
62+
```
63+
64+
## FirebaseExperimentDescription.triggerTimeoutMillis
65+
66+
<b>Signature:</b>
67+
68+
```typescript
69+
triggerTimeoutMillis: string;
70+
```
71+
72+
## FirebaseExperimentDescription.variantId
73+
74+
<b>Signature:</b>
75+
76+
```typescript
77+
variantId: string;
78+
```

docs-devsite/remote-config.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environm
4242
| [ConfigUpdateObserver](./remote-config.configupdateobserver.md#configupdateobserver_interface) | Observer interface for receiving real-time Remote Config update notifications.<!-- -->NOTE: Although an <code>complete</code> callback can be provided, it will never be called because the ConfigUpdate stream is never-ending. |
4343
| [CustomSignals](./remote-config.customsignals.md#customsignals_interface) | Defines the type for representing custom signals and their values.<p>The values in CustomSignals must be one of the following types:<ul> <li><code>string</code> <li><code>number</code> <li><code>null</code> </ul> |
4444
| [FetchResponse](./remote-config.fetchresponse.md#fetchresponse_interface) | Defines a successful response (200 or 304).<p>Modeled after the native <code>Response</code> interface, but simplified for Remote Config's use case. |
45+
| [FirebaseExperimentDescription](./remote-config.firebaseexperimentdescription.md#firebaseexperimentdescription_interface) | Defines experiment and variant attached to a config parameter. |
4546
| [FirebaseRemoteConfigObject](./remote-config.firebaseremoteconfigobject.md#firebaseremoteconfigobject_interface) | Defines a self-descriptive reference for config key-value pairs. |
4647
| [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) | The Firebase Remote Config service interface. |
4748
| [RemoteConfigOptions](./remote-config.remoteconfigoptions.md#remoteconfigoptions_interface) | Options for Remote Config initialization. |

packages/remote-config/src/public_types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ export interface FetchResponse {
127127

128128
/**
129129
* A/B Test and Rollout experiment metadata.
130-
*
130+
*
131131
* <p>Only defined for 200 responses.
132132
*/
133133
experiments?: FirebaseExperimentDescription[];

packages/remote-config/test/api.test.ts

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,15 @@ describe('Remote Config API', () => {
6969
eTag: 'asdf',
7070
config: { 'foobar': 'hello world' },
7171
templateVersion: 1,
72-
experiments: [{
73-
experimentId: "_exp_1",
74-
variantId : "1",
75-
experimentStartTime : "2025-04-06T14:13:57.597Z",
76-
triggerTimeoutMillis : "15552000000",
77-
timeToLiveMillis : "15552000000"
78-
}]
72+
experiments: [
73+
{
74+
experimentId: '_exp_1',
75+
variantId: '1',
76+
experimentStartTime: '2025-04-06T14:13:57.597Z',
77+
triggerTimeoutMillis: '15552000000',
78+
timeToLiveMillis: '15552000000'
79+
}
80+
]
7981
};
8082
let fetchStub: sinon.SinonStub;
8183

@@ -114,7 +116,7 @@ describe('Remote Config API', () => {
114116
entries: response.config,
115117
state: 'OK',
116118
templateVersion: response.templateVersion,
117-
experimentDescriptions: response.experiments,
119+
experimentDescriptions: response.experiments
118120
})
119121
} as Response)
120122
);

packages/remote-config/test/client/rest_client.test.ts

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,13 +79,15 @@ describe('RestClient', () => {
7979
state: 'UPDATE',
8080
entries: { color: 'sparkling' },
8181
templateVersion: 1,
82-
experimentDescriptions: [{
83-
experimentId: "_exp_1",
84-
variantId : "1",
85-
experimentStartTime : "2025-04-06T14:13:57.597Z",
86-
triggerTimeoutMillis : "15552000000",
87-
timeToLiveMillis : "15552000000"
88-
}]
82+
experimentDescriptions: [
83+
{
84+
experimentId: '_exp_1',
85+
variantId: '1',
86+
experimentStartTime: '2025-04-06T14:13:57.597Z',
87+
triggerTimeoutMillis: '15552000000',
88+
timeToLiveMillis: '15552000000'
89+
}
90+
]
8991
};
9092

9193
fetchStub.returns(

packages/remote-config/test/remote_config.test.ts

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -391,13 +391,15 @@ describe('RemoteConfig', () => {
391391
const CONFIG = { key: 'val' };
392392
const NEW_ETAG = 'new_etag';
393393
const TEMPLATE_VERSION = 1;
394-
const EXPERIMENTS = [{
395-
"experimentId" : "_exp_1",
396-
"variantId" : "1",
397-
"experimentStartTime" : "2025-04-06T14:13:57.597Z",
398-
"triggerTimeoutMillis" : "15552000000",
399-
"timeToLiveMillis" : "15552000000"
400-
}];
394+
const EXPERIMENTS = [
395+
{
396+
'experimentId': '_exp_1',
397+
'variantId': '1',
398+
'experimentStartTime': '2025-04-06T14:13:57.597Z',
399+
'triggerTimeoutMillis': '15552000000',
400+
'timeToLiveMillis': '15552000000'
401+
}
402+
];
401403

402404
let getLastSuccessfulFetchResponseStub: sinon.SinonStub;
403405
let getActiveConfigEtagStub: sinon.SinonStub;

0 commit comments

Comments
 (0)