waku-org/js-waku
1
0
Fork 0
mirror of https://github.com/waku-org/js-waku.git synced 2025-02-17 14:57:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add comments on Waku Message Options

Browse Source
This commit is contained in:
Franck Royer 2021-07-14 16:51:04 +10:00
parent 57f65267c2
commit 56c30059b2
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/lib/waku_message/index.ts
View File

@ -14,9 +14,23 @@ const DefaultVersion = 0;
const dbg = debug('waku:message'); const dbg = debug('waku:message');
export interface Options { export interface Options {
/**
* Content topic to set on the message, defaults to {@link DefaultContentTopic}
* if not passed.
*/
contentTopic?: string; contentTopic?: string;
/**
* Timestamp to set on the message, defaults to now if not passed.
*/
timestamp?: Date; timestamp?: Date;
/**
* Public Key to use to encrypt the messages using ECIES (Asymmetric Encryption).
*/
encPublicKey?: Uint8Array | string; encPublicKey?: Uint8Array | string;
/**
* Private key to use to sign the message, `encPublicKey` must be provided as only
* encrypted messages are signed.
*/
sigPrivKey?: Uint8Array; sigPrivKey?: Uint8Array;
} }