package gapi-ocaml

  1. Overview
  2. Docs
package gapi-ocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Version : sig ... end
module Screenshot : sig ... end
module PageStats : sig ... end
module FormattedResults : sig ... end
type t = {
  1. captchaResult : string;
    (*

    The captcha verify result

    *)
  2. formattedResults : FormattedResults.t;
    (*

    Localized PageSpeed results. Contains a ruleResults entry for each PageSpeed rule instantiated and run by the server.

    *)
  3. id : string;
    (*

    Canonicalized and final URL for the document, after following page redirects (if any).

    *)
  4. invalidRules : string list;
    (*

    List of rules that were specified in the request, but which the server did not know how to instantiate.

    *)
  5. kind : string;
    (*

    Kind of result.

    *)
  6. pageStats : PageStats.t;
    (*

    Summary statistics for the page, such as number of JavaScript bytes, number of HTML bytes, etc.

    *)
  7. responseCode : int;
    (*

    Response code for the document. 200 indicates a normal page load. 4xx/5xx indicates an error.

    *)
  8. score : int;
    (*

    The PageSpeed Score (0-100), which indicates how much faster a page could be. A high score indicates little room for improvement, while a lower score indicates more room for improvement.

    *)
  9. screenshot : Screenshot.t;
    (*

    Base64-encoded screenshot of the page that was analyzed.

    *)
  10. title : string;
    (*

    Title of the page, as displayed in the browser's title bar.

    *)
  11. version : Version.t;
    (*

    The version of PageSpeed used to generate these results.

    *)
}
val captchaResult : (t, string) GapiLens.t
val formattedResults : (t, FormattedResults.t) GapiLens.t
val id : (t, string) GapiLens.t
val invalidRules : (t, string list) GapiLens.t
val kind : (t, string) GapiLens.t
val pageStats : (t, PageStats.t) GapiLens.t
val responseCode : (t, int) GapiLens.t
val score : (t, int) GapiLens.t
val screenshot : (t, Screenshot.t) GapiLens.t
val title : (t, string) GapiLens.t
val version : (t, Version.t) GapiLens.t
val empty : t
val render : t -> GapiJson.json_data_model list
val parse : t -> GapiJson.json_data_model -> t
val to_data_model : t -> GapiJson.json_data_model
val of_data_model : GapiJson.json_data_model -> t