name: EventRecord
description: A record for an Event (as specified by Metadata) with the specific Phase of application.
Type parameters
S : ConstructorDef
T : object
V : object
E : object
Hierarchy
↳ Struct
↳ EventRecord
Implements
Constructors
constructor
⊕ new EventRecord(value: any): EventRecord
Overrides Struct.constructor
Defined in EventRecord.ts:61
Parameters:
| Name | Type |
|---|---|
| value | any |
Returns: EventRecord
Accessors
Type
getType(): E
Defined in codec/Struct.ts:142
description: Returns the Type description to sthe structure
Returns: E
encodedLength
getencodedLength(): number
Inherited from Struct.encodedLength
Defined in codec/Struct.ts:149
description: The length of the value when encoded as a Uint8Array
Returns: number
event
getevent(): Event
Defined in EventRecord.ts:72
description: The Event this record refers to
Returns: Event
phase
getphase(): Phase
Defined in EventRecord.ts:79
description: The Phase where the event was generated
Returns: Phase
Methods
eq
▸ eq(other?: any): boolean
Defined in codec/Struct.ts:158
description: Compares the value of the input to see if there is a match
Parameters:
| Name | Type |
|---|---|
Optional other |
any |
Returns: boolean
get
▸ get(name: keyof S): Codec | undefined
Overrides Map.get
Defined in codec/Struct.ts:166
description: Returns a specific names entry in the structure
Parameters:
| Name | Type | Description |
|---|---|---|
| name | keyof S |
The name of the entry to retrieve |
Returns: Codec | undefined
getAtIndex
▸ getAtIndex(index: number): Codec
Inherited from Struct.getAtIndex
Defined in codec/Struct.ts:173
description: Returns the values of a member at a specific index (Rather use get(name) for performance)
Parameters:
| Name | Type |
|---|---|
| index | number |
Returns: Codec
toArray
▸ toArray(): Array<Codec>
Defined in codec/Struct.ts:180
description: Converts the Object to an standard JavaScript Array
Returns: Array<Codec>
toHex
▸ toHex(): string
Defined in codec/Struct.ts:187
description: Returns a hex string representation of the value
Returns: string
toJSON
▸ toJSON(): any
Implementation of Codec.toJSON
Defined in codec/Struct.ts:194
description: Converts the Object to JSON, typically used for RPC transfers
Returns: any
toString
▸ toString(): string
Implementation of Codec.toString
Inherited from Struct.toString
Defined in codec/Struct.ts:208
description: Returns the string representation of the value
Returns: string
toU8a
▸ toU8a(isBare?: undefined | false | true): Uint8Array
Defined in codec/Struct.ts:216
description: Encodes the value as a Uint8Array as per the parity-codec specifications
Parameters:
| Name | Type | Description | ||
|---|---|---|---|---|
Optional isBare |
undefined |
false |
true |
true when the value has none of the type-specific prefixes (internal) |
Returns: Uint8Array
<Static> with
▸ with<S>(Types: S): Constructor<Struct<S>>
Defined in codec/Struct.ts:122
Type parameters:
S : ConstructorDef
Parameters:
| Name | Type |
|---|---|
| Types | S |
Returns: Constructor<Struct<S>>