Class: Peer
protocol.Peer
Represents a Peer.
Implements
Constructors
constructor
• new Peer(properties?): Peer
Constructs a new Peer.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPeer | Properties to set |
Returns
Properties
id
• id: string
Peer id.
Implementation of
metadata
• metadata: string
Peer metadata.
Implementation of
username
• username: string
Peer username.
Implementation of
Methods
create
▸ create(properties?): Peer
Creates a new Peer instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPeer | Properties to set |
Returns
Peer instance
decode
▸ decode(reader, length?): Peer
Decodes a Peer message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Reader | Uint8Array | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Peer
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Peer
Decodes a Peer message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Reader | Uint8Array | Reader or buffer to decode from |
Returns
Peer
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified Peer message. Does not implicitly verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPeer | Peer message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Peer message, length delimited. Does not implicitly verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPeer | Peer message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Peer
Creates a Peer message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Peer
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Peer
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toJSON
▸ toJSON(): Object
Converts this Peer to JSON.
Returns
Object
JSON object
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Peer message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Peer | Peer |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object
verify
▸ verify(message): string
Verifies a Peer message.
Parameters
| Name | Type | Description |
|---|---|---|
message | Object | Plain object to verify |
Returns
string
null if valid, otherwise the reason why it is not