mirror of
https://github.com/fluencelabs/gitbook-docs
synced 2024-12-04 15:20:24 +00:00
Fix call params doc
This commit is contained in:
Pavel Murygin
parent
031fe19168
commit
30eeb0116f
@ -31,7 +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/c2e280d/src/internal/FluencePeer.ts#L111)
|
||||
[internal/FluencePeer.ts:111](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/FluencePeer.ts#L111)
|
||||
|
||||
## Accessors
|
||||
|
||||
@ -47,7 +47,7 @@ Get the information about Fluence Peer connections
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/FluencePeer.ts:116](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L116)
|
||||
[internal/FluencePeer.ts:116](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/FluencePeer.ts#L116)
|
||||
|
||||
___
|
||||
|
||||
@ -68,7 +68,7 @@ Does not intended to be used manually. Subject to change
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/FluencePeer.ts:190](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L190)
|
||||
[internal/FluencePeer.ts:190](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/FluencePeer.ts#L190)
|
||||
|
||||
___
|
||||
|
||||
@ -85,7 +85,7 @@ by the Aqua compiler if not specified otherwise.
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/FluencePeer.ts:181](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L181)
|
||||
[internal/FluencePeer.ts:181](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/FluencePeer.ts#L181)
|
||||
|
||||
## Methods
|
||||
|
||||
@ -108,7 +108,7 @@ and (optionally) connect to the Fluence network
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/FluencePeer.ts:130](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L130)
|
||||
[internal/FluencePeer.ts:130](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/FluencePeer.ts#L130)
|
||||
|
||||
___
|
||||
|
||||
@ -125,4 +125,4 @@ and disconnects from the Fluence network
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/FluencePeer.ts:172](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L172)
|
||||
[internal/FluencePeer.ts:172](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/FluencePeer.ts#L172)
|
||||
|
||||
92
js-sdk/6-reference/interfaces/CallParams.md
Normal file
92
js-sdk/6-reference/interfaces/CallParams.md
Normal file
@ -0,0 +1,92 @@
|
||||
# Interface: CallParams<ArgName\>
|
||||
|
||||
Additional information about a service call
|
||||
|
||||
## Type parameters
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `ArgName` | extends `string` \| ``null`` |
|
||||
|
||||
## Table of contents
|
||||
|
||||
### Properties
|
||||
|
||||
- [initPeerId](js-sdk/6_reference/interfaces/CallParams.md#initpeerid)
|
||||
- [particleId](js-sdk/6_reference/interfaces/CallParams.md#particleid)
|
||||
- [signature](js-sdk/6_reference/interfaces/CallParams.md#signature)
|
||||
- [tetraplets](js-sdk/6_reference/interfaces/CallParams.md#tetraplets)
|
||||
- [timeStamp](js-sdk/6_reference/interfaces/CallParams.md#timestamp)
|
||||
- [ttl](js-sdk/6_reference/interfaces/CallParams.md#ttl)
|
||||
|
||||
## Properties
|
||||
|
||||
### initPeerId
|
||||
|
||||
• **initPeerId**: `string`
|
||||
|
||||
The peer id which created the particle
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/commonTypes.ts:36](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/commonTypes.ts#L36)
|
||||
|
||||
___
|
||||
|
||||
### particleId
|
||||
|
||||
• **particleId**: `string`
|
||||
|
||||
The identifier of particle which triggered the call
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/commonTypes.ts:31](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/commonTypes.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### signature
|
||||
|
||||
• **signature**: `string`
|
||||
|
||||
Particle's signature
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/commonTypes.ts:51](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/commonTypes.ts#L51)
|
||||
|
||||
___
|
||||
|
||||
### tetraplets
|
||||
|
||||
• **tetraplets**: { [key in string]: SecurityTetraplet[]}
|
||||
|
||||
Security tetraplets
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/commonTypes.ts:56](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/commonTypes.ts#L56)
|
||||
|
||||
___
|
||||
|
||||
### timeStamp
|
||||
|
||||
• **timeStamp**: `number`
|
||||
|
||||
Particle's timestamp when it was created
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/commonTypes.ts:41](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/commonTypes.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### ttl
|
||||
|
||||
• **ttl**: `number`
|
||||
|
||||
Time to live in milliseconds. The time after the particle should be expired
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/commonTypes.ts:46](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/commonTypes.ts#L46)
|
||||
@ -6,6 +6,10 @@
|
||||
|
||||
- [FluencePeer](js-sdk/6_reference/classes/FluencePeer.md)
|
||||
|
||||
### Interfaces
|
||||
|
||||
- [CallParams](js-sdk/6_reference/interfaces/CallParams.md)
|
||||
|
||||
### Type aliases
|
||||
|
||||
- [AvmLoglevel](js-sdk/6_reference/modules.md#avmloglevel)
|
||||
@ -29,7 +33,7 @@ Possible values: 'info', 'trace', 'debug', 'info', 'warn', 'error', 'off';
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/FluencePeer.ts:35](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/FluencePeer.ts#L35)
|
||||
[internal/FluencePeer.ts:35](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/FluencePeer.ts#L35)
|
||||
|
||||
___
|
||||
|
||||
@ -41,7 +45,7 @@ Peer ID's id as a base58 string (multihash/CIDv0).
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/commonTypes.ts:20](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/commonTypes.ts#L20)
|
||||
[internal/commonTypes.ts:22](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/commonTypes.ts#L22)
|
||||
|
||||
## Functions
|
||||
|
||||
@ -65,7 +69,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/c2e280d/src/internal/peerIdUtils.ts#L26)
|
||||
[internal/peerIdUtils.ts:26](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/peerIdUtils.ts#L26)
|
||||
|
||||
___
|
||||
|
||||
@ -89,7 +93,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/c2e280d/src/internal/peerIdUtils.ts#L45)
|
||||
[internal/peerIdUtils.ts:45](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/peerIdUtils.ts#L45)
|
||||
|
||||
___
|
||||
|
||||
@ -107,7 +111,7 @@ Generates a new peer id with random private key
|
||||
|
||||
#### Defined in
|
||||
|
||||
[internal/peerIdUtils.ts:59](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/internal/peerIdUtils.ts#L59)
|
||||
[internal/peerIdUtils.ts:59](https://github.com/fluencelabs/fluence-js/blob/480d630/src/internal/peerIdUtils.ts#L59)
|
||||
|
||||
___
|
||||
|
||||
@ -127,4 +131,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
[index.ts:23](https://github.com/fluencelabs/fluence-js/blob/c2e280d/src/index.ts#L23)
|
||||
[index.ts:23](https://github.com/fluencelabs/fluence-js/blob/480d630/src/index.ts#L23)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user