Added neighbor class
@@ -1,3 +1,34 @@
|
||||
# ModuleClientApi - Neighbor
|
||||
|
||||
Class representing a Neighbor of the ModuleClientAPI User.
|
||||
|
||||
## Methods
|
||||
|
||||
Send a packet to this neighbor.
|
||||
|
||||
```javascript
|
||||
Neighbor.send(header, ...args);
|
||||
```
|
||||
|
||||
| Argument | Type | Description |
|
||||
| -------- | ------ | -------------------------- |
|
||||
| header | string | The header of the message. |
|
||||
| args | any[] | Data of any type. |
|
||||
|
||||
## Constants
|
||||
|
||||
## moduleType
|
||||
|
||||
The type of the module.
|
||||
|
||||
```javascript
|
||||
Neighbor.moduleType;
|
||||
```
|
||||
|
||||
## moduleId
|
||||
|
||||
The id of the module.
|
||||
|
||||
```javascript
|
||||
Neighbor.moduleId;
|
||||
```
|
||||
|
||||
@@ -73,7 +73,7 @@ NeighborResults.last();
|
||||
|
||||
**Returns** [Neighbor](./ModuleClientAPINeighbor) _Neighbor instance._
|
||||
|
||||
## Attributes
|
||||
## Constants
|
||||
|
||||
### length
|
||||
|
||||
|
||||
Reference in New Issue
Block a user