fluencelabs/gitbook-docs
1
0
Fork 0
mirror of https://github.com/fluencelabs/gitbook-docs synced 2025-06-11 22:11:30 +00:00
Code Issues Projects Releases Wiki Activity

Update auto-generated docs

Browse Source
This commit is contained in:
Pavel Murygin
2021-09-07 00:09:35 +03:00
parent 0ed7f1e811
commit 1a922f0077
2 changed files with 33 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
js-sdk/6-reference/classes/FluencePeer.md
View File

@ -9,19 +9,15 @@ It provides all the necessary features to communicate with Fluence network
- [constructor](js-sdk/6_reference/classes/FluencePeer.md#constructor)
### Properties
- [callServiceHandler](js-sdk/6_reference/classes/FluencePeer.md#callservicehandler)
### Accessors
- [connectionInfo](js-sdk/6_reference/classes/FluencePeer.md#connectioninfo)
- [internals](js-sdk/6_reference/classes/FluencePeer.md#internals)
- [default](js-sdk/6_reference/classes/FluencePeer.md#default)
### Methods
- [init](js-sdk/6_reference/classes/FluencePeer.md#init)
- [initiateFlow](js-sdk/6_reference/classes/FluencePeer.md#initiateflow)
- [uninit](js-sdk/6_reference/classes/FluencePeer.md#uninit)
## Constructors
@ -35,17 +31,7 @@ In order to work with the Peer it has to be initialized with the `init` method
#### Defined in
[internal/FluencePeer.ts:111](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/internal/FluencePeer.ts#L111)
## Properties
### callServiceHandler
• **callServiceHandler**: `CallServiceHandler`
#### Defined in
[internal/FluencePeer.ts:201](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/internal/FluencePeer.ts#L201)
[internal/FluencePeer.ts:111](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L111)
## Accessors
@ -61,7 +47,28 @@ Get the information about Fluence Peer connections
#### Defined in
[internal/FluencePeer.ts:116](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/internal/FluencePeer.ts#L116)
[internal/FluencePeer.ts:116](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L116)
___
### internals
• `get` **internals**(): `Object`
Does not intended to be used manually. Subject to change
#### Returns
`Object`
| Name | Type |
| :------ | :------ |
| `callServiceHandler` | `CallServiceHandler` |
| `initiateFlow` | (`request`: `RequestFlow`) => `Promise`<`void`\> |
#### Defined in
[internal/FluencePeer.ts:190](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L190)
___
@ -78,7 +85,7 @@ by the Aqua compiler if not specified otherwise.
#### Defined in
[internal/FluencePeer.ts:181](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/internal/FluencePeer.ts#L181)
[internal/FluencePeer.ts:181](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L181)
## Methods
@ -101,27 +108,7 @@ and (optionally) connect to the Fluence network
#### Defined in
[internal/FluencePeer.ts:130](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/internal/FluencePeer.ts#L130)
___
### initiateFlow
▸ **initiateFlow**(`request`): `Promise`<`void`\>
#### Parameters
| Name | Type |
| :------ | :------ |
| `request` | `RequestFlow` |
#### Returns
`Promise`<`void`\>
#### Defined in
[internal/FluencePeer.ts:187](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/internal/FluencePeer.ts#L187)
[internal/FluencePeer.ts:130](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L130)
___
@ -138,4 +125,4 @@ and disconnects from the Fluence network
#### Defined in
[internal/FluencePeer.ts:172](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/internal/FluencePeer.ts#L172)
[internal/FluencePeer.ts:172](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L172)

12
js-sdk/6-reference/modules.md
View File

@ -29,7 +29,7 @@ Possible values: 'info', 'trace', 'debug', 'info', 'warn', 'error', 'off';
#### Defined in
[internal/FluencePeer.ts:35](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/internal/FluencePeer.ts#L35)
[internal/FluencePeer.ts:35](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L35)
___
@ -41,7 +41,7 @@ Peer ID's id as a base58 string (multihash/CIDv0).
#### Defined in
[internal/commonTypes.ts:20](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/internal/commonTypes.ts#L20)
[internal/commonTypes.ts:20](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/commonTypes.ts#L20)
## Functions
@ -65,7 +65,7 @@ Generates a new peer id from base64 string contatining the 32 byte Ed25519S secr
#### Defined in
[internal/peerIdUtils.ts:26](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/internal/peerIdUtils.ts#L26)
[internal/peerIdUtils.ts:26](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/peerIdUtils.ts#L26)
___
@ -89,7 +89,7 @@ Converts peer id into base64 string contatining the 32 byte Ed25519S secret key
#### Defined in
[internal/peerIdUtils.ts:45](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/internal/peerIdUtils.ts#L45)
[internal/peerIdUtils.ts:45](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/peerIdUtils.ts#L45)
___
@ -107,7 +107,7 @@ Generates a new peer id with random private key
#### Defined in
[internal/peerIdUtils.ts:59](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/internal/peerIdUtils.ts#L59)
[internal/peerIdUtils.ts:59](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/peerIdUtils.ts#L59)
___
@ -127,4 +127,4 @@ ___
#### Defined in
[index.ts:23](https://github.com/fluencelabs/fluence-js/blob/284a59b/src/index.ts#L23)
[index.ts:23](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/index.ts#L23)