UNPKG

2.51 kBTypeScriptView Raw
1import type { AnyJson, Codec } from '@polkadot/types-codec/types';
2import type { TypeDef } from '@polkadot/types-create/types';
3import type { EventMetadataLatest } from '../interfaces/metadata';
4import type { EventId } from '../interfaces/system';
5import type { IEvent, IEventData, Registry } from '../types';
6import { Struct, Tuple } from '@polkadot/types-codec';
7/**
8 * @name GenericEventData
9 * @description
10 * Wrapper for the actual data that forms part of an [[Event]]
11 */
12export declare class GenericEventData extends Tuple implements IEventData {
13 #private;
14 constructor(registry: Registry, value: Uint8Array, meta: EventMetadataLatest, section?: string, method?: string);
15 /**
16 * @description The wrapped [[EventMetadata]]
17 */
18 get meta(): EventMetadataLatest;
19 /**
20 * @description The method as a string
21 */
22 get method(): string;
23 /**
24 * @description The field names (as available)
25 */
26 get names(): string[] | null;
27 /**
28 * @description The section as a string
29 */
30 get section(): string;
31 /**
32 * @description The [[TypeDef]] for this event
33 */
34 get typeDef(): TypeDef[];
35 /**
36 * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
37 */
38 toHuman(isExtended?: boolean): AnyJson;
39}
40/**
41 * @name GenericEvent
42 * @description
43 * A representation of a system event. These are generated via the [[Metadata]] interfaces and
44 * specific to a specific Substrate runtime
45 */
46export declare class GenericEvent extends Struct implements IEvent<Codec[]> {
47 constructor(registry: Registry, _value?: Uint8Array);
48 /**
49 * @description The wrapped [[EventData]]
50 */
51 get data(): IEvent<Codec[]>['data'];
52 /**
53 * @description The [[EventId]], identifying the raw event
54 */
55 get index(): EventId;
56 /**
57 * @description The [[EventMetadata]] with the documentation
58 */
59 get meta(): EventMetadataLatest;
60 /**
61 * @description The method string identifying the event
62 */
63 get method(): string;
64 /**
65 * @description The section string identifying the event
66 */
67 get section(): string;
68 /**
69 * @description The [[TypeDef]] for the event
70 */
71 get typeDef(): TypeDef[];
72 /**
73 * @description Converts the Object to to a human-friendly JSON, with additional fields, expansion and formatting of information
74 */
75 toHuman(isExpanded?: boolean): Record<string, AnyJson>;
76}