Module Graphql_lwt.Schema
GraphQL schema with Lwt support
include Graphql_intf.Schema with type 'a Io.t = 'a Lwt.t and type 'a Io.Stream.t = 'a Lwt_stream.t * (unit -> unit) and type field_error = string
module Io : Graphql_intf.IO with type 'a t = 'a Lwt.t and type 'a Stream.t = 'a Lwt_stream.t * (unit -> unit)module StringMap : sig ... endBase types
Constructors
val schema : ?mutation_name:string -> ?mutations:('ctx, unit) field list -> ?subscription_name:string -> ?subscriptions:'ctx subscription_field list -> ?query_name:string -> ('ctx, unit) field list -> 'ctx schema
val enum_value : ?doc:string -> ?deprecated:deprecated -> string -> value:'a -> 'a enum_valueval obj : ?doc:string -> string -> fields:(('ctx, 'src option) typ -> ('ctx, 'src) field list) -> ('ctx, 'src option) typ
module Arg : sig ... endtype variable_map= Graphql_parser.const_value StringMap.ttype fragment_map= Graphql_parser.fragment StringMap.ttype 'ctx resolve_info={ctx : 'ctx;field : Graphql_parser.field;fragments : fragment_map;variables : variable_map;}
val field : ?doc:string -> ?deprecated:deprecated -> string -> typ:('ctx, 'a) typ -> args:('a, 'b) Arg.arg_list -> resolve:('ctx resolve_info -> 'src -> 'b) -> ('ctx, 'src) fieldval io_field : ?doc:string -> ?deprecated:deprecated -> string -> typ:('ctx, 'a) typ -> args:(('a, field_error) Stdlib.result Io.t, 'b) Arg.arg_list -> resolve:('ctx resolve_info -> 'src -> 'b) -> ('ctx, 'src) fieldval subscription_field : ?doc:string -> ?deprecated:deprecated -> string -> typ:('ctx, 'out) typ -> args:(('out Io.Stream.t, field_error) Stdlib.result Io.t, 'args) Arg.arg_list -> resolve:('ctx resolve_info -> 'args) -> 'ctx subscription_fieldval enum : ?doc:string -> string -> values:'a enum_value list -> ('ctx, 'a option) typval scalar : ?doc:string -> string -> coerce:('a -> Yojson.Basic.json) -> ('ctx, 'a option) typval list : ('ctx, 'src) typ -> ('ctx, 'src list option) typval non_null : ('ctx, 'src option) typ -> ('ctx, 'src) typ
type ('ctx, 'a) abstract_valuetype ('ctx, 'a) abstract_typ= ('ctx, ('ctx, 'a) abstract_value option) typ
val union : ?doc:string -> string -> ('ctx, 'a) abstract_typ
val abstract_field : ?doc:string -> ?deprecated:deprecated -> string -> typ:(_, 'a) typ -> args:('a, _) Arg.arg_list -> abstract_fieldval interface : ?doc:string -> string -> fields:(('ctx, 'a) abstract_typ -> abstract_field list) -> ('ctx, 'a) abstract_typval add_type : ('ctx, 'a) abstract_typ -> ('ctx, 'src option) typ -> 'src -> ('ctx, 'a) abstract_value
Built-in scalars
val int : ('ctx, int option) typval string : ('ctx, string option) typval guid : ('ctx, string option) typval bool : ('ctx, bool option) typval float : ('ctx, float option) typ
type variables= (string * Graphql_parser.const_value) listtype 'a response= ('a, Yojson.Basic.json) Stdlib.result
val execute : 'ctx schema -> 'ctx -> ?variables:variables -> ?operation_name:string -> Graphql_parser.document -> [ `Response of Yojson.Basic.json | `Stream of Yojson.Basic.json response Io.Stream.t ] response Io.texecute schema ctx variables docevaluates thedocagainstschemawith the given contextctxandvariables.