docs: document server utils

Author: farnabaz

docs/content/docs/4.utils/.navigation.yml

@@ -1,2 +1,2 @@
 icon: i-lucide-square-function
-title: Vue Utils
+title: Query Utils

docs/content/docs/4.utils/1.query-collection.md

@@ -8,9 +8,9 @@ description: The queryCollection composable provides methods for querying and
 
 Use the auto-imported `queryCollection` to find contents inside a collection. Here we assume that you have defined `docs` collection inside `content.config.ts`.
 
-::note
+
 If you have not defined any collection, check [How to define a collection](/docs/collections/define#defining-collections).
-::
+
 
 ```vue [pages/[...slug\\].vue]
 <script>
@@ -21,6 +21,10 @@ const { data: page } = await useAsyncData(route.path, () => {
 </script>
 ```
 
+::tip
+The `queryCollection` utility is available in both Vue and Nitro. Checkout [Server Usage](#server-usage) for more details on how to use it on the server side.
+::
+
 ## API
 
 ### Type
@@ -238,3 +242,26 @@ const { data: docs } = await useAsyncData('documents-list', () => {
   </NuxtLink>
 </template>
 ```
+
+## Server Usage
+
+Nuxt Content provides a similar utility to query collections on the server side. The only difference is that you need to pass `event` as the first argument to the `queryCollection` function.
+
+```ts [server/api/[slug\\].ts]
+export default eventHandler(async (event) => {
+  const { slug } = getRouterParams(event)
+  const page = await queryCollection(event, 'docs').path(slug).first()
+  return page
+})
+```
+
+:::note
+Make sure to create `server/tsconfig.json` file with the following content to avoid type error.
+
+```json
+{
+  "extends": "../.nuxt/tsconfig.server.json"
+}
+```
+:::
+

docs/content/docs/4.utils/2.query-collection-navigation.md

@@ -36,6 +36,10 @@ const { data } = await useAsyncData('navigation', () => {
 </script>
 ```
 
+::tip
+The `queryCollectionNavigation` utility is available in both Vue and Nitro. Checkout [Server Usage](#server-usage) for more details on how to use it on the server side.
+::
+
 ## API
 
 ### `queryCollectionNavigation(collection: CollectionName, extraField: keyof Collection)`
@@ -101,3 +105,26 @@ const { data } = await useAsyncData('navigation', () => {
   </nav>
 </template>
 ```
+
+
+## Server Usage
+
+Nuxt Content provides a similar utility to query collections on the server side. The only difference is that you need to pass `event` as the first argument to the `queryCollectionNavigation` function.
+
+```ts [server/api/navigation.ts]
+export default eventHandler(async (event) => {
+  const navigation = await queryCollectionNavigation(event, 'docs')
+  return navigation
+})
+```
+
+:::note
+Make sure to create `server/tsconfig.json` file with the following content to avoid type error.
+
+```json
+{
+  "extends": "../.nuxt/tsconfig.server.json"
+}
+```
+:::
+

docs/content/docs/4.utils/3.query-collection-item-surroundings.md

@@ -37,6 +37,11 @@ const { data } = await useAsyncData('surround', () => {
 </script>
 ```
 
+::tip
+The `queryCollectionItemSurroundings` utility is available in both Vue and Nitro. Checkout [Server Usage](#server-usage) for more details on how to use it on the server side.
+::
+
+
 ## API
 
 ### `queryCollectionItemSurroundings(collection: CollectionName, path: string, opts?: SurroundOptions)`
@@ -102,3 +107,27 @@ const { data } = await useAsyncData('surround', () => {
 })
 </script>
 ```
+
+
+
+## Server Usage
+
+Nuxt Content provides a similar utility to query collections on the server side. The only difference is that you need to pass `event` as the first argument to the `queryCollectionItemSurroundings` function.
+
+```ts [server/api/surroundings.ts]
+export default eventHandler(async (event) => {
+  const surroundings = await queryCollectionItemSurroundings(event, 'docs', '/foo')
+  return surroundings
+})
+```
+
+:::note
+Make sure to create `server/tsconfig.json` file with the following content to avoid type error.
+
+```json
+{
+  "extends": "../.nuxt/tsconfig.server.json"
+}
+```
+:::
+

docs/content/docs/4.utils/4.query-collection-search-sections.md

@@ -7,7 +7,14 @@ description: The queryCollectionSearchSections composable generates searchable
 ## Type
 
 ```ts
-function queryCollectionSearchSections(collection: keyof Collections, opts?: { ignoredTags: string[] }): Promise<Section[]>
+function queryCollectionSearchSections(collection: keyof Collections, opts?: { ignoredTags: string[] }): ChainablePromise<T, Section[]>
+
+interface ChainablePromise<T extends keyof PageCollections, R> extends Promise<R> {
+  where(field: keyof PageCollections[T] | string, operator: SQLOperator, value?: unknown): ChainablePromise<T, R>
+  andWhere(groupFactory: QueryGroupFunction<PageCollections[T]>): ChainablePromise<T, R>
+  orWhere(groupFactory: QueryGroupFunction<PageCollections[T]>): ChainablePromise<T, R>
+  order(field: keyof PageCollections[T], direction: 'ASC' | 'DESC'): ChainablePromise<T, R>
+}
 ```
 
 ## Usage
@@ -22,6 +29,11 @@ const { data: sections } = await useAsyncData('search-sections', () => {
 </script>
 ```
 
+::tip
+The `queryCollectionSearchSections` utility is available in both Vue and Nitro. Checkout [Server Usage](#server-usage) for more details on how to use it on the server side.
+::
+
+
 ## API
 
 ### `queryCollectionSearchSections(collection: CollectionName, options?: SearchSectionsOptions)`
@@ -52,3 +64,25 @@ const { data: surround } = await useAsyncData('foo-surround', () => {
 })
 </script>
 ```
+
+## Server Usage
+
+Nuxt Content provides a similar utility to query collections on the server side. The only difference is that you need to pass `event` as the first argument to the `queryCollectionSearchSections` function.
+
+```ts [server/api/search-sections.ts]
+export default eventHandler(async (event) => {
+  const sections = await queryCollectionSearchSections(event, 'docs')
+  return sections
+})
+```
+
+:::note
+Make sure to create `server/tsconfig.json` file with the following content to avoid type error.
+
+```json
+{
+  "extends": "../.nuxt/tsconfig.server.json"
+}
+```
+:::
+