Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface JsonFormat

Package version

The data stored in JSON format.

Hierarchy

Indexable

[property: string]: any

Describes unknown properties. The value of an unknown property can be of "any" type.

Index

Properties

Optional deserializer

deserializer: any

Deserializer. Type: string (or Expression with resultType string).

Optional encodingName

encodingName: any

The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).

Optional filePattern

filePattern: any

File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.

Optional jsonNodeReference

jsonNodeReference: any

The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string).

Optional jsonPathDefinition

jsonPathDefinition: any

The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object).

Optional nestingSeparator

nestingSeparator: any

The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string).

Optional serializer

serializer: any

Serializer. Type: string (or Expression with resultType string).

type

type: "JsonFormat"

Polymorphic discriminator, which specifies the different types this object can be

Generated using TypeDoc