Node overview
Added in v1.0.0
Table of contents
utils
Options (type alias)
Signature
export type Options = {
readonly serverDirectory: string
readonly port?: number
readonly static?: boolean
readonly serveStatic?: boolean
readonly logLevel?: LogLevel.LogLevel
readonly cacheControl?: (filePath: string) => { readonly maxAge: number; readonly immutable?: boolean }
}
Added in v1.0.0
getOrCreateServer
TODO: Allow configuration of the server for HTTPS and HTTP2
Signature
export declare function getOrCreateServer()
Added in v1.0.0
listen
Signature
export declare const listen: {
(
options: Options
): <E, R>(
app: Http.app.Default<E, R>
) => Effect.Effect<
never,
Http.error.ServeError,
Exclude<
R,
| CurrentEnvironment
| GetRandomValues
| RenderTemplate
| Http.request.ServerRequest
| Scope.Scope
| Http.server.Server
| Http.platform.Platform
| Http.etag.Generator
| RenderContext.RenderContext
| RenderQueue.RenderQueue
>
>
<E, R>(
app: Http.app.Default<E, R>,
options: Options
): Effect.Effect<
never,
Http.error.ServeError,
Exclude<
R,
| CurrentEnvironment
| GetRandomValues
| RenderTemplate
| Http.request.ServerRequest
| Scope.Scope
| Http.server.Server
| Http.platform.Platform
| Http.etag.Generator
| RenderContext.RenderContext
| RenderQueue.RenderQueue
>
>
}
Added in v1.0.0
run
Signature
export declare const run: <A, E>(
effect: Effect.Effect<A, E, CurrentEnvironment | NodeContext.NodeContext | CurrentRoute>,
options?: RunForkOptions & { readonly static?: boolean; readonly base?: string }
) => Disposable
Added in v1.0.0