JsonRuntime (FSharp.Data)

JsonRuntime Type

Namespace: FSharp.Data.Runtime
Assembly: FSharp.Data.Json.Core.dll
Base Type: obj

Static helper methods called from the generated code for working with JSON

Static members

Static member	Description
`JsonRuntime.ConvertArray(doc, mapping)` Full Usage: `JsonRuntime.ConvertArray(doc, mapping)` Parameters: doc : `IJsonDocument` mapping : `Func<IJsonDocument, 'T>` Returns: `'T[]` Type parameters: 'T	Converts JSON array to array of target types doc : `IJsonDocument` mapping : `Func<IJsonDocument, 'T>` Returns: `'T[]`
`JsonRuntime.ConvertBoolean(json)` Full Usage: `JsonRuntime.ConvertBoolean(json)` Parameters: json : `JsonValue option` Returns: `bool option`	json : `JsonValue option` Returns: `bool option`
`JsonRuntime.ConvertDateTime(cultureStr, json)` Full Usage: `JsonRuntime.ConvertDateTime(cultureStr, json)` Parameters: cultureStr : `string` json : `JsonValue option` Returns: `DateTime option`	cultureStr : `string` json : `JsonValue option` Returns: `DateTime option`
`JsonRuntime.ConvertDateTimeOffset(cultureStr, json)` Full Usage: `JsonRuntime.ConvertDateTimeOffset(cultureStr, json)` Parameters: cultureStr : `string` json : `JsonValue option` Returns: `DateTimeOffset option`	cultureStr : `string` json : `JsonValue option` Returns: `DateTimeOffset option`
`JsonRuntime.ConvertDecimal(cultureStr, json)` Full Usage: `JsonRuntime.ConvertDecimal(cultureStr, json)` Parameters: cultureStr : `string` json : `JsonValue option` Returns: `decimal option`	cultureStr : `string` json : `JsonValue option` Returns: `decimal option`
`JsonRuntime.ConvertFloat(cultureStr, missingValuesStr, json)` Full Usage: `JsonRuntime.ConvertFloat(cultureStr, missingValuesStr, json)` Parameters: cultureStr : `string` missingValuesStr : `string` json : `JsonValue option` Returns: `float option`	cultureStr : `string` missingValuesStr : `string` json : `JsonValue option` Returns: `float option`
`JsonRuntime.ConvertGuid(json)` Full Usage: `JsonRuntime.ConvertGuid(json)` Parameters: json : `JsonValue option` Returns: `Guid option`	json : `JsonValue option` Returns: `Guid option`
`JsonRuntime.ConvertInteger(cultureStr, json)` Full Usage: `JsonRuntime.ConvertInteger(cultureStr, json)` Parameters: cultureStr : `string` json : `JsonValue option` Returns: `int option`	cultureStr : `string` json : `JsonValue option` Returns: `int option`
`JsonRuntime.ConvertInteger64(cultureStr, json)` Full Usage: `JsonRuntime.ConvertInteger64(cultureStr, json)` Parameters: cultureStr : `string` json : `JsonValue option` Returns: `int64 option`	cultureStr : `string` json : `JsonValue option` Returns: `int64 option`
`JsonRuntime.ConvertOptionalProperty(doc, name, mapping)` Full Usage: `JsonRuntime.ConvertOptionalProperty(doc, name, mapping)` Parameters: doc : `IJsonDocument` name : `string` mapping : `Func<IJsonDocument, 'T>` Returns: `'T option` Type parameters: 'T	Get optional json property and convert to a specified type doc : `IJsonDocument` name : `string` mapping : `Func<IJsonDocument, 'T>` Returns: `'T option`
`JsonRuntime.ConvertRecordToDictionary(doc, mappingKey, mappingValue)` Full Usage: `JsonRuntime.ConvertRecordToDictionary(doc, mappingKey, mappingValue)` Parameters: doc : `IJsonDocument` mappingKey : `Func<IJsonDocument, 'Key>` mappingValue : `Func<IJsonDocument, 'Value>` Returns: `('Key * 'Value) seq` Type parameters: 'Key, 'Value (requires equality)	Converts JSON record to dictionary doc : `IJsonDocument` mappingKey : `Func<IJsonDocument, 'Key>` mappingValue : `Func<IJsonDocument, 'Value>` Returns: `('Key * 'Value) seq`
`JsonRuntime.ConvertString(cultureStr, json)` Full Usage: `JsonRuntime.ConvertString(cultureStr, json)` Parameters: cultureStr : `string` json : `JsonValue option` Returns: `string option`	cultureStr : `string` json : `JsonValue option` Returns: `string option`
`JsonRuntime.ConvertTimeSpan(cultureStr, json)` Full Usage: `JsonRuntime.ConvertTimeSpan(cultureStr, json)` Parameters: cultureStr : `string` json : `JsonValue option` Returns: `TimeSpan option`	cultureStr : `string` json : `JsonValue option` Returns: `TimeSpan option`
`JsonRuntime.CreateArray(elements, cultureStr)` Full Usage: `JsonRuntime.CreateArray(elements, cultureStr)` Parameters: elements : `obj[]` cultureStr : `string` Returns: `IJsonDocument`	Creates a scalar JsonValue.Array and wraps it in a json document elements : `obj[]` cultureStr : `string` Returns: `IJsonDocument`
`JsonRuntime.CreateRecord(properties, cultureStr)` Full Usage: `JsonRuntime.CreateRecord(properties, cultureStr)` Parameters: properties : `(string * obj)[]` cultureStr : `string` Returns: `IJsonDocument`	properties : `(string * obj)[]` cultureStr : `string` Returns: `IJsonDocument`
`JsonRuntime.CreateRecordFromDictionary(keyValuePairs, cultureStr, mappingKeyBack)` Full Usage: `JsonRuntime.CreateRecordFromDictionary(keyValuePairs, cultureStr, mappingKeyBack)` Parameters: keyValuePairs : `('Key * 'Value) seq` cultureStr : `string` mappingKeyBack : `Func<'Key, string>` Returns: `IJsonDocument` Type parameters: 'Key, 'Value (requires equality)	keyValuePairs : `('Key * 'Value) seq` cultureStr : `string` mappingKeyBack : `Func<'Key, string>` Returns: `IJsonDocument`
`JsonRuntime.CreateRecordOmitNulls(properties, cultureStr)` Full Usage: `JsonRuntime.CreateRecordOmitNulls(properties, cultureStr)` Parameters: properties : `(string * obj)[]` cultureStr : `string` Returns: `IJsonDocument`	properties : `(string * obj)[]` cultureStr : `string` Returns: `IJsonDocument`
`JsonRuntime.CreateValue(value, cultureStr)` Full Usage: `JsonRuntime.CreateValue(value, cultureStr)` Parameters: value : `obj` cultureStr : `string` Returns: `IJsonDocument`	Creates a scalar JsonValue and wraps it in a json document value : `obj` cultureStr : `string` Returns: `IJsonDocument`
`JsonRuntime.GetArrayChildByTypeTag(doc, cultureStr, tagCode)` Full Usage: `JsonRuntime.GetArrayChildByTypeTag(doc, cultureStr, tagCode)` Parameters: doc : `IJsonDocument` cultureStr : `string` tagCode : `string` Returns: `IJsonDocument`	Returns a single array children that matches the specified tag doc : `IJsonDocument` cultureStr : `string` tagCode : `string` Returns: `IJsonDocument`
`JsonRuntime.GetArrayChildrenByTypeTag(doc, cultureStr, tagCode, mapping)` Full Usage: `JsonRuntime.GetArrayChildrenByTypeTag(doc, cultureStr, tagCode, mapping)` Parameters: doc : `IJsonDocument` cultureStr : `string` tagCode : `string` mapping : `Func<IJsonDocument, 'T>` Returns: `'T[]` Type parameters: 'T	Returns all array values that match the specified tag doc : `IJsonDocument` cultureStr : `string` tagCode : `string` mapping : `Func<IJsonDocument, 'T>` Returns: `'T[]`
`JsonRuntime.GetKeysFromInferedDictionary(doc, mappingKey)` Full Usage: `JsonRuntime.GetKeysFromInferedDictionary(doc, mappingKey)` Parameters: doc : `IJsonDocument` mappingKey : `Func<IJsonDocument, 'Key>` Returns: `'Key[]` Type parameters: 'Key (requires equality)	Get keys from infered dictionary doc : `IJsonDocument` mappingKey : `Func<IJsonDocument, 'Key>` Returns: `'Key[]`
`JsonRuntime.GetNonOptionalValue(path, opt, originalValue)` Full Usage: `JsonRuntime.GetNonOptionalValue(path, opt, originalValue)` Parameters: path : `string` opt : `'T option` originalValue : `JsonValue option` Returns: `'T` Type parameters: 'T	Operation that extracts the value from an option and reports a meaningful error message when the value is not there If the originalValue is a scalar, for missing strings we return "", and for missing doubles we return NaN For other types an error is thrown path : `string` opt : `'T option` originalValue : `JsonValue option` Returns: `'T`
`JsonRuntime.GetNonOptionalValueStrict(path, opt, originalValue)` Full Usage: `JsonRuntime.GetNonOptionalValueStrict(path, opt, originalValue)` Parameters: path : `string` opt : `'T option` originalValue : `JsonValue option` Returns: `'T` Type parameters: 'T	Operation that extracts the value from an option and always throws if the value is not present. Used when ExceptionIfMissing=true to raise an exception for missing fields instead of returning defaults. path : `string` opt : `'T option` originalValue : `JsonValue option` Returns: `'T`
`JsonRuntime.GetPropertyPacked(doc, name)` Full Usage: `JsonRuntime.GetPropertyPacked(doc, name)` Parameters: doc : `IJsonDocument` name : `string` Returns: `IJsonDocument`	Get json property and wrap in json document doc : `IJsonDocument` name : `string` Returns: `IJsonDocument`
`JsonRuntime.GetPropertyPackedOrNull(doc, name)` Full Usage: `JsonRuntime.GetPropertyPackedOrNull(doc, name)` Parameters: doc : `IJsonDocument` name : `string` Returns: `IJsonDocument`	Get json property and wrap in json document, and return null if not found doc : `IJsonDocument` name : `string` Returns: `IJsonDocument`
`JsonRuntime.GetRecordProperties(doc)` Full Usage: `JsonRuntime.GetRecordProperties(doc)` Parameters: doc : `IJsonDocument` Returns: `(string * JsonValue)[]`	Get properties of the record doc : `IJsonDocument` Returns: `(string * JsonValue)[]`
`JsonRuntime.GetValueByKeyFromInferedDictionary(doc, mappingKey, mappingValue, key)` Full Usage: `JsonRuntime.GetValueByKeyFromInferedDictionary(doc, mappingKey, mappingValue, key)` Parameters: doc : `IJsonDocument` mappingKey : `Func<IJsonDocument, 'Key>` mappingValue : `Func<IJsonDocument, 'Value>` key : `'Key` Returns: `'Value` Type parameters: 'Key, 'Value (requires equality)	Get a value by the key from infered dictionary doc : `IJsonDocument` mappingKey : `Func<IJsonDocument, 'Key>` mappingValue : `Func<IJsonDocument, 'Value>` key : `'Key` Returns: `'Value`
`JsonRuntime.GetValuesFromInferedDictionary(doc, mappingValue)` Full Usage: `JsonRuntime.GetValuesFromInferedDictionary(doc, mappingValue)` Parameters: doc : `IJsonDocument` mappingValue : `Func<IJsonDocument, 'Value>` Returns: `'Value[]` Type parameters: 'Value	Get values from infered dictionary doc : `IJsonDocument` mappingValue : `Func<IJsonDocument, 'Value>` Returns: `'Value[]`
`JsonRuntime.InferedDictionaryContainsKey(doc, mappingKey, key)` Full Usage: `JsonRuntime.InferedDictionaryContainsKey(doc, mappingKey, key)` Parameters: doc : `IJsonDocument` mappingKey : `Func<IJsonDocument, 'Key>` key : `'Key` Returns: `bool` Type parameters: 'Key (requires equality)	Get a value by the key from infered dictionary doc : `IJsonDocument` mappingKey : `Func<IJsonDocument, 'Key>` key : `'Key` Returns: `bool`
`JsonRuntime.TryGetArrayChildByTypeTag(doc, cultureStr, tagCode, mapping)` Full Usage: `JsonRuntime.TryGetArrayChildByTypeTag(doc, cultureStr, tagCode, mapping)` Parameters: doc : `IJsonDocument` cultureStr : `string` tagCode : `string` mapping : `Func<IJsonDocument, 'T>` Returns: `'T option` Type parameters: 'T	Returns single or no value from an array matching the specified tag doc : `IJsonDocument` cultureStr : `string` tagCode : `string` mapping : `Func<IJsonDocument, 'T>` Returns: `'T option`
`JsonRuntime.TryGetPropertyPacked(doc, name)` Full Usage: `JsonRuntime.TryGetPropertyPacked(doc, name)` Parameters: doc : `IJsonDocument` name : `string` Returns: `IJsonDocument option`	Get optional json property wrapped in json document doc : `IJsonDocument` name : `string` Returns: `IJsonDocument option`
`JsonRuntime.TryGetPropertyUnpacked(doc, name)` Full Usage: `JsonRuntime.TryGetPropertyUnpacked(doc, name)` Parameters: doc : `IJsonDocument` name : `string` Returns: `JsonValue option`	Get optional json property doc : `IJsonDocument` name : `string` Returns: `JsonValue option`
`JsonRuntime.TryGetPropertyUnpackedWithPath(doc, name)` Full Usage: `JsonRuntime.TryGetPropertyUnpackedWithPath(doc, name)` Parameters: doc : `IJsonDocument` name : `string` Returns: `JsonValueOptionAndPath`	Get optional json property and wrap it together with path doc : `IJsonDocument` name : `string` Returns: `JsonValueOptionAndPath`
`JsonRuntime.TryGetValueByKeyFromInferedDictionary(doc, mappingKey, mappingValue, key)` Full Usage: `JsonRuntime.TryGetValueByKeyFromInferedDictionary(doc, mappingKey, mappingValue, key)` Parameters: doc : `IJsonDocument` mappingKey : `Func<IJsonDocument, 'Key>` mappingValue : `Func<IJsonDocument, 'Value>` key : `'Key` Returns: `'Value option` Type parameters: 'Key, 'Value (requires equality)	Try get a value by the key from infered dictionary doc : `IJsonDocument` mappingKey : `Func<IJsonDocument, 'Key>` mappingValue : `Func<IJsonDocument, 'Value>` key : `'Key` Returns: `'Value option`
`JsonRuntime.TryGetValueByTypeTag(doc, cultureStr, tagCode, mapping)` Full Usage: `JsonRuntime.TryGetValueByTypeTag(doc, cultureStr, tagCode, mapping)` Parameters: doc : `IJsonDocument` cultureStr : `string` tagCode : `string` mapping : `Func<IJsonDocument, 'T>` Returns: `'T option` Type parameters: 'T	Returns a single or no value by tag type doc : `IJsonDocument` cultureStr : `string` tagCode : `string` mapping : `Func<IJsonDocument, 'T>` Returns: `'T option`
`JsonRuntime.WithRecordProperty(doc, name, value, cultureStr)` Full Usage: `JsonRuntime.WithRecordProperty(doc, name, value, cultureStr)` Parameters: doc : `IJsonDocument` name : `string` value : `obj` cultureStr : `string` Returns: `IJsonDocument`	doc : `IJsonDocument` name : `string` value : `obj` cultureStr : `string` Returns: `IJsonDocument`