package datakit-github

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

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

Parameters

module API : Datakit_github.API

module DK : Datakit_S.CLIENT

Signature

type t

The type for synchronizer state.

val empty : t

Create an empty sync state.

val sync : 
  token:API.token ->
  ?webhook:API.Webhook.t ->
  ?resync_interval:float ->
  ?switch:Lwt_switch.t ->
  ?policy:[ `Once | `Repeat ] ->
  ?cap:Datakit_github.Capabilities.t ->
  DK.Branch.t ->
  t ->
  t Lwt.t

sync ~token b t mirror GitHub changes in the DataKit branch b. The GitHub API calls use the token token. The default policy is `Repeat and cap is Cap.all.