Module

jinks/server

src/jinks/server.pooka

A preview is a reader of generated output. It does not mount the source tree, and its reload client is added to HTTP responses rather than saved in production pages. The transport knows sockets; this module knows pages.

API reference

class

Handle

src/jinks/server.pooka:18
class Handle
class

Running

src/jinks/server.pooka:20
class Running(
  handle: Handle,
  port: Int,
  output: String,
  live: Bool,
  mount: String
)
field

handle

src/jinks/server.pooka:21
handle: Handle
field

port

src/jinks/server.pooka:22
port: Int
INFERREDInt
field

output

src/jinks/server.pooka:23
output: String
INFERREDString
field

live

src/jinks/server.pooka:24
live: Bool
INFERREDBool
field

mount

src/jinks/server.pooka:25
mount: String
INFERREDString
constructor

new

src/jinks/server.pooka:21
INFERREDfn(jinks/server.Handle, Int, String, Bool, String) -> jinks/server.Running
class

Response

src/jinks/server.pooka:28
class Response(status: Int, content_type: String, body: BitArray)
field

status

src/jinks/server.pooka:28
status: Int
INFERREDInt
field

content_type

src/jinks/server.pooka:28
content_type: String
INFERREDString
field

body

src/jinks/server.pooka:28
body: BitArray
INFERREDBitArray
constructor

new

src/jinks/server.pooka:28
INFERREDfn(Int, String, BitArray) -> jinks/server.Response
function

start

src/jinks/server.pooka:51
start(output: String, host: String, port: Int, live: Bool) -> Result(
  Running,
  String
)
INFERREDfn(String, String, Int, Bool) -> Result(jinks/server.Running, String)

Port zero asks the OS for a free port, useful for independent server tests.

function

start_site

src/jinks/server.pooka:60
start_site(
  output: String,
  host: String,
  port: Int,
  live: Bool,
  base_url: String
) -> Result(Running, String)
INFERREDfn(String, String, Int, Bool, String) -> Result(jinks/server.Running, String)

Preview a base-path deployment at the same path it uses on its static host. The mount is decoded once alongside request paths, never as a file root.

function

mount

src/jinks/server.pooka:70
mount(base_url: String) -> Result(String, String)
INFERREDfn(String) -> Result(String, String)
function

mount_url

src/jinks/server.pooka:81
mount_url(mount: String) -> String
INFERREDfn(String) -> String
function

start_mounted

src/jinks/server.pooka:91
start_mounted(
  output: String,
  host: String,
  port: Int,
  live: Bool,
  mount: String
) -> Result(Running, String)
INFERREDfn(String, String, Int, Bool, String) -> Result(jinks/server.Running, String)
function

handler

src/jinks/server.pooka:120
handler(output: String, live: Bool) -> fn(String, String, String) -> #(
  Int,
  String,
  BitArray
)
INFERREDfn(String, Bool) -> fn(String, String, String) -> #(Int, String, BitArray)
function

handler_at

src/jinks/server.pooka:128
handler_at(output: String, live: Bool, mount: String) -> fn(
  String,
  String,
  String
) -> #(Int, String, BitArray)
INFERREDfn(String, Bool, String) -> fn(String, String, String) -> #(Int, String, BitArray)
function

stop

src/jinks/server.pooka:146
stop(server: Running) -> Result(Nil, String)
INFERREDfn(jinks/server.Running) -> Result(Nil, String)
function

alive

src/jinks/server.pooka:150
alive(server: Running) -> Bool
INFERREDfn(jinks/server.Running) -> Bool
function

retarget

src/jinks/server.pooka:155
retarget(server: Running, output: String) -> Result(Running, String)
INFERREDfn(jinks/server.Running, String) -> Result(jinks/server.Running, String)

Retarget only after a successful build if config.toml changes output-dir.

function

retarget_site

src/jinks/server.pooka:159
retarget_site(server: Running, output: String, base_url: String) -> Result(
  Running,
  String
)
INFERREDfn(jinks/server.Running, String, String) -> Result(jinks/server.Running, String)
function

retarget_mounted

src/jinks/server.pooka:166
retarget_mounted(server: Running, output: String, mount: String) -> Result(
  Running,
  String
)
INFERREDfn(jinks/server.Running, String, String) -> Result(jinks/server.Running, String)
function

notify

src/jinks/server.pooka:179
notify(server: Running, revision: Int, problem: String) -> Result(Nil, String)
INFERREDfn(jinks/server.Running, Int, String) -> Result(Nil, String)
function

notify_styles

src/jinks/server.pooka:185
notify_styles(
  server: Running,
  revision: Int,
  problem: String,
  styles_only: Bool
) -> Result(Nil, String)
INFERREDfn(jinks/server.Running, Int, String, Bool) -> Result(Nil, String)

CSS-only events may replace stylesheet links. All other edits, missed revisions and failed loads keep the ordinary full-page reload behaviour.

function

relative

src/jinks/server.pooka:200
relative(target: String) -> Result(String, String)
INFERREDfn(String) -> Result(String, String)

Decode once, then reject dot segments, backslashes, control characters and hidden files. Query strings never become part of a filename.

function

text

src/jinks/server.pooka:226
text(status: Int, body: String) -> Response
INFERREDfn(Int, String) -> jinks/server.Response
function

respond

src/jinks/server.pooka:230
respond(
  output: String,
  live: Bool,
  method: String,
  target: String,
  revision: Int
) -> Response
INFERREDfn(String, Bool, String, String, Int) -> jinks/server.Response
function

respond_at

src/jinks/server.pooka:240
respond_at(
  output: String,
  live: Bool,
  method: String,
  target: String,
  revision: Int,
  mount: String
) -> Response
INFERREDfn(String, Bool, String, String, Int, String) -> jinks/server.Response
function

unmount

src/jinks/server.pooka:292
unmount(name: String, mount: String) -> Option(String)
INFERREDfn(String, String) -> Option(String)

A prefix must end at a segment boundary: /blog never matches /blogger.

function

read

src/jinks/server.pooka:303
read(output: String, name: String, live: Bool, revision: Int) -> Result(
  Response,
  String
)
INFERREDfn(String, String, Bool, Int) -> Result(jinks/server.Response, String)
function

mime

src/jinks/server.pooka:327
mime(name: String) -> String
INFERREDfn(String) -> String
function

client

src/jinks/server.pooka:352
client() -> String
INFERREDfn() -> String

Errors use textContent, so a template diagnostic cannot become browser HTML.