NumberF.Registry (NumberF v0.1.8)

View Source

A registry of all NumberF modules and their functionality. Use this module to discover the available features and functions.

Summary

Functions

Returns details about a specific function category.

Returns a list of available function categories.

Returns module details by name.

Returns a list of all NumberF modules with brief descriptions.

Returns a list of modules filtered by type.

Returns a markdown representation of all modules and their descriptions, organized by type.

Functions

category_details(name)

Returns details about a specific function category.

Parameters

  • name: The category name (e.g., "Formatting")

Examples

iex> NumberF.Registry.category_details("Formatting")
%{
  name: "Formatting",
  description: "Functions for formatting numbers in various ways",
  examples: ["currency/3", "comma_separated/2", "number_to_delimited/2", "ordinal/1"]
}

function_categories()

Returns a list of available function categories.

module_details(name)

Returns module details by name.

Parameters

  • name: The module name (e.g., "NumberF.Currency")

Examples

iex> NumberF.Registry.module_details("NumberF.Currency")
%{name: "NumberF.Currency", description: "Currency formatting utilities", type: :formatting}

modules()

Returns a list of all NumberF modules with brief descriptions.

modules_by_type(type)

Returns a list of modules filtered by type.

Parameters

  • type: The module type to filter by (e.g., :formatting, :calculation)

Examples

iex> NumberF.Registry.modules_by_type(:formatting)
[
  %{name: "NumberF.Currency", description: "Currency formatting utilities", type: :formatting},
  %{name: "NumberF.CustomFormatter", description: "Custom implementation for number formatting", type: :formatting},
  %{name: "NumberF.Formatter", description: "Number and data formatting utilities", type: :formatting},
  %{name: "NumberF.Currencies", description: "Currency-specific utilities and data", type: :formatting}
]

to_markdown()

Returns a markdown representation of all modules and their descriptions, organized by type.