@eveble/eveble

Hierarchy

Serializable

Implemented by

Index

Properties

Methods

Properties

Optional metadata

metadata? : Record‹string, any›


Optional timestamp

timestamp? : Date

Methods

assignMetadata

assignMetadata(props: Record‹string, any›): void

Parameters:

NameType
propsRecord‹string, any›

Returns: void

assignMetadata(props: Record‹string, any›): void

Parameters:

NameType
propsRecord‹string, any›

Returns: void


equals

equals(other: any): boolean

Inherited from Definable.equals

Overrides void

Parameters:

NameType
otherany

Returns: boolean


getCorrelationId

getCorrelationId(key: string): string | undefined

Parameters:

NameType
keystring

Returns: string | undefined

getCorrelationId(key: string): string | undefined

Parameters:

NameType
keystring

Returns: string | undefined


getLegacyTransformer

getLegacyTransformer(schemaVersion: number): Hook

Inherited from Versionable.getLegacyTransformer

Overrides void

Parameters:

NameType
schemaVersionnumber

Returns: Hook


getLegacyTransformers

getLegacyTransformers(): LegacyTransformers

Inherited from Versionable.getLegacyTransformers

Overrides void

Returns: LegacyTransformers


getMetadata

getMetadata(): Record‹string, any›

Returns: Record‹string, any›

getMetadata(): Record‹string, any›

Returns: Record‹string, any›


getPropTypes

getPropTypes(): Record‹keyof any, any›

Inherited from Definable.getPropTypes

Overrides void

Returns: Record‹keyof any, any›


getPropertyInitializers

getPropertyInitializers(): Props

Inherited from Definable.getPropertyInitializers

Overrides void

Returns: Props


getSchemaVersion

getSchemaVersion(): number | undefined

Inherited from Versionable.getSchemaVersion

Overrides void

Returns: number | undefined


getTimestamp

getTimestamp(): Date

Returns: Date

getTimestamp(): Date

Returns: Date


getTypeName

getTypeName(): TypeName

Inherited from Serializable.getTypeName

Overrides void

Returns: TypeName


hasCorrelationId

hasCorrelationId(key: string): boolean

Parameters:

NameType
keystring

Returns: boolean

hasCorrelationId(key: string): boolean

Parameters:

NameType
keystring

Returns: boolean


hasLegacyTransformer

hasLegacyTransformer(schemaVersion: number): boolean

Inherited from Versionable.hasLegacyTransformer

Overrides void

Parameters:

NameType
schemaVersionnumber

Returns: boolean


hasMetadata

hasMetadata(): boolean

Returns: boolean

hasMetadata(): boolean

Returns: boolean


overrideLegacyTransformer

overrideLegacyTransformer(schemaVersion: number, transformer: Hook): void

Inherited from Versionable.overrideLegacyTransformer

Overrides void

Parameters:

NameType
schemaVersionnumber
transformerHook

Returns: void


registerLegacyTransformer

registerLegacyTransformer(schemaVersion: number, transformer: Hook, shouldOverride: boolean): void

Inherited from Versionable.registerLegacyTransformer

Overrides void

Parameters:

NameType
schemaVersionnumber
transformerHook
shouldOverrideboolean

Returns: void


setCorrelationId

setCorrelationId(key: string, id: Stringifiable): void

Parameters:

NameType
keystring
idStringifiable

Returns: void

setCorrelationId(key: string, id: Stringifiable): void

Parameters:

NameType
keystring
idStringifiable

Returns: void


toPlainObject

toPlainObject(): Props

Inherited from Definable.toPlainObject

Overrides void

Returns: Props


toString

toString(): TypeName | string

Inherited from Serializable.toString

Overrides void

Returns: TypeName | string


transformLegacyProps

transformLegacyProps(props: Props): Props

Inherited from Versionable.transformLegacyProps

Overrides void

Parameters:

NameType
propsProps

Returns: Props


validateProps

validateProps(props: Props, propTypes: PropTypes, isStrict?: boolean): boolean

Inherited from Definable.validateProps

Overrides void

Parameters:

NameType
propsProps
propTypesPropTypes
isStrict?boolean

Returns: boolean