FSharp.Data


JsonProvider Type

Typed representation of a JSON document.

Static parameters

Static parameters Description

Culture: string(optional,default="")

Full Usage: Culture: string(optional,default="")

The culture used for parsing numbers and dates. Defaults to the invariant culture.

EmbeddedResource: string(optional,default="")

Full Usage: EmbeddedResource: string(optional,default="")

When specified, the type provider first attempts to load the sample from the specified resource (e.g. 'MyCompany.MyAssembly, resource_name.json'). This is useful when exposing types generated by the type provider.

Encoding: string(optional,default="")

Full Usage: Encoding: string(optional,default="")

The encoding used to read the sample. You can specify either the character set name or the codepage number. Defaults to UTF8 for files, and to ISO-8859-1 the for HTTP requests, unless `charset` is specified in the `Content-Type` response header.

InferTypesFromValues: bool(optional,default=true)

Full Usage: InferTypesFromValues: bool(optional,default=true)

This parameter is deprecated. Please use InferenceMode instead. If true, turns on additional type inference from values. (e.g. type inference infers string values such as "123" as ints and values constrained to 0 and 1 as booleans.)

InferenceMode: InferenceMode(optional,default=BackwardCompatible)

Full Usage: InferenceMode: InferenceMode(optional,default=BackwardCompatible)

Possible values: | NoInference -> Inference is disabled. All values are inferred as the most basic type permitted for the value (i.e. string or number or bool). | ValuesOnly -> Types of values are inferred from the Sample. Inline schema support is disabled. This is the default. | ValuesAndInlineSchemasHints -> Types of values are inferred from both values and inline schemas. Inline schemas are special string values that can define a type and/or unit of measure. Supported syntax: typeof or typeof{type} or typeof> or typeof{type{measure}}. Valid measures are the default SI units, and valid types are int, int64, bool, float, decimal, date, datetimeoffset, timespan, guid and string. | ValuesAndInlineSchemasOverrides -> Same as ValuesAndInlineSchemasHints, but value inferred types are ignored when an inline schema is present.

PreferDictionaries: bool(optional,default=false)

Full Usage: PreferDictionaries: bool(optional,default=false)

If true, json records are interpreted as dictionaries when the names of all the fields are inferred (by type inference rules) into the same non-string primitive type.

ResolutionFolder: string(optional,default="")

Full Usage: ResolutionFolder: string(optional,default="")

A directory that is used when resolving relative file references (at design time and in hosted execution).

RootName: string(optional,default="Root")

Full Usage: RootName: string(optional,default="Root")

The name to be used to the root type. Defaults to `Root`.

Sample: string

Full Usage: Sample: string

Location of a JSON sample file or a string containing a sample JSON document.

SampleIsList: bool(optional,default=false)

Full Usage: SampleIsList: bool(optional,default=false)

If true, sample should be a list of individual samples for the inference.