Merge pull request #79 from Gozala/flowtypes

feat: add flow typedefs
multiformats · Apr 4, 2019 · a75da83 · a75da83
2 parents 537f604 + 1cf9740
commit a75da83
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 0 deletions.
diff --git a/.flowconfig b/.flowconfig
@@ -0,0 +1,11 @@
+[ignore]
+
+[include]
+
+[libs]
+
+[lints]
+
+[options]
+
+[strict]
diff --git a/src/index.js.flow b/src/index.js.flow
@@ -0,0 +1,32 @@
+// @flow strict
+
+export type Version = 0 | 1
+export type Codec = string
+export type Multihash = Buffer
+export type BaseEncodedString = string
+
+declare class CID<a> {
+  constructor(Version, Codec, Multihash): void;
+  constructor(BaseEncodedString): void;
+  constructor(Buffer): void;
+
+  +codec: Codec;
+  +multihash: Multihash;
+  +buffer: Buffer;
+  +prefix: Buffer;
+
+  toV0(): CID<a>;
+  toV1(): CID<a>;
+  toBaseEncodedString(base?: string): BaseEncodedString;
+  toString(): BaseEncodedString;
+  toJSON(): { codec: Codec, version: Version, hash: Multihash };
+
+  equals(mixed): boolean;
+
+  static codecs: { [string]: Codec };
+  static isCID(mixed): boolean;
+  static validateCID(mixed): void;
+}
+
+export default CID
+export type { CID }