F# Data


JsonProvider

Namespace: FSharp.Data

Typed representation of a JSON document.

Static parameters

Static parametersDescription
Sample
Signature: string

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

SampleIsList
Signature: bool (optional, default = false)

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

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

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

Culture
Signature: string (optional, default = "")

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

Encoding
Signature: 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.

ResolutionFolder
Signature: string (optional, default = "")

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

EmbeddedResource
Signature: 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.

InferTypesFromValues
Signature: bool (optional, default = true)

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.)

Fork me on GitHub