UNPKG

voluptasmollitia

Version:
28 lines (16 loc) 947 B
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [namedQuery](./firestore_.namedquery.md) ## namedQuery() function Reads a Firestore `Query` from local cache, identified by the given name. The named queries are packaged into bundles on the server side (along with resulting documents), and loaded to local cache using `loadBundle`<!-- -->. Once in local cache, use this method to extract a `Query` by name. <b>Signature:</b> ```typescript export declare function namedQuery(firestore: FirebaseFirestore, name: string): Promise<Query | null>; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | firestore | [FirebaseFirestore](./firestore_.firebasefirestore.md) | | | name | string | | <b>Returns:</b> Promise&lt;[Query](./firestore_.query.md) \| null&gt;