Skip to content

Commit f3a0f16

Browse files
Run yarn docgen:all
1 parent 26ce7e1 commit f3a0f16

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

docs-devsite/_toc.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,8 @@ toc:
422422
- title: remote-config
423423
path: /docs/reference/js/remote-config.md
424424
section:
425+
- title: CustomSignals
426+
path: /docs/reference/js/remote-config.customsignals.md
425427
- title: RemoteConfig
426428
path: /docs/reference/js/remote-config.remoteconfig.md
427429
- title: RemoteConfigSettings
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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+
# CustomSignals interface
13+
Defines the type for representing custom signals and their values.
14+
15+
<p>The values in CustomSignals must be one of the following types:
16+
17+
<ul> <li><code>string</code> <li><code>number</code> </ul>
18+
19+
<b>Signature:</b>
20+
21+
```typescript
22+
export interface CustomSignals
23+
```

docs-devsite/remote-config.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environm
2828
| [getNumber(remoteConfig, key)](./remote-config.md#getnumber_476c09f) | Gets the value for the given key as a number.<!-- -->Convenience method for calling <code>remoteConfig.getValue(key).asNumber()</code>. |
2929
| [getString(remoteConfig, key)](./remote-config.md#getstring_476c09f) | Gets the value for the given key as a string. Convenience method for calling <code>remoteConfig.getValue(key).asString()</code>. |
3030
| [getValue(remoteConfig, key)](./remote-config.md#getvalue_476c09f) | Gets the [Value](./remote-config.value.md#value_interface) for the given key. |
31+
| [setCustomSignals(remoteConfig, customSignals)](./remote-config.md#setcustomsignals_aeeb95e) | Sets the custom signals for the app instance. |
3132
| [setLogLevel(remoteConfig, logLevel)](./remote-config.md#setloglevel_039a45b) | Defines the log level to use. |
3233
| <b>function()</b> |
3334
| [isSupported()](./remote-config.md#issupported) | This method provides two different checks:<!-- -->1. Check if IndexedDB exists in the browser environment. 2. Check if the current browser context allows IndexedDB <code>open()</code> calls. |
@@ -36,6 +37,7 @@ The Firebase Remote Config Web SDK. This SDK does not work in a Node.js environm
3637

3738
| Interface | Description |
3839
| --- | --- |
40+
| [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> </ul> |
3941
| [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) | The Firebase Remote Config service interface. |
4042
| [RemoteConfigSettings](./remote-config.remoteconfigsettings.md#remoteconfigsettings_interface) | Defines configuration options for the Remote Config SDK. |
4143
| [Value](./remote-config.value.md#value_interface) | Wraps a value with metadata and type-safe getters. |
@@ -276,6 +278,27 @@ export declare function getValue(remoteConfig: RemoteConfig, key: string): Value
276278

277279
The value for the given key.
278280

281+
### setCustomSignals(remoteConfig, customSignals) {:#setcustomsignals_aeeb95e}
282+
283+
Sets the custom signals for the app instance.
284+
285+
<b>Signature:</b>
286+
287+
```typescript
288+
export declare function setCustomSignals(remoteConfig: RemoteConfig, customSignals: CustomSignals): Promise<void>;
289+
```
290+
291+
#### Parameters
292+
293+
| Parameter | Type | Description |
294+
| --- | --- | --- |
295+
| remoteConfig | [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) | The [RemoteConfig](./remote-config.remoteconfig.md#remoteconfig_interface) instance. |
296+
| customSignals | [CustomSignals](./remote-config.customsignals.md#customsignals_interface) | Map (key, value) of the custom signals to be set for the app instance. |
297+
298+
<b>Returns:</b>
299+
300+
Promise&lt;void&gt;
301+
279302
### setLogLevel(remoteConfig, logLevel) {:#setloglevel_039a45b}
280303

281304
Defines the log level to use.

0 commit comments

Comments
 (0)