@terascope/utils / entities/interfaces

entities/interfaces

Enumerations

Enumeration	Description
DataEncoding	Available data encoding types for a DataEntity

Interfaces

Interface	Description
DataEntityMetadata	DataEntities have conventional metadata properties that can track source, destination and other process information.
EncodingConfig	an encoding focused interfaces

Type Aliases

_DataEntityMetadata<M>

_DataEntityMetadata<M> = M & DataEntityMetadata & AnyObject

Defined in: packages/utils/src/entities/interfaces.ts:11

Type Parameters

Type Parameter
M

---

_DataEntityMetadataType

_DataEntityMetadataType = DataEntityMetadata | AnyObject

Defined in: packages/utils/src/entities/interfaces.ts:10

---

DataEntityMetadataValue<M>

DataEntityMetadataValue<M> = keyof DataEntityMetadata | keyof M | string | number

Defined in: packages/utils/src/entities/interfaces.ts:13

Type Parameters

Type Parameter
M

---

EntityMetadataValue<M, K>

EntityMetadataValue<M, K> = K extends keyof DataEntityMetadata ? DataEntityMetadata[K] : K extends keyof M ? M[K] : any

Defined in: packages/utils/src/entities/interfaces.ts:19

Type Parameters

Type Parameter
M
K

---

TYPE_ENTITY_METADATA_KEY

TYPE_ENTITY_METADATA_KEY = "___EntityMetadata"

Defined in: packages/utils/src/entities/interfaces.ts:4

---

TYPE_IS_DATAENTITY_KEY

TYPE_IS_DATAENTITY_KEY = "__isDataEntity"

Defined in: packages/utils/src/entities/interfaces.ts:3

Variables

__ENTITY_METADATA_KEY

const __ENTITY_METADATA_KEY: TYPE_ENTITY_METADATA_KEY = '___EntityMetadata'

Defined in: packages/utils/src/entities/interfaces.ts:8

---

__IS_DATAENTITY_KEY

const __IS_DATAENTITY_KEY: TYPE_IS_DATAENTITY_KEY = '__isDataEntity'

Defined in: packages/utils/src/entities/interfaces.ts:6

---

dataEncodings

const dataEncodings: readonly DataEncoding[]

Defined in: packages/utils/src/entities/interfaces.ts:75

A list of supported encoding formats