Class EventID

Hierarchy

EventID

Index

Constructors

Properties

Accessors

bytes controller event eventHeight init networkID separator

Methods

[toPrimitive] equals toString toUrl create createRandom fromBytes fromString isInstance

Constructors

constructor

new EventID(networkID: number, separator: Uint8Array, controller: Uint8Array, init: Uint8Array, eventHeight: number, event: CID<unknown, number, number, Version>): EventID
Create a new EventID.
Parameters
- networkID: number
- separator: Uint8Array
- controller: Uint8Array
- init: Uint8Array
- eventHeight: number
- event: CID<unknown, number, number, Version>
Returns EventID
- Defined in packages/streamid/src/event-id.ts:71

Properties

`Protected` `Readonly` _tag

_tag: symbol = TAG

Accessors

bytes

get bytes(): Uint8Array
Bytes representation of EventID.

Returns Uint8Array
- Defined in packages/streamid/src/event-id.ts:156

controller

get controller(): Uint8Array
Controller Bytes (8)

Returns Uint8Array
- Defined in packages/streamid/src/event-id.ts:257

event

get event(): CID<unknown, number, number, Version>
Event CID

Returns CID<unknown, number, number, Version>
- Defined in packages/streamid/src/event-id.ts:278

eventHeight

get eventHeight(): number
Event Height

Returns number
- Defined in packages/streamid/src/event-id.ts:271

init

get init(): Uint8Array
Init CID last 4 bytes (8)

Returns Uint8Array
- Defined in packages/streamid/src/event-id.ts:264

networkID

get networkID(): number
EventID network id

Returns number
- Defined in packages/streamid/src/event-id.ts:243

separator

get separator(): Uint8Array
Seperator Bytes (8)

Returns Uint8Array
- Defined in packages/streamid/src/event-id.ts:250

Methods

[toPrimitive]

[toPrimitive](): string
String representation of EventID.

Returns string
- Defined in packages/streamid/src/event-id.ts:292

equals

equals(other: EventID): boolean
Compare equality with another EventID.
Parameters
- other: EventID
Returns boolean
- Defined in packages/streamid/src/event-id.ts:217

toString

toString(): string
Encode the EventID into a string.

Returns string
- Defined in packages/streamid/src/event-id.ts:209

toUrl

toUrl(): string
Encode the EventID into a base36 url.

Returns string
- Defined in packages/streamid/src/event-id.ts:235

`Static` create

create(networkID: string | number, networkIDOffset: number, separatorKey: string | Uint8Array, separatorValue: string | Uint8Array, controller: string, init: string | CID<unknown, number, number, Version>, eventHeight: number, event: string | CID<unknown, number, number, Version>): EventID
Create a new EventID.
Parameters
- networkID: string | number
- networkIDOffset: number
- separatorKey: string | Uint8Array
- separatorValue: string | Uint8Array
- controller: string
- init: string | CID<unknown, number, number, Version>
- eventHeight: number
- event: string | CID<unknown, number, number, Version>
Returns EventID
- Defined in packages/streamid/src/event-id.ts:117

`Static` createRandom

createRandom(networkID: string | number, networkIDOffset: number, optionalParams?: CreateRandomOptionalParams): EventID
Parameters
- networkID: string | number
- networkIDOffset: number
- optionalParams: CreateRandomOptionalParams = {}
Returns EventID
- Defined in packages/streamid/src/event-id.ts:87

`Static` fromBytes

fromBytes(bytes: Uint8Array): EventID
EventID instance from bytes
Parameters
- bytes: Uint8Array
Returns EventID
- Defined in packages/streamid/src/event-id.ts:178

`Static` fromString

fromString(str: string): EventID
EventID instance from base36 string
Parameters
- str: string
Returns EventID
- Defined in packages/streamid/src/event-id.ts:201

`Static` isInstance

isInstance(instance: any): instance is EventID
Parameters
- instance: any
Returns instance is EventID
- Defined in packages/streamid/src/event-id.ts:64