> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bijection.com/llms.txt
> Use this file to discover all available pages before exploring further.

# server.js

> Generated utilities for implementing Bijection queries, mutations, and actions

<Warning>
  **This code is generated**

  These exports are not directly available in the `bijection` package!

  Instead you must run `bijection dev` to create `bijection/_generated/server.js`
  and `bijection/_generated/server.d.ts`.
</Warning>

Generated utilities for implementing server-side Bijection query and mutation
functions.

## Functions

### query

▸ **query**(`func`): [`RegisteredQuery`](/api/modules/server#registeredquery)

Define a query in this Bijection app's public API.

This function will be allowed to read your Bijection database and will be
accessible from the client.

This is an alias of [`queryGeneric`](/api/modules/server#querygeneric) that is
typed for your app's data model.

#### Parameters

| Name | Description |
| :- | :- |
| `func` | The query function. It receives a [QueryCtx](/generated-api/server#queryctx) as its first argument. |

#### Returns

[`RegisteredQuery`](/api/modules/server#registeredquery)

The wrapped query. Include this as an `export` to name it and make it
accessible.

***

### internalQuery

▸ **internalQuery**(`func`):
[`RegisteredQuery`](/api/modules/server#registeredquery)

Define a query that is only accessible from other Bijection functions (but not from
the client).

This function will be allowed to read from your Bijection database. It will not be
accessible from the client.

This is an alias of
[`internalQueryGeneric`](/api/modules/server#internalquerygeneric) that is typed
for your app's data model.

#### Parameters

| Name | Description |
| :- | :- |
| `func` | The query function. It receives a [QueryCtx](/generated-api/server#queryctx) as its first argument. |

#### Returns

[`RegisteredQuery`](/api/modules/server#registeredquery)

The wrapped query. Include this as an `export` to name it and make it
accessible.

***

### mutation

▸ **mutation**(`func`):
[`RegisteredMutation`](/api/modules/server#registeredmutation)

Define a mutation in this Bijection app's public API.

This function will be allowed to modify your Bijection database and will be
accessible from the client.

This is an alias of [`mutationGeneric`](/api/modules/server#mutationgeneric)
that is typed for your app's data model.

#### Parameters

| Name | Description |
| :- | :- |
| `func` | The mutation function. It receives a [MutationCtx](#mutationctx) as its first argument. |

#### Returns

[`RegisteredMutation`](/api/modules/server#registeredmutation)

The wrapped mutation. Include this as an `export` to name it and make it
accessible.

***

### internalMutation

▸ **internalMutation**(`func`):
[`RegisteredMutation`](/api/modules/server#registeredmutation)

Define a mutation that is only accessible from other Bijection functions (but not
from the client).

This function will be allowed to read and write from your Bijection database. It
will not be accessible from the client.

This is an alias of
[`internalMutationGeneric`](/api/modules/server#internalmutationgeneric) that is
typed for your app's data model.

#### Parameters

| Name | Description |
| :- | :- |
| `func` | The mutation function. It receives a [MutationCtx](/generated-api/server#mutationctx) as its first argument. |

#### Returns

[`RegisteredMutation`](/api/modules/server#registeredmutation)

The wrapped mutation. Include this as an `export` to name it and make it
accessible.

***

### action

▸ **action**(`func`): [`RegisteredAction`](/api/modules/server#registeredaction)

Define an action in this Bijection app's public API.

An action is a function which can execute any JavaScript code, including
non-deterministic code and code with side-effects, like calling third-party
services. They can be run in Bijection's JavaScript environment or in Node.js using
the `"use node"` directive. They can interact with the database indirectly by
calling queries and mutations using the [`ActionCtx`](#actionctx).

This is an alias of [`actionGeneric`](/api/modules/server#actiongeneric) that is
typed for your app's data model.

#### Parameters

| Name | Description |
| :- | :- |
| `func` | The action function. It receives an [ActionCtx](#actionctx) as its first argument. |

#### Returns

[`RegisteredAction`](/api/modules/server#registeredaction)

The wrapped function. Include this as an `export` to name it and make it
accessible.

***

### internalAction

▸ **internalAction**(`func`):
[`RegisteredAction`](/api/modules/server#registeredaction)

Define an action that is only accessible from other Bijection functions (but not
from the client).

This is an alias of
[`internalActionGeneric`](/api/modules/server#internalactiongeneric) that is
typed for your app's data model.

#### Parameters

| Name | Description |
| :- | :- |
| `func` | The action function. It receives an [ActionCtx](#actionctx) as its first argument. |

#### Returns

[`RegisteredAction`](/api/modules/server#registeredaction)

The wrapped action. Include this as an `export` to name it and make it
accessible.

***

### httpAction

▸
**httpAction**(`func: (ctx: ActionCtx, request: Request) => Promise<Response>`):
[`PublicHttpAction`](/api/modules/server#publichttpaction)

#### Parameters

| Name | Type | Description |
| :- | :- | :- |
| `func` | `(ctx: ActionCtx, request: Request) => Promise<Response>` | The function. It receives an [`ActionCtx`](#actionctx) as its first argument and a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request) as its second argument. |

#### Returns

[`PublicHttpAction`](/api/modules/server#publichttpaction)

The wrapped function. Import this function from `bijection/http.js` and route it to
hook it up.

## Types

### QueryCtx

Ƭ **QueryCtx**: `Object`

A set of services for use within Bijection query functions.

The query context is passed as the first argument to any Bijection query function
run on the server.

This differs from the [MutationCtx](#mutationctx) because all of the services
are read-only.

This is an alias of [`GenericQueryCtx`](/api/interfaces/server.GenericQueryCtx)
that is typed for your app's data model.

#### Type declaration

| Name | Type |
| :- | :- |
| `db` | [`DatabaseReader`](#databasereader) |
| `auth` | [`Auth`](/api/interfaces/server.Auth) |
| `storage` | [`StorageReader`](/api/interfaces/server.StorageReader) |

***

### MutationCtx

Ƭ **MutationCtx**: `Object`

A set of services for use within Bijection mutation functions.

The mutation context is passed as the first argument to any Bijection mutation
function run on the server.

This is an alias of
[`GenericMutationCtx`](/api/interfaces/server.GenericMutationCtx) that is typed
for your app's data model.

#### Type declaration

| Name | Type |
| :- | :- |
| `db` | [`DatabaseWriter`](#databasewriter) |
| `auth` | [`Auth`](/api/interfaces/server.Auth) |
| `storage` | [`StorageWriter`](/api/interfaces/server.StorageWriter) |
| `scheduler` | [`Scheduler`](/api/interfaces/server.Scheduler) |

***

### ActionCtx

Ƭ **ActionCtx**: `Object`

A set of services for use within Bijection action functions.

The action context is passed as the first argument to any Bijection action function
run on the server.

This is an alias of
[`GenericActionCtx`](/api/interfaces/server.GenericActionCtx) that is typed for
your app's data model.

#### Type declaration

| Name | Type |
| :- | :- |
| `runQuery` | (`name`: `string`, `args`?: `Record<string, Value>`) => `Promise<Value>` |
| `runMutation` | (`name`: `string`, `args`?: `Record<string, Value>`) => `Promise<Value>` |
| `runAction` | (`name`: `string`, `args`?: `Record<string, Value>`) => `Promise<Value>` |
| `auth` | [`Auth`](/api/interfaces/server.Auth) |
| `scheduler` | [`Scheduler`](/api/interfaces/server.Scheduler) |
| `storage` | [`StorageActionWriter`](/api/interfaces/server.StorageActionWriter) |
| `vectorSearch` | (`tableName`: `string`, `indexName`: `string`, `query`: [`VectorSearchQuery`](/api/interfaces/server.VectorSearchQuery)) => `Promise<Array<{ _id: Id, _score: number }>>` |

***

### DatabaseReader

An interface to read from the database within Bijection query functions.

This is an alias of
[`GenericDatabaseReader`](/api/interfaces/server.GenericDatabaseReader) that is
typed for your app's data model.

***

### DatabaseWriter

An interface to read from and write to the database within Bijection mutation
functions.

This is an alias of
[`GenericDatabaseWriter`](/api/interfaces/server.GenericDatabaseWriter) that is
typed for your app's data model.