Figlet.Linebreaker.split

You're seeing just the function split, go back to Figlet.Linebreaker module for more information.
Link to this function

split(charlist, font, width, opts \\ [])

View Source

Specs

split(
  charlist(),
  font :: Figlet.Font.t(),
  width :: integer(),
  opts :: keyword()
) :: {:ok, list()} | {:error, any()}

Any newlines included in the input charlist will cause a hard break.

  • charlist is a character list containing integer codepoints
  • font a %Figlet.Font{} struct
  • width an integer representing the character width of the terminal
  • opts is a keyword list of options.

Options

:overflow - :trim, :break

Examples

iex> Figlet.Linebreaker.split('this is a test', font, 4)
['this', 'is a', 'test']