API Reference

Type Aliases

Adapter

Adapter: object

Defined in: types/index.ts:63

A domco adapter that configures the build to a target production environment.

Type declaration

devMiddleware?

optional devMiddleware: AdapterMiddleware[]

Middleware to apply in dev mode.

entry

entry: AdapterEntry

Entry point for the server application.

message

message: string

Message to log when the build is complete.

name

name: string

The name of the adapter.

noExternal?

optional noExternal: SSROptions["noExternal"]

Passed into Vite config.ssr.noExternal.

previewMiddleware?

optional previewMiddleware: AdapterMiddleware[]

Middleware to apply in preview mode.

run()?

optional run: () => any

The script to run after Vite build is complete.

Returns

any

target?

optional target: SSRTarget

Passed into Vite config.ssr.target.

AdapterBuilder()<AdapterOptions>

AdapterBuilder<AdapterOptions>: (AdapterOptions?) => MaybePromise<Adapter>

Defined in: types/index.ts:93

Use this type to create your own adapter. Pass any options for the adapter in as a generic.

Type Parameters

• AdapterOptions = never

Parameters

AdapterOptions?

AdapterOptions

Returns

MaybePromise<Adapter>

AdapterEntry()

AdapterEntry: (AdapterEntryOptions) => object

Defined in: types/index.ts:47

A function that returns an additional entry point to include in the SSR build.

Parameters

AdapterEntryOptions

funcId

string

The function entry point to import handler from.

Returns

object

code

code: string

Code for the entry point.

id

id: string

The name of the entry point without extension.

Example

"main";

AdapterMiddleware

AdapterMiddleware: Connect.NextHandleFunction

Defined in: types/index.ts:44

Middleware used in the Vite server for dev and preview.

DomcoConfig

DomcoConfig: object

Defined in: types/index.ts:119

domco Config

Use if you want to create a separate object for your domco config. Pass the config into the domco vite plugin.

Type declaration

adapter?

optional adapter: ReturnType<AdapterBuilder>

domco adapter.

Defaults to undefined - creates a func build only.

Default

undefined;

Example

import { adapter } from `"domco/adapter/...";`

Example

// vite.config.ts
import { domco, type DomcoConfig } from "domco";
import { defineConfig } from "vite";

const config: DomcoConfig = {
	// options...
};

export default defineConfig({
	plugins: [domco(config)],
});

FuncModule

FuncModule: object

Defined in: types/index.ts:7

Exports from the SSR +func entry point.

Type declaration

handler

handler: Handler

prerender

prerender: Prerender

Handler()

Handler: (req) => MaybePromise<Response>

Defined in: types/index.ts:24

Request handler, takes a web request and returns a web response.

// src/server/+func.ts
import type { Handler } from "domco";

export const handler: Handler = async (req) => {
	return new Response("Hello world");
};

Parameters

req

Request

Returns

MaybePromise<Response>

MaybePromise<T>

MaybePromise<T>: T | Promise<T>

Defined in: types/index.ts:4

Helper type for a type that could be a promise.

Type Parameters

• T

Prerender

Prerender: string[] | Set<string> | () => MaybePromise<string[] | Set<string>>

Defined in: types/index.ts:38

Paths to prerender at build time.

Example

// src/server/+func.ts
import type { Prerender } from "domco";

export const prerender: Prerender = ["/", "/post-1", "/post-2"];

Functions

domco()

domco(domcoConfig): Promise<Plugin[]>

Defined in: plugin/index.ts:30

Creates domco Vite plugin, add to your plugins array within your vite.config to start using domco.

Parameters

domcoConfig

DomcoConfig = {}

Your domco config object.

Returns

Promise<Plugin[]>

The domco Vite plugin.

Example

// vite.config.ts
import { domco } from "domco";
import { defineConfig } from "vite";

export default defineConfig({
	plugins: [domco()],
});