mirror of
https://github.com/fluencelabs/js-libp2p-interfaces
synced 2025-06-19 07:41:24 +00:00
chore: add type generation from jsdoc (#64)
This commit is contained in:
5
src/pubsub/message/index.d.ts
vendored
Normal file
5
src/pubsub/message/index.d.ts
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
export var rpc: any;
|
||||
export var td: any;
|
||||
export var RPC: any;
|
||||
export var Message: any;
|
||||
export var SubOpts: any;
|
@ -6,6 +6,9 @@ const rpcProto = protons(require('./rpc.proto.js'))
|
||||
const RPC = rpcProto.RPC
|
||||
const topicDescriptorProto = protons(require('./topic-descriptor.proto.js'))
|
||||
|
||||
/**
|
||||
* @module pubsub/message/index
|
||||
*/
|
||||
exports = module.exports
|
||||
exports.rpc = rpcProto
|
||||
exports.td = topicDescriptorProto
|
||||
|
2
src/pubsub/message/rpc.proto.d.ts
vendored
Normal file
2
src/pubsub/message/rpc.proto.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
declare const _exports: string;
|
||||
export = _exports;
|
23
src/pubsub/message/sign.d.ts
vendored
Normal file
23
src/pubsub/message/sign.d.ts
vendored
Normal file
@ -0,0 +1,23 @@
|
||||
/**
|
||||
* Returns the PublicKey associated with the given message.
|
||||
* If no, valid PublicKey can be retrieved an error will be returned.
|
||||
*
|
||||
* @param {InMessage} message
|
||||
* @returns {Promise<PublicKey>}
|
||||
*/
|
||||
export function messagePublicKey(message: any): Promise<any>;
|
||||
/**
|
||||
* Signs the provided message with the given `peerId`
|
||||
*
|
||||
* @param {PeerId} peerId
|
||||
* @param {Message} message
|
||||
* @returns {Promise<Message>}
|
||||
*/
|
||||
export function signMessage(peerId: import("peer-id"), message: any): Promise<any>;
|
||||
export const SignPrefix: any;
|
||||
/**
|
||||
* Verifies the signature of the given message
|
||||
* @param {InMessage} message
|
||||
* @returns {Promise<Boolean>}
|
||||
*/
|
||||
export function verifySignature(message: any): Promise<boolean>;
|
2
src/pubsub/message/topic-descriptor.proto.d.ts
vendored
Normal file
2
src/pubsub/message/topic-descriptor.proto.d.ts
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
declare const _exports: string;
|
||||
export = _exports;
|
Reference in New Issue
Block a user