index.d.ts 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. /*! firebase-admin v12.1.1 */
  2. /*!
  3. * Copyright 2020 Google Inc.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. /**
  18. * Firebase Remote Config.
  19. *
  20. * @packageDocumentation
  21. */
  22. import { App } from '../app';
  23. import { RemoteConfig } from './remote-config';
  24. export { AndCondition, DefaultConfig, EvaluationContext, ExplicitParameterValue, GetServerTemplateOptions, InAppDefaultValue, InitServerTemplateOptions, ListVersionsOptions, ListVersionsResult, MicroPercentRange, NamedCondition, OneOfCondition, OrCondition, ParameterValueType, PercentConditionOperator, PercentCondition, RemoteConfigCondition, RemoteConfigParameter, RemoteConfigParameterGroup, RemoteConfigParameterValue, RemoteConfigTemplate, RemoteConfigUser, ServerConfig, ServerTemplate, ServerTemplateData, ServerTemplateDataType, TagColor, Value, ValueSource, Version, } from './remote-config-api';
  25. export { RemoteConfig } from './remote-config';
  26. /**
  27. * Gets the {@link RemoteConfig} service for the default app or a given app.
  28. *
  29. * `getRemoteConfig()` can be called with no arguments to access the default
  30. * app's `RemoteConfig` service or as `getRemoteConfig(app)` to access the
  31. * `RemoteConfig` service associated with a specific app.
  32. *
  33. * @example
  34. * ```javascript
  35. * // Get the `RemoteConfig` service for the default app
  36. * const defaultRemoteConfig = getRemoteConfig();
  37. * ```
  38. *
  39. * @example
  40. * ```javascript
  41. * // Get the `RemoteConfig` service for a given app
  42. * const otherRemoteConfig = getRemoteConfig(otherApp);
  43. * ```
  44. *
  45. * @param app - Optional app for which to return the `RemoteConfig` service.
  46. * If not provided, the default `RemoteConfig` service is returned.
  47. *
  48. * @returns The default `RemoteConfig` service if no
  49. * app is provided, or the `RemoteConfig` service associated with the provided
  50. * app.
  51. */
  52. export declare function getRemoteConfig(app?: App): RemoteConfig;