Add interfaces to index.d.ts #825
Conversation
| }); | ||
|
|
||
| it('should return a cached version of Messaging on subsequent calls', () => { | ||
| it('should return a cached version of Storage on subsequent calls', () => { |
There was a problem hiding this comment.
Fixed a typo. I can move this to a separate PR if we prefer that :)
src/index.d.ts
Outdated
| * | ||
| * @example | ||
| * ```javascript | ||
| * // Get the RemoteConfig service for the default app |
There was a problem hiding this comment.
Suggest backticks if we mean this as a literal, or just "Remote Config" if we mean to refer to the product name.
src/index.d.ts
Outdated
| * | ||
| * @example | ||
| * ```javascript | ||
| * // Get the RemoteConfig service for a given app |
There was a problem hiding this comment.
Suggest backticks if we mean this as a literal, or just "Remote Config" if we mean to refer to the product name.
src/index.d.ts
Outdated
| * ``` | ||
| * | ||
| * @param app Optional app whose `RemoteConfig` service to | ||
| * return. If not provided, the default `RemoteConfig` service will be returned. |
There was a problem hiding this comment.
I know this makes it sound even worse, but I don't think we can use "whose" correctly that way. Suggest: "Optional app for which to return the RemoteConfig service."
src/index.d.ts
Outdated
| * ``` | ||
| * | ||
| * @param app Optional app whose `RemoteConfig` service to | ||
| * return. If not provided, the default `RemoteConfig` service will be returned. |
src/index.d.ts
Outdated
| * return. If not provided, the default `RemoteConfig` service will be returned. | ||
| * | ||
| * @return The default `RemoteConfig` service if no | ||
| * app is provided or the `RemoteConfig` service associated with the provided |
There was a problem hiding this comment.
Suggest comma: "provided, or"
src/index.d.ts
Outdated
|
|
||
| /** | ||
| * Interface representing a Remote Config parameter. | ||
| * At minimum, a `defaultValue` or a `conditionalValues` entry should be present for the |
There was a problem hiding this comment.
Should "should" be "must" ?
src/index.d.ts
Outdated
|
|
||
| /** | ||
| * A `(condition name, value)` map. The `condition_name` of the highest priority | ||
| * (the one listed first in the `RemoteConfig`'s conditions list) determines the value of |
There was a problem hiding this comment.
Should this be "RemoteConfig object's" ?
Or maybe "template's" ?
There was a problem hiding this comment.
Good catch. Changed the wording to The condition name of the highest priority (the one listed first in the Remote Config template's conditions list) determines the value of this parameter.
src/index.d.ts
Outdated
| /** | ||
| * The logic of this condition. | ||
| * See the documentation on | ||
| * {@link https://firebase.google.com/docs/remote-config/condition-reference Condition Expressions} |
src/index.d.ts
Outdated
|
|
||
| /** | ||
| * The color associated with this condition for display purposes in the Firebase Console. | ||
| * Not specifying this value results in the Console picking an arbitrary color to associate |
src/index.d.ts
Outdated
| /** | ||
| * Publishes a Remote Config template. | ||
| * | ||
| * @param template The Remote Config template to be validated. |
There was a problem hiding this comment.
Should this be "published" ?
There was a problem hiding this comment.
Good catch! Thanks!
3 participants
index.d.tsNote: Integration tests will be added in an upcoming PR