Module

jinks/request

src/jinks/request.pooka

A build request holds temporary command-line choices. It never rewrites the author's configuration. The selected configuration file is the anchor for every source/output path, even when the command starts elsewhere.

API reference

class

Request

src/jinks/request.pooka:14
class Request(
  root: String,
  file: String,
  output: Option(String),
  base_url: Option(String),
  drafts: Bool,
  future: Bool,
  environment: Option(String),
  providers: List(provider.Provider)
)
field

root

src/jinks/request.pooka:15
root: String
INFERREDString
field

file

src/jinks/request.pooka:16
file: String
INFERREDString
field

output

src/jinks/request.pooka:17
output: Option(String)
INFERREDOption(String)
field

base_url

src/jinks/request.pooka:18
base_url: Option(String)
INFERREDOption(String)
field

drafts

src/jinks/request.pooka:19
drafts: Bool
INFERREDBool
field

future

src/jinks/request.pooka:20
future: Bool
INFERREDBool
field

environment

src/jinks/request.pooka:21
environment: Option(String)
INFERREDOption(String)
field

providers

src/jinks/request.pooka:22
providers: List(provider.Provider)
constructor

new

src/jinks/request.pooka:15
INFERREDfn(String, String, Option(String), Option(String), Bool, Bool, Option(String), List(jinks/provider.Provider)) -> jinks/request.Request
function

defaults

src/jinks/request.pooka:25
defaults(root: String) -> Request
INFERREDfn(String) -> jinks/request.Request
function

select

src/jinks/request.pooka:29
select(
  root: String,
  filename: String,
  output: Option(String),
  base_url: Option(String),
  drafts: Bool,
  future: Bool
) -> Result(Request, String)
INFERREDfn(String, String, Option(String), Option(String), Bool, Bool) -> Result(jinks/request.Request, String)
function

load

src/jinks/request.pooka:55
load(selected: Request) -> Result(config.Config, String)
INFERREDfn(jinks/request.Request) -> Result(jinks/config.Config, String)
function

with_environment

src/jinks/request.pooka:94
with_environment(selected: Request, environment: String) -> Result(
  Request,
  String
)
INFERREDfn(jinks/request.Request, String) -> Result(jinks/request.Request, String)
function

with_providers

src/jinks/request.pooka:115
with_providers(selected: Request, providers: List(provider.Provider)) -> Request