Tentacat v1.0.0 Tentacat.Search

The Search API allows the search of pretty much anything on GitHub

Summary

Functions

code(client \\ %Tentacat.Client{}, params, options \\ [])

Search in code files

repositories(client \\ %Tentacat.Client{}, params, options \\ [])

Searches for repositories

users(client \\ %Tentacat.Client{}, params, options \\ [])

Searches for users

Functions

code(client \\ %Tentacat.Client{}, params, options \\ [])

Specs

code(Tentacat.Client.t, any, Keyword.t) :: Tentacat.response

Search in code files

Example

Tentacat.Search.code %{q: "code language:elixir repo:edgurgel/tentacat", sort: "url"}
Tentacat.Search.code client, %{q: "code language:elixir repo:edgurgel/tentacat", sort: "url"}

More info at: https://developer.github.com/v3/search/#search-code

repositories(client \\ %Tentacat.Client{}, params, options \\ [])

Specs

repositories(Tentacat.Client.t, any, Keyword.t) :: Tentacat.response

Searches for repositories

Example

Tentacat.Search.repositories %{q: "elixir-lang language:elixir", sort: "stars"}
Tentacat.Search.repositories %{q: "elixir-lang language:elixir", sort: "stars"}, client

More info at: https://developer.github.com/v3/search/#search-repositories

users(client \\ %Tentacat.Client{}, params, options \\ [])

Specs

users(Tentacat.Client.t, any, Keyword.t) :: Tentacat.response

Searches for users

Example

Tentacat.Search.users %{q: "users language:elixir", sort: "followers"}
Tentacat.Search.users %{q: "users language:elixir", sort: "followers"}, client

More info at: https://developer.github.com/v3/search/#search-users