voluptasmollitia
Version:
Monorepo for the Firebase JavaScript SDK
32 lines (18 loc) • 1.64 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@firebase/database](./database.md) > [startAt](./database.startat.md)
## startAt() function
Creates a `QueryConstraint` with the specified starting point.
Using `startAt()`<!-- -->, `startAfter()`<!-- -->, `endBefore()`<!-- -->, `endAt()` and `equalTo()` allows you to choose arbitrary starting and ending points for your queries.
The starting point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name greater than or equal to the specified key.
You can read more about `startAt()` in [Filtering data](https://firebase.google.com/docs/database/web/lists-of-data#filtering_data)<!-- -->.
<b>Signature:</b>
```typescript
export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| value | number \| string \| boolean \| null | The value to start at. The argument type depends on which <code>orderBy*()</code> function was used in this query. Specify a value that matches the <code>orderBy*()</code> type. When used in combination with <code>orderByKey()</code>, the value must be a string. |
| key | string | The child key to start at. This argument is only allowed if ordering by child, value, or priority. |
<b>Returns:</b>
[QueryConstraint](./database.queryconstraint.md)