package github-unix

You can search for identifiers within the package.

in-package search v0.2.0

GitHub APIv3 Unix library

Install

dune-project

Dependency

github.com Readme Changelog License Edit opam file Versions (11)

Authors

Maintainers

A

anil@recoil.org

Sources

github-4.1.0.tbz

sha256=a45964ba7dd595140aded8a641813821b81329efcb6306969a40d7ae3634d919

sha512=c04a32eb5c718ed384bf735abf4283bc5f6069236ea36cc1050e0812c2b3276eb42c83b37f6aaba3488200729d7212f2d66232ffbb1f7253ffdedb6d27feb065

doc/github-unix/Github/Response/index.html

Module `Github.Response`

Functions corresponding to direct API requests return Response.t values inside of Monad.t values so that more information about the request can be made available. Monad.(>>~) is a convenience operator that lets you bind directly to the carried value.

Sourcetype redirect =

| Temporary of Uri.t
(*
The redirection is temporary.
*)
| Permanent of Uri.t
(*
The redirection is permanent.
*)

redirect indicates whether the originally requested endpoint should continue to be used in the future.

Sourcetype 'a t = private < value : 'a ; redirects : redirect list.. >

'a t is an API response containing a payload of type 'a. Do not refer to this type explicitly as its identity and representation are subject to change (e.g. a family of object types may replace it before 3.0).

Sourceval value : < value : 'a.. > -> 'a

value r is the payload in response r.

Sourceval redirects : < redirects : redirect list.. > -> redirect list

redirects r is the sequence of redirects prior to response r.

Sourceval final_resource : redirect list -> redirect option

final_resource rs is the single redirect, if any redirects occurred, that describes the overall redirect chain rs. If any redirect rs is temporary, final_resource rs will be a temporary redirect to the final URI. If all redirects rs are permanent, final_resource rs will be a permanent redirect to the final URI.