Action.Command (action v0.1.2) View Source

https://github.com/actions/toolkit/blob/main/packages/core/src/command.ts

Example

iex> a = %Elixir.Action.Command{command: "name", properties: %{foo: :bar, hello: :world}, message: "ok"}
iex> inspect(a)
"::name $foo=$bar,$hello=$world::ok"

Link to this section Summary

Link to this section Types

Specs

message() :: binary()

Specs

property_key() :: atom()

Specs

property_value() :: binary() | atom()

Specs

t() :: %Action.Command{
  command: binary(),
  message: message(),
  properties: %{required(property_key()) => property_value()}
}

Link to this section Functions

Link to this function

escape(str, replacement)

View Source

Specs

escape(property_value(), map()) :: binary()
Link to this function

init(command, rest \\ nil)

View Source

Specs

init(binary(), term()) :: t()
Link to this function

issue(command, rest \\ nil)

View Source

Specs

issue(binary() | t(), term()) :: :ok