Skip to content
This repository has been archived by the owner on Jun 26, 2023. It is now read-only.

Commit

Permalink
fix: typescript types (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
wemeetagain authored Nov 3, 2020
1 parent 14d0997 commit 269a6f5
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 11 deletions.
7 changes: 7 additions & 0 deletions src/pubsub/errors.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
export namespace codes {
export const ERR_INVALID_SIGNATURE_POLICY: string;
export const ERR_UNHANDLED_SIGNATURE_POLICY: string;
export const ERR_MISSING_SIGNATURE: string;
export const ERR_MISSING_SEQNO: string;
export const ERR_INVALID_SIGNATURE: string;
export const ERR_UNEXPECTED_FROM: string;
export const ERR_UNEXPECTED_SIGNATURE: string;
export const ERR_UNEXPECTED_KEY: string;
export const ERR_UNEXPECTED_SEQNO: string;
}
22 changes: 12 additions & 10 deletions src/pubsub/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,16 @@ declare class PubsubBaseProtocol {
* @param {String} props.debugName log namespace
* @param {Array<string>|string} props.multicodecs protocol identificers to connect
* @param {Libp2p} props.libp2p
* @param {boolean} [props.signMessages = true] if messages should be signed
* @param {boolean} [props.strictSigning = true] if message signing should be required
* @param {SignaturePolicy} [props.globalSignaturePolicy = SignaturePolicy.StrictSign] defines how signatures should be handled
* @param {boolean} [props.canRelayMessage = false] if can relay messages not subscribed
* @param {boolean} [props.emitSelf = false] if publish should emit to self, if subscribed
* @abstract
*/
constructor({ debugName, multicodecs, libp2p, signMessages, strictSigning, canRelayMessage, emitSelf }: {
constructor({ debugName, multicodecs, libp2p, globalSignaturePolicy, canRelayMessage, emitSelf }: {
debugName: string;
multicodecs: string | string[];
libp2p: any;
signMessages?: boolean;
strictSigning?: boolean;
globalSignaturePolicy?: any;
canRelayMessage?: boolean;
emitSelf?: boolean;
});
Expand Down Expand Up @@ -66,12 +64,12 @@ declare class PubsubBaseProtocol {
* @type {Map<string, import('./peer-streams')>}
*/
peers: Map<string, import('./peer-streams')>;
signMessages: boolean;
/**
* If message signing should be required for incoming messages
* @type {boolean}
* The signature policy to follow by default
*
* @type {string}
*/
strictSigning: boolean;
globalSignaturePolicy: string;
/**
* If router can relay received messages, even if not subscribed
* @type {boolean}
Expand Down Expand Up @@ -284,7 +282,7 @@ declare class PubsubBaseProtocol {
getTopics(): string[];
}
declare namespace PubsubBaseProtocol {
export { message, utils, InMessage, PeerId };
export { message, utils, SignaturePolicy, InMessage, PeerId };
}
type PeerId = import("peer-id");
/**
Expand All @@ -305,3 +303,7 @@ type InMessage = {
*/
declare const message: typeof import('./message');
declare const utils: typeof import("./utils");
declare const SignaturePolicy: {
StrictSign: string;
StrictNoSign: string;
};
2 changes: 1 addition & 1 deletion src/pubsub/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ class PubsubBaseProtocol extends EventEmitter {
/**
* The signature policy to follow by default
*
* @type {SignaturePolicy}
* @type {string}
*/
this.globalSignaturePolicy = globalSignaturePolicy

Expand Down
4 changes: 4 additions & 0 deletions src/pubsub/signature-policy.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export namespace SignaturePolicy {
export const StrictSign: string;
export const StrictNoSign: string;
}
1 change: 1 addition & 0 deletions src/pubsub/utils.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
export function randomSeqno(): Uint8Array;
export function msgId(from: string, seqno: Uint8Array): Uint8Array;
export function noSignMsgId(data: Uint8Array): Uint8Array;
export function anyMatch(a: any[] | Set<any>, b: any[] | Set<any>): boolean;
export function ensureArray(maybeArray: any): any[];
export function normalizeInRpcMessage(message: any, peerId: string): any;
Expand Down

0 comments on commit 269a6f5

Please sign in to comment.