Class Event

Event is the message containing a watch event.

Generated

from message v1.Event

Hierarchy

Message<Event>
- Event

Index

Constructors

Properties

event type fields runtime typeName

Methods

clone equals fromBinary fromJson fromJsonString getType toBinary toJSON toJson toJsonString equals fromBinary fromJson fromJsonString

Constructors

constructor

new Event(data?): Event
Parameters
- Optional data: PartialMessage<Event>
Returns Event
Overrides Message<Event>.constructor
- Defined in v1/plugin_pb.ts:406

Properties

event

event: {
    case: "node";
    value: MeshNode;
} | {
    case: undefined;
    value?: undefined;
} = ...

Event is the data of the watch event.

Type declaration

case: "node"
value: MeshNode
Node is the node that the event is about.

Generated
from field: v1.MeshNode node = 2;

Type declaration

case: undefined
Optional value?: undefined

Generated

from oneof v1.Event.event

type

type: Event_WatchEvent = Event_WatchEvent.UNKNOWN

Type is the type of the watch event.

Generated

from field: v1.Event.WatchEvent type = 1;

`Static` `Readonly` fields

fields: FieldList = ...

`Static` `Readonly` runtime

runtime: ProtoRuntime = proto3

`Static` `Readonly` typeName

typeName: "v1.Event" = "v1.Event"

Methods

clone

clone(): Event
Create a deep copy.

Returns Event
Inherited from Message.clone
- Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:27

equals

equals(other): boolean
Compare with a message of the same type.
Parameters
- other: undefined | null | Event | PlainMessage<Event>
Returns boolean
Inherited from Message.equals
- Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:23

fromBinary

fromBinary(bytes, options?): Event
Parse from binary data, merging fields.

Repeated fields are appended. Map entries are added, overwriting existing keys.

If a message field is already present, it will be merged with the new data.
Parameters
- bytes: Uint8Array
- Optional options: Partial<BinaryReadOptions>
Returns Event
Inherited from Message.fromBinary
- Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:37

fromJson

fromJson(jsonValue, options?): Event
Parse a message from a JSON value.
Parameters
- jsonValue: JsonValue
- Optional options: Partial<JsonReadOptions>
Returns Event
Inherited from Message.fromJson
- Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:41

fromJsonString

fromJsonString(jsonString, options?): Event
Parse a message from a JSON string.
Parameters
- jsonString: string
- Optional options: Partial<JsonReadOptions>
Returns Event
Inherited from Message.fromJsonString
- Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:45

getType

getType(): MessageType<Event>
Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

Returns MessageType<Event>
Inherited from Message.getType
- Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:80

toBinary

toBinary(options?): Uint8Array
Serialize the message to binary data.
Parameters
- Optional options: Partial<BinaryWriteOptions>
Returns Uint8Array
Inherited from Message.toBinary
- Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:49

`Protected` toJSON

toJSON(): JsonValue
Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

Returns JsonValue
Inherited from Message.toJSON
- Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:74

toJson

toJson(options?): JsonValue
Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().
Parameters
- Optional options: Partial<JsonWriteOptions>
Returns JsonValue
Inherited from Message.toJson
- Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:54

toJsonString

toJsonString(options?): string
Serialize the message to a JSON string.
Parameters
- Optional options: Partial<JsonWriteStringOptions>
Returns string
Inherited from Message.toJsonString
- Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:58

`Static` equals

equals(a, b): boolean
Parameters
- a: undefined | Event | PlainMessage<Event>
- b: undefined | Event | PlainMessage<Event>
Returns boolean
- Defined in v1/plugin_pb.ts:430

`Static` fromBinary

fromBinary(bytes, options?): Event
Parameters
- bytes: Uint8Array
- Optional options: Partial<BinaryReadOptions>
Returns Event
- Defined in v1/plugin_pb.ts:418

`Static` fromJson

fromJson(jsonValue, options?): Event
Parameters
- jsonValue: JsonValue
- Optional options: Partial<JsonReadOptions>
Returns Event
- Defined in v1/plugin_pb.ts:422

`Static` fromJsonString

fromJsonString(jsonString, options?): Event
Parameters
- jsonString: string
- Optional options: Partial<JsonReadOptions>
Returns Event
- Defined in v1/plugin_pb.ts:426

Generated using TypeDoc