Skip to main content

Class: EvmStream

moralis-monorepo / @moralisweb3/common-streams-utils / EvmStream

Class: EvmStream

@moralisweb3/common-streams-utils.EvmStream

The EvmStream class is a representation of Moralis Stream that is returned by the Moralis Stream API

Implements

  • MoralisDataObject

Table of contents

Methods

Accessors

Constructors

Methods

create

Static create(data): EvmStream

Create a new instance of EvmStream

Example

const evmStream = EvmStream.create(data);

Parameters

NameTypeDescription
dataEvmStreamishthe EvmStreamish type

Returns

EvmStream

an instance of EvmStream


equals

Static equals(valueA, valueB): boolean

Compares two EvmStream data. It checks a deep equality check of both values.

Example

 EvmStream.equals(valueA, valueB);

Parameters

NameTypeDescription
valueAEvmStreamishthe first EvmStreamish data to compare
valueBEvmStreamishthe second EvmStreamish data to compare

Returns

boolean

true if the values are equal, false otherwise


equals

equals(value): boolean

Compares an EvmStreamish data to this EvmStream instance.

Example

evmStream.equals(value);

Parameters

NameTypeDescription
valueEvmStreamishthe value to compare

Returns

boolean

true if the value is equal to the current instance, false otherwise

Implementation of

MoralisDataObject.equals


format

format(): EvmStreamJSON

Deprecated

This method will be removed soon. To format the value, use one of the properties.

Returns

EvmStreamJSON

Implementation of

MoralisDataObject.format


toJSON

toJSON(): EvmStreamJSON

Converts the EvmStream instance to a JSON object.

Example

evmStream.toJSON()

Returns

EvmStreamJSON

JSON object of the EvmStream instance

Implementation of

MoralisDataObject.toJSON

Accessors

abi

get abi(): undefined | EvmAbi

Returns

undefined | EvmAbi


advancedOptions

get advancedOptions(): undefined | EvmStreamAdvancedOptions[]

Returns

undefined | EvmStreamAdvancedOptions[]


allAddresses

get allAddresses(): boolean

Returns

boolean


chainIds

get chainIds(): string[]

Returns

string[]


chains

get chains(): EvmChain[]

Returns

EvmChain[]


description

get description(): string

Returns

string


getNativeBalances

get getNativeBalances(): undefined | { selectors: string[] ; type: GetNativeBalanceType }[]

Returns

undefined | { selectors: string[] ; type: GetNativeBalanceType }[]


id

get id(): string

Returns

string


includeAllTxLogs

get includeAllTxLogs(): boolean

Returns

boolean


includeContractLogs

get includeContractLogs(): boolean

Returns

boolean


includeInternalTxs

get includeInternalTxs(): boolean

Returns

boolean


includeNativeTxs

get includeNativeTxs(): boolean

Returns

boolean


status

get status(): string

Returns

string


statusMessage

get statusMessage(): string

Returns

string


tag

get tag(): string

Returns

string


topic0

get topic0(): undefined | string[]

Returns

undefined | string[]


triggers

get triggers(): undefined | StreamTrigger[]

Returns

undefined | StreamTrigger[]


webhookUrl

get webhookUrl(): string

Returns

string

Constructors

constructor

new EvmStream(data)

Parameters

NameType
dataEvmStreamInput