API reference
backend-declaration
Import
Section titled “Import”import * as api from "@fungi.computer/agar/backend-declaration";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| function | buildAppApi() | Build-only API projection from the schemas used by runtime calls. |
| function | buildAppDeclaration() | Strict build-only declaration generation; Workers never import this module. |
buildAppApi()function
Section titled “buildAppApi()”function buildAppApi<Context>(backend): AppApi;Build-only API projection from the schemas used by runtime calls.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Context |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
backend |
Pick<AppBackendDefinition<Context>, "methods" | "events" | "toolFamily"> |
Returns
Section titled “Returns”AppApi
buildAppDeclaration()function
Section titled “buildAppDeclaration()”function buildAppDeclaration<Context>(backend, declaration): AppDeclaration;Strict build-only declaration generation; Workers never import this module.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
Context |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
backend |
Pick<AppBackendDefinition<Context>, "methods" | "events" | "gills" | "sync" | "toolFamily"> |
declaration |
unknown |
Returns
Section titled “Returns”AppDeclaration