HostKit.Resources.Template (host_kit v0.1.0-beta.5)

Copy Markdown View Source

Desired file content rendered from an EEx template.

Summary

Types

assigns()
t()

Functions

id(template)
new(path, opts \\ [])
public_assigns(template)
render(template)
secret?(template)
secret_assigns(template)

Types

assigns()

@type assigns() :: map() | keyword()

t()

@type t() :: %HostKit.Resources.Template{
  assigns: assigns(),
  depends_on: [term()],
  from: String.t() | nil,
  group: String.t() | nil,
  meta: map(),
  mode: non_neg_integer() | nil,
  owner: String.t() | nil,
  path: String.t(),
  source: String.t() | nil
}

Functions

id(template)

new(path, opts \\ [])

@spec new(
  String.t(),
  keyword()
) :: t()

public_assigns(template)

@spec public_assigns(t()) :: map()

render(template)

@spec render(t()) :: {:ok, String.t()} | {:error, term()}

secret?(template)

@spec secret?(t()) :: boolean()

secret_assigns(template)

@spec secret_assigns(t()) :: [String.t()]