project

Types

pub type Config {
  Config(name: String, version: String, toml: Dict(String, Toml))
}

Config(name: String, version: String, toml: Dict(String, Toml))

</>

pub type Function {
  Function(parameters: List(Type), return: Type)
}

Function(parameters: List(Type), return: Type)

</>

pub type Interface {
  Interface(
    name: String,
    version: String,
    modules: Dict(String, Module),
  )
}

Interface(
  name: String,
  version: String,
  modules: Dict(String, Module),
)

</>

pub type Module {
  Module(
    constants: Dict(String, Type),
    functions: Dict(String, Function),
  )
}

Module(
  constants: Dict(String, Type),
  functions: Dict(String, Function),
)

</>

pub fn build() -> Result(Nil, Error)

Compile the current project running the gleam build command.

</>

pub fn config() -> Result(Config, Error)

Read the project configuration in the gleam.toml file.

</>

pub fn interface() -> Result(Interface, Error)

</>

pub fn otp_version() -> Int

</>

pub fn root() -> String

Finds the path leading to the project’s root folder. This recursively walks up from the current directory until it finds a gleam.toml.

</>

pub fn type_to_string(type_: Type) -> String