Class CellDevServer

cell dev on one port (docs/design/architecture.md §6): Vite serves the frontend with HMR, and the backend runs in the server environment's module runner. Its entry hands the request handler over through ApplicationHost instead of listening; when one of its files changes, the old application is stopped, the runner forgets every module and the entry is imported again.

Index

Constructors

constructor

new CellDevServer(options?: CellDevServerOptions): CellDevServer
Parameters
- options: CellDevServerOptions = {}
Returns CellDevServer
- Defined in dev/cell-dev-server.ts:96

Properties

`Protected` `Optional`backend

backend?: StartedApplication

`Protected` `Optional`backendError

backendError?: any

`Protected`closed

closed: boolean = false

`Protected`loading

loading: Promise<void> = ...

`Protected` `Readonly`options

options: CellDevServerOptions = {}

`Protected`pending

pending: Set<string> = ...

`Protected`plugin

plugin: CellPlugin

`Protected` `Optional`timer

timer?: Timeout

`Protected`vite

vite: ViteDevServer

`Static` `Readonly`CONFIG_FILE

CONFIG_FILE: RegExp = ...

`Static` `Readonly`CONTENT_TYPES

CONTENT_TYPES: Record<string, string> = ...

`Static` `Readonly`DEFAULT_HOST

DEFAULT_HOST: "127.0.0.1" = '127.0.0.1'

`Static` `Readonly`DEFAULT_PORT

DEFAULT_PORT: 3000

Accessors

address

get address(): { host: string; port: number }
Returns { host: string; port: number }
- Defined in dev/cell-dev-server.ts:107

application

get application(): StartedApplication | undefined
The running backend: its DI container and request handler.

Returns StartedApplication | undefined
- Defined in dev/cell-dev-server.ts:117

configFiles

get configFiles(): string[]
Files whose change makes a new project model: the component's cell*.yml and package.json, and the project's cell.config.*.

Returns string[]
- Defined in dev/cell-dev-server.ts:179

error

get error(): any
The last error of the backend, until it starts again.

Returns any
- Defined in dev/cell-dev-server.ts:122

handler

get handler(): (req: IncomingMessage, res: ServerResponse) => void
Every request handler of the server in one: Vite, the frontend page, module handlers, the backend.

Returns (req: IncomingMessage, res: ServerResponse) => void
- Defined in dev/cell-dev-server.ts:166

project

get project(): ProjectModel
Returns ProjectModel
- Defined in dev/cell-dev-server.ts:98

`Protected`serverEnvironment

get serverEnvironment(): DevEnvironment & {
runner: { clearCache(): void; import(url: string): Promise<unknown> };
}
Returns DevEnvironment & {
runner: { clearCache(): void; import(url: string): Promise<unknown> };
}
- Defined in dev/cell-dev-server.ts:206

url

get url(): string
Returns string
- Defined in dev/cell-dev-server.ts:102

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in dev/cell-dev-server.ts:170

`Protected`devPlugin

devPlugin(): Plugin
Returns Plugin
- Defined in dev/cell-dev-server.ts:275

`Protected`handle

handle(
    req: IncomingMessage,
    res: ServerResponse,
    next: (error?: unknown) => void,
): Promise<void>
Parameters
- req: IncomingMessage
- res: ServerResponse
- next: (error?: unknown) => void
Returns Promise<void>
- Defined in dev/cell-dev-server.ts:305

import

import<T = Record<string, unknown>>(specifier: string): Promise<T>
Imports a module into the backend's module runner (with the generated container and configuration).
Type Parameters
- T = Record<string, unknown>
Parameters
- specifier: string
Returns Promise<T>
- Defined in dev/cell-dev-server.ts:161

`Protected`importBackend

importBackend(): Promise<StartedApplication>
Returns Promise<StartedApplication>
- Defined in dev/cell-dev-server.ts:212

`Protected`listenOptions

listenOptions(): { host: string; port: number }
Returns { host: string; port: number }
- Defined in dev/cell-dev-server.ts:291

`Protected`onFileChange

onFileChange(event: string, file: string): void
Parameters
- event: string
- file: string
Returns void
- Defined in dev/cell-dev-server.ts:249

`Protected`record

record(req: IncomingMessage, res: ServerResponse): void
Parameters
- req: IncomingMessage
- res: ServerResponse
Returns void
- Defined in dev/cell-dev-server.ts:346

reload

reload(files: string[]): Promise<void>
Stops the running backend and starts it again from fresh modules.
Parameters
- files: string[]
Returns Promise<void>
- Defined in dev/cell-dev-server.ts:184

start

start(): Promise<CellDevServer>
Returns Promise<CellDevServer>
- Defined in dev/cell-dev-server.ts:126

`Protected`stopBackend

stopBackend(): Promise<void>
Returns Promise<void>
- Defined in dev/cell-dev-server.ts:239

`Static`toCellError

toCellError(error: unknown, code: string): CellError
Parameters
- error: unknown
- code: string
Returns CellError
- Defined in dev/cell-dev-server.ts:364

Class CellDevServer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns CellDevServer

Properties

Protected Optionalbackend

Protected OptionalbackendError

Protectedclosed

Protectedloading

Protected Readonlyoptions

Protectedpending

Protectedplugin

Protected Optionaltimer

Protectedvite

Static ReadonlyCONFIG_FILE

Static ReadonlyCONTENT_TYPES

Static ReadonlyDEFAULT_HOST

Static ReadonlyDEFAULT_PORT

Accessors

address

Returns { host: string; port: number }

application

Returns StartedApplication | undefined

configFiles

Returns string[]

error

Returns any

handler

Returns (req: IncomingMessage, res: ServerResponse) => void

project

Returns ProjectModel

ProtectedserverEnvironment

Returns DevEnvironment & { runner: { clearCache(): void; import(url: string): Promise<unknown> };}

url

Returns string

Methods

close

Returns Promise<void>

ProtecteddevPlugin

Returns Plugin

Protectedhandle

Parameters

Returns Promise<void>

import

Type Parameters

Parameters

Returns Promise<T>

ProtectedimportBackend

Returns Promise<StartedApplication>

ProtectedlistenOptions

Returns { host: string; port: number }

ProtectedonFileChange

Parameters

Returns void

Protectedrecord

Parameters

Returns void

reload

Parameters

Returns Promise<void>

start

Returns Promise<CellDevServer>

ProtectedstopBackend

Returns Promise<void>

StatictoCellError

Parameters

Returns CellError

Settings

On This Page

`Protected` `Optional`backend

`Protected` `Optional`backendError

`Protected`closed

`Protected`loading

`Protected` `Readonly`options

`Protected`pending

`Protected`plugin

`Protected` `Optional`timer

`Protected`vite

`Static` `Readonly`CONFIG_FILE

`Static` `Readonly`CONTENT_TYPES

`Static` `Readonly`DEFAULT_HOST

`Static` `Readonly`DEFAULT_PORT

`Protected`serverEnvironment

Returns DevEnvironment & {
runner: { clearCache(): void; import(url: string): Promise<unknown> };
}

`Protected`devPlugin

`Protected`handle

`Protected`importBackend

`Protected`listenOptions

`Protected`onFileChange

`Protected`record

`Protected`stopBackend

`Static`toCellError