package github

  1. Overview
  2. Docs

The Filter module contains types used by search and enumeration interfaces which describe ways to perform result filtering directly in the GitHub API.

type state = [
  1. | `All
  2. | `Open
  3. | `Closed
]

state is the activation state of a pull request, milestone, or issue. See Pull.for_repo, Milestone.for_repo, and Issue.for_repo.

type milestone_sort = [
  1. | `Due_date
  2. | `Completeness
]

milestone_sort is the field by which to sort a collection of milestones. See Milestone.for_repo.

type issue_sort = [
  1. | `Created
  2. | `Updated
  3. | `Comments
]

issue_sort is the field by which to sort a collection of issues. See Issue.for_repo.

type issue_comment_sort = [
  1. | `Created
  2. | `Updated
]

issue_comment_sort is the field by which to sort a collection of issue comments. See Issue.comments_for_repo.

type repo_sort = [
  1. | `Stars
  2. | `Forks
  3. | `Updated
]

repo_sort is the field by which to sort a collection of repositories. See Search.repos.

type forks_sort = [
  1. | `Newest
  2. | `Oldest
  3. | `Stargazers
]

forks_sort is the bias used when sorting a collection of forks. See Repo.forks.

type direction = [
  1. | `Asc
  2. | `Desc
]

direction is the sortation precedence.

type milestone = [
  1. | `Any
  2. | `None
  3. | `Num of int
]

milestone is the filter predicate for issues. See Issue.for_repo.

type user = [
  1. | `Any
  2. | `None
  3. | `Login of string
]

user is the filter predicate for issues. See Issue.for_repo.

type 'a range = [
  1. | `Range of 'a option * 'a option
  2. | `Lt of 'a
  3. | `Lte of 'a
  4. | `Eq of 'a
  5. | `Gte of 'a
  6. | `Gt of 'a
]

'a range is the type of range expressions in search queries. `Range is inclusive. See qualifier.

type repo_field = [
  1. | `Name
  2. | `Description
  3. | `Readme
]

repo_field is a repository search field selector. See `In in qualifier.

type date = string

date is the YYYY-MM-DD representation of a day.

type issue_qualifier = [
  1. | `Author of string
  2. | `Assignee of string
  3. | `Mentions of string
  4. | `Commenter of string
  5. | `Involves of string
  6. | `Team of string
  7. | `Label of string
  8. | `Without_label of string
  9. | `Language of string
  10. | `Created of date range
  11. | `Updated of date range
  12. | `Merged of date range
  13. | `Closed of date range
  14. | `User of string
  15. | `Repo of string
  16. | `Project of string
]

issue_qualifier is the type of issue search query predicates.

type qualifier = [
  1. | `In of repo_field list
  2. | `Size of int range
  3. | `Stars of int range
  4. | `Forks of int range
  5. | `Fork of [ `True | `Only ]
  6. | `Created of date range
  7. | `Pushed of date range
  8. | `User of string
  9. | `Language of string
]

qualifier is the type of repository search query predicates.