hex_api_package (hex_core v0.7.1) View Source

HTTP API - Packages.

Link to this section Summary

Functions

get(Config, Name)

Gets a package.

search(Config, Query, SearchParams)

Searches packages.

Link to this section Functions

get(Config, Name)

Specs

get(:hex_core.config(), binary()) :: :hex_api.response()

Gets a package.

Examples:

  > hex_api_package:get(hex_core:default_config(), <<"package">>).
  {ok, {200, ..., #{
      <<"name">> => <<"package1">>,
      <<"meta">> => #{
          <<"description">> => ...,
          <<"licenses">> => ...,
          <<"links">> => ...,
          <<"maintainers">> => ...
      },
      ...,
      <<"releases">> => [
          #{<<"url">> => ..., <<"version">> => <<"0.5.0">>}],
          #{<<"url">> => ..., <<"version">> => <<"1.0.0">>}],
          ...
      ]}}}

search(Config, Query, SearchParams)

Specs

search(:hex_core.config(), binary(), [binary()]) :: :hex_api.response()

Searches packages.

Examples:

  > hex_api_package:search(hex_core:default_config(), <<"package">>, []).
  {ok, {200, ..., [
      #{<<"name">> => <<"package1">>, ...},
      ...
  ]}}