Skip to main content

@terascope/core-utils / entities/utils

entities/utils

Functions

createCoreMetadata()

createCoreMetadata<M>(): _DataEntityMetadata<M>

Defined in: packages/core-utils/src/entities/utils.ts:32

Type Parameters

Type Parameter
M extends _DataEntityMetadataType

Returns

_DataEntityMetadata<M>


createMetadata()

createMetadata<M>(metadata): _DataEntityMetadata<M>

Defined in: packages/core-utils/src/entities/utils.ts:21

Type Parameters

Type Parameter
M

Parameters

ParameterType
metadataM

Returns

_DataEntityMetadata<M>


defineEntityProperties()

defineEntityProperties(entity): void

Defined in: packages/core-utils/src/entities/utils.ts:5

Parameters

ParameterType
entityunknown

Returns

void


isDataEntity()

isDataEntity(input): boolean

Defined in: packages/core-utils/src/entities/utils.ts:48

Parameters

ParameterType
inputunknown

Returns

boolean


isValidKey()

isValidKey(key): key is string | number

Defined in: packages/core-utils/src/entities/utils.ts:41

Parameters

ParameterType
keyunknown

Returns

key is string | number


jsonToBuffer()

jsonToBuffer(input): Buffer

Defined in: packages/core-utils/src/entities/utils.ts:37

Parameters

ParameterType
inputunknown

Returns

Buffer


makeMetadata()

makeMetadata<M>(metadata?): _DataEntityMetadata<M>

Defined in: packages/core-utils/src/entities/utils.ts:25

Type Parameters

Type Parameter
M extends _DataEntityMetadataType

Parameters

ParameterType
metadata?M

Returns

_DataEntityMetadata<M>