name: Event

description: A representation of a system event. These are generated via the Metadata interfaces and specific to a specific Substrate runtime

Type parameters

S : ConstructorDef

T : object

V : object

E : object

Hierarchy

↳ Struct

↳ Event

Implements

• Codec

Constructors

constructor

⊕ new Event(value: Uint8Array): [Event](_event.event.md)

Overrides Struct.constructor

Defined in Event.ts:85

Parameters:

Returns: Event

Properties

__@toStringTag

● __@toStringTag: string

Inherited from Map.[Symbol.toStringTag]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:130

size

● size: number

Inherited from Map.size

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:28

Accessors

Type

getType(): E

Inherited from Struct.Type

Defined in codec/Struct.ts:142

description: Returns the Type description to sthe structure

Returns: E

data

getdata(): EventData

Defined in Event.ts:138

description: The wrapped EventData

Returns: EventData

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

index

getindex(): EventIndex

Defined in Event.ts:145

description: The EventIndex, identifying the raw event

Returns: EventIndex

meta

getmeta(): EventMetadata

Defined in Event.ts:152

description: The EventMetadata with the documentation

Returns: EventMetadata

method

getmethod(): string

Defined in Event.ts:159

description: The method string identifying the event

Returns: string

section

getsection(): string

Defined in Event.ts:166

description: The section string identifying the event

Returns: string

typeDef

gettypeDef(): Array<TypeDef>

Defined in Event.ts:173

description: The TypeDef for the event

Returns: Array<TypeDef>

Methods

__@iterator

▸ __@iterator(): IterableIterator<[keyof S, Codec]>

Inherited from Map.[Symbol.iterator]

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:113

Returns an iterable of entries in the map.

Returns: IterableIterator<[keyof S, Codec]>

clear

▸ clear(): void

Inherited from Map.clear

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:22

Returns: void

delete

▸ delete(key: keyof S): boolean

Inherited from Map.delete

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:23

Parameters:

Returns: boolean

entries

▸ entries(): IterableIterator<[keyof S, Codec]>

Inherited from Map.entries

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:118

Returns an iterable of key, value pairs for every entry in the map.

Returns: IterableIterator<[keyof S, Codec]>

forEach

▸ forEach(callbackfn: function, thisArg?: any): void

Inherited from Map.forEach

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:24

Parameters:

Returns: void

get

▸ get(name: keyof S): Codec | undefined

Inherited from Struct.get

Overrides Map.get

Defined in codec/Struct.ts:159

description: Returns a specific names entry in the structure

Parameters:

Returns: Codec | undefined

getAtIndex

▸ getAtIndex(index: number): Codec

Inherited from Struct.getAtIndex

Defined in codec/Struct.ts:166

description: Returns the values of a member at a specific index (Rather use get(name) for performance)

Parameters:

Returns: Codec

has

▸ has(key: keyof S): boolean

Inherited from Map.has

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:26

Parameters:

Returns: boolean

keys

▸ keys(): IterableIterator<keyof S>

Inherited from Map.keys

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:123

Returns an iterable of keys in the map

Returns: IterableIterator<keyof S>

set

▸ set(key: keyof S, value: Codec): this

Inherited from Map.set

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.collection.d.ts:27

Parameters:

Returns: this

toArray

▸ toArray(): Array<Codec>

Inherited from Struct.toArray

Defined in codec/Struct.ts:173

description: Converts the Object to an standard JavaScript Array

Returns: Array<Codec>

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from Struct.toHex

Defined in codec/Struct.ts:180

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from Struct.toJSON

Defined in codec/Struct.ts:187

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:201

description: Returns the string representation of the value

Returns: string

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Inherited from Struct.toU8a

Defined in codec/Struct.ts:209

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Returns: Uint8Array

values

▸ values(): IterableIterator<Codec>

Inherited from Map.values

Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:128

Returns an iterable of values in the map

Returns: IterableIterator<Codec>

<Static> decodeEvent

▸ decodeEvent(value: Uint8Array): object

Defined in Event.ts:97

Parameters:

Returns: object

<Static> injectMetadata

▸ injectMetadata(metadata: Metadata): void

Defined in Event.ts:116

Parameters:

Returns: void

<Static> with

▸ with<S>(Types: S): Constructor<Struct<S>>

Inherited from Struct.with

Defined in codec/Struct.ts:122

Type parameters:

S : ConstructorDef

Parameters:

Returns: Constructor<Struct<S>>