Skip to content

Commit

Permalink
Verify spelling fixes pass check-spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
jsoref authored May 30, 2024
2 parents 97e22c4 + 10eacae commit b227b95
Show file tree
Hide file tree
Showing 225 changed files with 426 additions and 427 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ root = true
end_of_line = lf
insert_final_newline = true

# Javascript and Typescript look like Google-style
# JavaScript and TypeScript look like Google-style
[*.{js,json,ts}]
charset = utf-8
indent_style = space
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report_v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ body:
attributes:
value: |
*[READ THIS]:* to evaluate if you are in the right place?
- For issues or feature requests related to __the code in this repository__, file a Github issue.
- For issues or feature requests related to __the code in this repository__, file a GitHub issue.
- If this is a __feature request__, make sure the issue title starts with "FR:".
- For general technical questions, post a question on [StackOverflow](http://stackoverflow.com/) with the firebase tag.
- For general Firebase discussion, use the [firebase-talk](https://groups.google.com/forum/#!forum/firebase-talk) google group.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ jobs:
curl -X POST -H "Content-Type:application/json" \
-d "{\"version\":\"$BASE_VERSION\",\"date\":\"$DATE\"}" \
$RELEASE_TRACKER_URL/logProduction
- name: Create Github release
- name: Create GitHub release
env:
GITHUB_TOKEN: ${{ github.token }}
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ env:
# make chromedriver detect installed Chrome version and download the corresponding driver
DETECT_CHROMEDRIVER_VERSION: true
# The default behavior of chromedriver uses the older Chrome download URLs. We need to override
# the beahvior to use the new URLs.
# the behavior to use the new URLs.
CHROMEDRIVER_CDNURL: https://googlechromelabs.github.io/
CHROMEDRIVER_CDNBINARIESURL: https://storage.googleapis.com/chrome-for-testing-public
CHROME_VALIDATED_VERSION: linux-120.0.6099.71
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-changed-auth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ env:
# make chromedriver detect installed Chrome version and download the corresponding driver
DETECT_CHROMEDRIVER_VERSION: true
# The default behavior of chromedriver uses the older Chrome download URLs. We need to override
# the beahvior to use the new URLs.
# the behavior to use the new URLs.
CHROMEDRIVER_CDNURL: https://googlechromelabs.github.io/
CHROMEDRIVER_CDNBINARIESURL: https://storage.googleapis.com/chrome-for-testing-public
CHROME_VALIDATED_VERSION: linux-120.0.6099.71
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Firebase Javascript SDK
# Firebase JavaScript SDK

<!-- BADGES -->
![Build Status](https://img.shields.io/github/actions/workflow/status/firebase/firebase-js-sdk/test-all.yml)
Expand Down
2 changes: 1 addition & 1 deletion config/api-extractor.json
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@
*/
"default": {
/**
* Specifies whether the message should be written to the the tool's output log. Note that
* Specifies whether the message should be written to the tool's output log. Note that
* the "addToApiReportFile" property may supersede this option.
*
* Possible values: "error", "warning", "none"
Expand Down
2 changes: 1 addition & 1 deletion config/karma.saucelabs.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ function getPackageLabels() {

/**
* Gets a list of file patterns for test, defined individually
* in karma.conf.js in each package under worksapce packages or
* in karma.conf.js in each package under workspace packages or
* integration.
*/
function getTestFiles() {
Expand Down
10 changes: 5 additions & 5 deletions docs-devsite/auth.githubauthprovider.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export declare class GithubAuthProvider extends BaseOAuthProvider
| Method | Modifiers | Description |
| --- | --- | --- |
| [credential(accessToken)](./auth.githubauthprovider.md#githubauthprovidercredential) | <code>static</code> | Creates a credential for Github. |
| [credential(accessToken)](./auth.githubauthprovider.md#githubauthprovidercredential) | <code>static</code> | Creates a credential for GitHub. |
| [credentialFromError(error)](./auth.githubauthprovider.md#githubauthprovidercredentialfromerror) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md#oauthcredential_class) from a [AuthError](./auth.autherror.md#autherror_interface) which was thrown during a sign-in, link, or reauthenticate operation. |
| [credentialFromResult(userCredential)](./auth.githubauthprovider.md#githubauthprovidercredentialfromresult) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md#oauthcredential_class) from a [UserCredential](./auth.usercredential.md#usercredential_interface)<!-- -->. |
Expand Down Expand Up @@ -74,7 +74,7 @@ static readonly PROVIDER_ID: 'github.com';
## GithubAuthProvider.credential()
Creates a credential for Github.
Creates a credential for GitHub.
<b>Signature:</b>
Expand All @@ -86,7 +86,7 @@ static credential(accessToken: string): OAuthCredential;
| Parameter | Type | Description |
| --- | --- | --- |
| accessToken | string | Github access token. |
| accessToken | string | GitHub access token. |
<b>Returns:</b>
Expand Down Expand Up @@ -148,7 +148,7 @@ const result = await getRedirectResult(auth);
if (result) {
// This is the signed-in user
const user = result.user;
// This gives you a Github Access Token.
// This gives you a GitHub Access Token.
const credential = GithubAuthProvider.credentialFromResult(result);
const token = credential.accessToken;
}
Expand All @@ -166,7 +166,7 @@ const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Github Access Token.
// This gives you a GitHub Access Token.
const credential = GithubAuthProvider.credentialFromResult(result);
const token = credential.accessToken;

Expand Down
4 changes: 2 additions & 2 deletions docs-devsite/database.datasnapshot.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export declare class DataSnapshot
| [child(path)](./database.datasnapshot.md#datasnapshotchild) | | Gets another <code>DataSnapshot</code> for the location at the specified relative path.<!-- -->Passing a relative path to the <code>child()</code> method of a DataSnapshot returns another <code>DataSnapshot</code> for the location at the specified relative path. The relative path can either be a simple child name (for example, "ada") or a deeper, slash-separated path (for example, "ada/name/first"). If the child location has no data, an empty <code>DataSnapshot</code> (that is, a <code>DataSnapshot</code> whose value is <code>null</code>) is returned. |
| [exists()](./database.datasnapshot.md#datasnapshotexists) | | Returns true if this <code>DataSnapshot</code> contains any data. It is slightly more efficient than using <code>snapshot.val() !== null</code>. |
| [exportVal()](./database.datasnapshot.md#datasnapshotexportval) | | Exports the entire contents of the DataSnapshot as a JavaScript object.<!-- -->The <code>exportVal()</code> method is similar to <code>val()</code>, except priority information is included (if available), making it suitable for backing up your data. |
| [forEach(action)](./database.datasnapshot.md#datasnapshotforeach) | | Enumerates the top-level children in the <code>IteratedDataSnapshot</code>.<!-- -->Because of the way JavaScript objects work, the ordering of data in the JavaScript object returned by <code>val()</code> is not guaranteed to match the ordering on the server nor the ordering of <code>onChildAdded()</code> events. That is where <code>forEach()</code> comes in handy. It guarantees the children of a <code>DataSnapshot</code> will be iterated in their query order.<!-- -->If no explicit <code>orderBy*()</code> method is used, results are returned ordered by key (unless priorities are used, in which case, results are returned by priority). |
| [forEach(action)](./database.datasnapshot.md#datasnapshotforeach) | | Enumerates the top-level children in the <code>IteratedDataSnapshot</code>.<!-- -->Because of the way JavaScript objects work, the ordering of data in the JavaScript object returned by <code>val()</code> is neither guaranteed to match the ordering on the server nor the ordering of <code>onChildAdded()</code> events. That is where <code>forEach()</code> comes in handy. It guarantees the children of a <code>DataSnapshot</code> will be iterated in their query order.<!-- -->If no explicit <code>orderBy*()</code> method is used, results are returned ordered by key (unless priorities are used, in which case, results are returned by priority). |
| [hasChild(path)](./database.datasnapshot.md#datasnapshothaschild) | | Returns true if the specified child path has (non-null) data. |
| [hasChildren()](./database.datasnapshot.md#datasnapshothaschildren) | | Returns whether or not the <code>DataSnapshot</code> has any non-<code>null</code> child properties.<!-- -->You can use <code>hasChildren()</code> to determine if a <code>DataSnapshot</code> has any children. If it does, you can enumerate them using <code>forEach()</code>. If it doesn't, then either this snapshot contains a primitive value (which can be retrieved with <code>val()</code>) or it is empty (in which case, <code>val()</code> will return <code>null</code>). |
| [toJSON()](./database.datasnapshot.md#datasnapshottojson) | | Returns a JSON-serializable representation of this object. |
Expand Down Expand Up @@ -144,7 +144,7 @@ The DataSnapshot's contents as a JavaScript value (Object, Array, string, number

Enumerates the top-level children in the `IteratedDataSnapshot`<!-- -->.

Because of the way JavaScript objects work, the ordering of data in the JavaScript object returned by `val()` is not guaranteed to match the ordering on the server nor the ordering of `onChildAdded()` events. That is where `forEach()` comes in handy. It guarantees the children of a `DataSnapshot` will be iterated in their query order.
Because of the way JavaScript objects work, the ordering of data in the JavaScript object returned by `val()` is neither guaranteed to match the ordering on the server nor the ordering of `onChildAdded()` events. That is where `forEach()` comes in handy. It guarantees the children of a `DataSnapshot` will be iterated in their query order.

If no explicit `orderBy*()` method is used, results are returned ordered by key (unless priorities are used, in which case, results are returned by priority).

Expand Down
4 changes: 2 additions & 2 deletions docs-devsite/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Firebase Realtime Database
| Function | Description |
| --- | --- |
| <b>function(app, ...)</b> |
| [getDatabase(app, url)](./database.md#getdatabase_d9cea01) | Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with with default settings if no instance exists or if the existing instance uses a custom database URL. |
| [getDatabase(app, url)](./database.md#getdatabase_d9cea01) | Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with default settings if no instance exists or if the existing instance uses a custom database URL. |
| <b>function(db, ...)</b> |
| [connectDatabaseEmulator(db, host, port, options)](./database.md#connectdatabaseemulator_27b9e93) | Modify the provided instance to communicate with the Realtime Database emulator.<p>Note: This method must be called before performing any other operation. |
| [goOffline(db)](./database.md#gooffline_732b338) | Disconnects from the server (all Database operations will be completed offline).<!-- -->The client automatically maintains a persistent connection to the Database server, which will remain active indefinitely and reconnect when disconnected. However, the <code>goOffline()</code> and <code>goOnline()</code> methods may be used to control the client connection in cases where a persistent connection is undesirable.<!-- -->While offline, the client will no longer receive data updates from the Database. However, all Database operations performed locally will continue to immediately fire events, allowing your application to continue behaving normally. Additionally, each operation performed locally will automatically be queued and retried upon reconnection to the Database server.<!-- -->To reconnect to the Database and begin receiving remote events, see <code>goOnline()</code>. |
Expand Down Expand Up @@ -112,7 +112,7 @@ Firebase Realtime Database

### getDatabase(app, url) {:#getdatabase_d9cea01}

Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with with default settings if no instance exists or if the existing instance uses a custom database URL.
Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with default settings if no instance exists or if the existing instance uses a custom database URL.

<b>Signature:</b>

Expand Down
Loading

0 comments on commit b227b95

Please sign in to comment.