> ## Documentation Index
> Fetch the complete documentation index at: https://voltaire.tevm.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# primitives/LogIndex

> Auto-generated API documentation

[**@tevm/voltaire**](../index.mdx)

***

[@tevm/voltaire](../index.mdx) / primitives/LogIndex

# primitives/LogIndex

## Classes

### InvalidLogIndexError

Defined in: [src/primitives/LogIndex/errors.js:1](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/LogIndex/errors.js#L1)

#### Extends

* `Error`

#### Constructors

##### Constructor

> **new InvalidLogIndexError**(`message`, `details?`): [`InvalidLogIndexError`](#invalidlogindexerror)

Defined in: [src/primitives/LogIndex/errors.js:8](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/LogIndex/errors.js#L8)

###### Parameters

###### message

`string`

###### details?

###### expected?

`string`

###### value?

`unknown`

###### Returns

[`InvalidLogIndexError`](#invalidlogindexerror)

###### Overrides

`Error.constructor`

#### Properties

##### details

> **details**: \{ `expected?`: `string`; `value?`: `unknown`; } | `undefined`

Defined in: [src/primitives/LogIndex/errors.js:12](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/LogIndex/errors.js#L12)

##### name

> **name**: `string`

Defined in: [src/primitives/LogIndex/errors.js:10](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/LogIndex/errors.js#L10)

###### Inherited from

`Error.name`

## Type Aliases

### LogIndexType

> **LogIndexType** = `number` & `object`

Defined in: [src/primitives/LogIndex/LogIndexType.ts:6](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/LogIndex/LogIndexType.ts#L6)

Log index in receipt (0-based)

#### Type Declaration

##### \[brand]

> `readonly` **\[brand]**: `"LogIndex"`

## Variables

### equals()

> `const` **equals**: (`a`, `b`) => `boolean` = `_equals`

Defined in: [src/primitives/LogIndex/index.ts:10](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/LogIndex/index.ts#L10)

Check if two LogIndexes are equal

#### Parameters

##### a

[`LogIndexType`](#logindextype)

##### b

[`LogIndexType`](#logindextype)

#### Returns

`boolean`

***

### from()

> `const` **from**: (`value`) => [`LogIndexType`](#logindextype) = `_from`

Defined in: [src/primitives/LogIndex/index.ts:8](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/LogIndex/index.ts#L8)

Create LogIndex from number

#### Parameters

##### value

`number` | `bigint`

#### Returns

[`LogIndexType`](#logindextype)

#### Throws

***

### toNumber()

> `const` **toNumber**: (`index`) => `number` = `_toNumber`

Defined in: [src/primitives/LogIndex/index.ts:9](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/LogIndex/index.ts#L9)

Convert LogIndex to number

#### Parameters

##### index

[`LogIndexType`](#logindextype)

#### Returns

`number`