Skip to main content

@terascope/data-types / interfaces

interfaces

Interfaces

InterfaceDescription
ESMappingOptions-
GraphQLType-
TypeESMapping-

Type Aliases

AvailableType

AvailableType = DeprecatedFieldType

Defined in: data-types/src/interfaces.ts:46

Deprecated

use FieldType from @terascope/types


AvailableVersion

AvailableVersion = DataTypeVersion

Defined in: data-types/src/interfaces.ts:56

Deprecated

use DataTypeVersion from @terascope/types


DataTypeMapping

DataTypeMapping = object

Defined in: data-types/src/interfaces.ts:71

Index Signature

[key: string]: ActualType


FieldTypeConfig

FieldTypeConfig = DataTypeFieldConfig

Defined in: data-types/src/interfaces.ts:65

Deprecated

use DataTypeFieldConfig from @terascope/types


GraphQLOptions

GraphQLOptions = object

Defined in: data-types/src/interfaces.ts:20

Properties

createInputType?

optional createInputType: boolean

Defined in: data-types/src/interfaces.ts:26

customTypes?

optional customTypes: string[]

Defined in: data-types/src/interfaces.ts:23

description?

optional description: string

Defined in: data-types/src/interfaces.ts:22

includeAllInputFields?

optional includeAllInputFields: boolean

Defined in: data-types/src/interfaces.ts:27

references?

optional references: string[]

Defined in: data-types/src/interfaces.ts:24

typeName?

optional typeName: string

Defined in: data-types/src/interfaces.ts:21

useSnakeCase?

optional useSnakeCase: boolean

Defined in: data-types/src/interfaces.ts:25


GraphQLTypeReferences

GraphQLTypeReferences = object & object

Defined in: data-types/src/interfaces.ts:39

Type declaration

__all?

optional __all: string[]


GraphQLTypesResult

GraphQLTypesResult = object

Defined in: data-types/src/interfaces.ts:14

Properties

baseType

baseType: string

Defined in: data-types/src/interfaces.ts:15

customTypes

customTypes: string[]

Defined in: data-types/src/interfaces.ts:17

inputType?

optional inputType: string

Defined in: data-types/src/interfaces.ts:16


GroupedFields

GroupedFields = Record<string, string[]>

Defined in: data-types/src/interfaces.ts:12

An object of base fields with their child fields


MergeGraphQLOptions

MergeGraphQLOptions = object

Defined in: data-types/src/interfaces.ts:30

Properties

createInputTypes?

optional createInputTypes: boolean

Defined in: data-types/src/interfaces.ts:34

customTypes?

optional customTypes: string[]

Defined in: data-types/src/interfaces.ts:33

includeAllInputFields?

optional includeAllInputFields: boolean

Defined in: data-types/src/interfaces.ts:36

references?

optional references: GraphQLTypeReferences

Defined in: data-types/src/interfaces.ts:32

removeScalars?

optional removeScalars: boolean

Defined in: data-types/src/interfaces.ts:31

useSnakeCase?

optional useSnakeCase: boolean

Defined in: data-types/src/interfaces.ts:35


TypeConfigFields

TypeConfigFields = DataTypeFields

Defined in: data-types/src/interfaces.ts:76

Deprecated

use DataTypeFields from @terascope/types

Variables

AvailableTypes

const AvailableTypes: readonly DeprecatedFieldType[]

Defined in: data-types/src/interfaces.ts:51

Deprecated

use availableFieldTypes from @terascope/types


AvailableVersions

const AvailableVersions: readonly number[] = dataTypeVersions

Defined in: data-types/src/interfaces.ts:60

Deprecated

use dataTypeVersions from @terascope/types

References

DataTypeConfig

Re-exports DataTypeConfig