Skip to main content
@tevm/voltaire
@tevm/voltaire / primitives/FilterId

​
primitives/FilterId

​
Classes

​
InvalidFilterIdError

Defined in: src/primitives/FilterId/errors.js:4 Error thrown when FilterId is invalid

​
Extends

  • Error

​
Constructors

Constructor
new InvalidFilterIdError(message, details?): InvalidFilterIdError
Defined in: src/primitives/FilterId/errors.js:9
Parameters
message
string
details?
object
Returns
InvalidFilterIdError
Overrides
Error.constructor

​
Properties

details
details: object | undefined
Defined in: src/primitives/FilterId/errors.js:13
name
name: string
Defined in: src/primitives/FilterId/errors.js:11
Inherited from
Error.name

​
Type Aliases

​
FilterIdType

FilterIdType = string & object
Defined in: src/primitives/FilterId/FilterIdType.ts:8 Filter identifier returned by eth_newFilter, eth_newBlockFilter, eth_newPendingTransactionFilter Opaque identifier used to track active filters on a node. Typically a hex string like “0x1”.

​
Type Declaration

[brand]
readonly [brand]: "FilterId"

​
Functions

​
equals()

equals(a, b): boolean
Defined in: src/primitives/FilterId/equals.js:13 Compare two FilterIds for equality

​
Parameters

a
FilterIdType
b
FilterIdType

​
Returns

boolean

​
Example

import * as FilterId from './primitives/FilterId/index.js';
const equal = FilterId.equals(id1, id2);

​
from()

from(value): FilterIdType
Defined in: src/primitives/FilterId/from.js:15 Create FilterId from string

​
Parameters

value
string Filter ID string

​
Returns

FilterIdType

​
Throws

​
Example

import * as FilterId from './primitives/FilterId/index.js';
const id = FilterId.from("0x1");

​
toString()

toString(filterId): string
Defined in: src/primitives/FilterId/toString.js:13 Convert FilterId to string

​
Parameters

filterId
FilterIdType

​
Returns

string

​
Example

import * as FilterId from './primitives/FilterId/index.js';
const str = FilterId.toString(id); // "0x1"