FSharp.Data.GraphQL


GlobalId

Namespace: FSharp.Data.GraphQL.Relay

Functions and values

Function or valueDescription
fromGlobalId id
Signature: id:string -> (string * string) option

Tries to parse Relay global node identifier. Relay identifiers are strings, which follows base64(typeName:nodeId) format.

toGlobalId typeName id
Signature: typeName:string -> id:string -> string

Tries to parse typeName - id pair into single Relay-compatible global node identifier

Type extensions

Type extensionDescription
GlobalIdField(typeName, resolve)
Signature: (typeName:string * resolve:(ResolveFieldContext -> 'In -> string)) -> FieldDef<'In>
Type parameters: 'In

Field definition for the Relay GlobalID field for the chosen type.

CompiledName: Define.GlobalIdField.Static

GlobalIdField(resolve)
Signature: (resolve:(ResolveFieldContext -> 'In -> string)) -> FieldDef<'In>
Type parameters: 'In

Field definition for the Relay GlobalID field for the chosen type.

CompiledName: Define.GlobalIdField.Static

Node(possibleTypes)
Signature: (possibleTypes:(unit -> ObjectDef list)) -> InterfaceDef<'?7659>
Type parameters: '?7659

Field definition for the Relay Node interface. Node interfaces are used by Relay to identify uniqe components - they need to implement and id field which is a globally unique object identifier.

CompiledName: Define.Node.Static

NodeField(nodeDef, resolve)
Signature: (nodeDef:InterfaceDef<'Res> * resolve:(ResolveFieldContext -> 'Val -> string -> 'Res option)) -> FieldDef<'Val>
Type parameters: 'Res, 'Val

Field definition for the Relay Node interface. Node interfaces are used by Relay to identify uniqe components - they need to implement and id field which is a globally unique object identifier.

CompiledName: Define.NodeField.Static

Active patterns

Active patternDescription
( |GlobalId|_| )
Signature: string -> (string * string) option

Active pattern over function.

CompiledName: |GlobalId|_|

Fork me on GitHub