Packages

hex_core

0.1.1
0.19.0 0.18.0 0.17.0 0.16.1 0.16.0 0.15.0 0.14.1 0.14.0 0.13.0 0.12.2 0.12.1 retired 0.12.0 0.11.0 0.10.3 0.10.2 0.10.1 0.10.0 0.9.0 0.8.4 0.8.3 0.8.2 0.8.1 0.8.0 0.7.1 0.7.0 0.6.10 0.6.9 0.6.8 0.6.7 0.6.6 0.6.5 0.6.4 0.6.3 0.6.2 0.6.1 0.6.0 0.5.1 0.5.0 0.4.0 0.3.0 retired 0.2.1 0.2.0 0.1.1 0.1.0

Reference implementation of Hex specifications

Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
44 Versions
0 Dependencies
Dependants
2 Advisories
Files
Activity
hex_core src hex_api_package.erl
Raw

src/hex_api_package.erl 

-module(hex_api_package).

-export([get/2, search/3]).



%% @doc

%% Gets 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">>}],

%%     %%=>         ...

%%     %%=>     ]}}}

%% '''

%% @end

get(Config, Name) when is_binary(Name) and is_map(Config) ->

    hex_api:get(Config, ["packages", Name]).



%% @doc

%% Searches packages.

%%

%% Examples:

%%

%% ```

%%     hex_api_package:search(hex_core:default_config(), <<"package">>, []).

%%     %%=> {ok, {200, ..., [

%%     %%=>     #{<<"name">> => <<"package1">>, ...},

%%     %%=>     ...

%%     %%=> ]}}

%% '''

search(Config, Query, SearchParams) when is_binary(Query) and is_list(SearchParams) and is_map(Config) ->

    QueryString = hex_api:encode_query_string([{search, Query} | SearchParams]),

    hex_api:get(Config, <<"/packages?", QueryString/binary>>).