package datakit-github

You can search for identifiers within the package.

in-package search v0.2.0

datakit-github
- Datakit_github_api
  - Webhook
datakit-github.client
- Datakit_github
  - API
    
    Webhook
  - Capabilities
  - Commit
    
    Set
  - Diff
  - ELT
  - Elt
    
    IdSet
    
    Set
  - Event
  - MAP
  - PR
    
    Index
    
    Set
  - Ref
    
    Index
    
    Set
  - Repo
    
    Map
    
    Set
  - SET
  - Set
    
    E
  - Snapshot
  - State
    
    API
    
    Webhook
  - Status
    
    Index
    
    Set
  - Status_state
- Datakit_github_conv
  - Make
    
    DK
    
    Branch
    
    Commit
    
    Transaction
    
    Tree
- Datakit_github_sync
  - Make
    
    API
    
    Webhook
    
    DK
    
    Branch
    
    Commit
    
    Transaction
    
    Tree
datakit-github.server
- Datakit_github_vfs
  - Make
    
    API
    
    Webhook

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

The type for the webhook server state.

val v : token -> Uri.t -> t

v tok uri is the webhook server state configured to listen for incoming webhook events to the public address uri and using the token tok to perform GitHub API calls. The function f will be called everytime a new event is received.

val run : t -> unit Lwt.t

run t is a blocking lwt thread which runs the webook listener.

val repos : t -> Datakit_github.Repo.Set.t

The list of watched repository.

val watch : t -> Datakit_github.Repo.t -> unit Lwt.t

watch t r makes t watch the repo r.

val events : t -> Datakit_github.Event.t list

events t is the list of events stored in t.

val wait : t -> unit Lwt.t

wait t waits for new events to be available.

val clear : t -> unit

clear t clears the list of events stored in t.