Skip to content
This repository was archived by the owner on Feb 26, 2021. It is now read-only.

Add flow type signatures. #62

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .flowconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[ignore]
.*/node_modules/documentation/*
.*/node_modules/node_modules/radium/*

[libs]

[include]

[options]
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@
"dependencies": {
"multiaddr": "^3.0.1",
"lodash.uniqby": "^4.7.0",
"peer-id": "~0.10.3"
"peer-id": "~0.10.3",
"callback.flow": "^1.0.0"
},
"contributors": [
"Arnaud <[email protected]>",
Expand Down
19 changes: 19 additions & 0 deletions src/index.js.flow
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// @flow

import type { Callback } from "callback.flow"
import type { PeerId, JSONPeerId } from "peer-id"
import type { MultiaddrSet, Address } from "./multiaddr-set"

export interface PeerInfo {
id: PeerId;
multiaddrs: MultiaddrSet;
connect(Address): void;
disconnect(): void;
isConnected(): boolean;
}

declare export default {
create(Callback<Error, PeerInfo>): void,
create(PeerId | JSONPeerId, Callback<Error, PeerInfo>): void,
isPeerInfo(mixed): boolean
}
22 changes: 22 additions & 0 deletions src/multiaddr-set.js.flow
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// @flow

import type { Multiaddr } from "multiaddr"

export type { Multiaddr }
export type Address = Multiaddr | Buffer | string

export interface MultiaddrSet {
add(Address): void;
addSafe(Address): void;
toArray(): Multiaddr[];
forEach(fn: (Multiaddr, index?: number) => mixed): void;
has(Address): boolean;
delete(Address): void;
replace(existing: Address, fresh: Address): void;
clear(): void;
distinct(): Multiaddr[];
}

declare export default {
(multiaddrs?: Multiaddr[]): MultiaddrSet
}
7 changes: 7 additions & 0 deletions src/utils.js.flow
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// @flow

import type { Multiaddr } from "multiaddr"

declare export var ensureMultiaddr: (
address: string | Buffer | Multiaddr
) => Multiaddr