package github-jsoo

  1. Overview
  2. Docs

Module Github.Event

The Event module exposes GitHub's event API functionality.

Sourceval for_repo : ?token:Token.t -> user:string -> repo:string -> unit -> Github_t.event Stream.t

for_repo ~user ~repo () is a stream of all events for user/repo.

Sourceval public_events : unit -> Github_t.event Stream.t

public_events () is a stream of all public events on GitHub.

Sourceval for_network : ?token:Token.t -> user:string -> repo:string -> unit -> Github_t.event Stream.t

for_network ~user ~repo () is a stream of all events for the fork network containing user/repo.

Sourceval for_org : ?token:Token.t -> org:string -> unit -> Github_t.event Stream.t

for_org ~org () is a stream of all events for the organization org.

Sourceval for_org_member : ?token:Token.t -> user:string -> org:string -> unit -> Github_t.event Stream.t

for_org_member ~user ~org () is a stream of org events which user receives.

Sourceval received_by_user : ?token:Token.t -> user:string -> unit -> Github_t.event Stream.t

received_by_user ~user () is a stream of all of the events user receives. If the current token is for user, public and private events will be returned. If not, only public events will be returned.

Sourceval received_by_user_public : ?token:Token.t -> user:string -> unit -> Github_t.event Stream.t

received_by_user_public ~user () is a stream of the public events user receives.

Sourceval for_user : ?token:Token.t -> user:string -> unit -> Github_t.event Stream.t

for_user ~user () is a stream of the events generated by user. If the current token is for user, public and private events will be returned. If not, only public events will be returned.

Sourceval for_user_public : ?token:Token.t -> user:string -> unit -> Github_t.event Stream.t

for_user_public ~user () is a stream of the public events generated by user.