Web3-bzz types

packages/web3-bzz/README.md

@@ -32,6 +32,10 @@ import {Bzz} from 'web3-bzz';
 const bzz = new Bzz('http://swarm-gateways.net');
 ```
 
+## Types 
+
+If you are using TypeScript all the types are defined in the `index.d.ts` file
+
 
 [docs]: http://web3js.readthedocs.io/en/1.0/
 [repo]: https://github.com/ethereum/web3.js

packages/web3-bzz/index.d.ts

@@ -0,0 +1,29 @@
+/*
+    This file is part of web3.js.
+    web3.js is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+    web3.js is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+    You should have received a copy of the GNU Lesser General Public License
+    along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+/**
+ * @file index.d.ts
+ * @author Josh Stevens <[email protected]>
+ * @date 2018
+ */
+
+export declare class Bzz {
+    constructor(provider: Object | string) { }
+    pick(): Object | boolean;
+    download(bzzHash: string, localPath: string): Promise<Buffer|Object|string>;
+    upload(data: string | Buffer | Uint8Array | Object): Promise<string>;
+    isAvailable(): Promise<boolean>;
+    hasProvider(): boolean;
+    throwProviderError();
+    setProvider(provider: Object | string): boolean;
+}

packages/web3-bzz/package.json

@@ -18,6 +18,7 @@
         "underscore-es": "^1.9.8"
     },
     "files": [
-        "dist"
+        "dist",
+        "index.d.ts"
     ]
 }

packages/web3-utils/index.d.ts

@@ -1,3 +1,22 @@
+/*
+    This file is part of web3.js.
+    web3.js is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+    web3.js is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Lesser General Public License for more details.
+    You should have received a copy of the GNU Lesser General Public License
+    along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+/**
+ * @file index.d.ts
+ * @author Josh Stevens <[email protected]>
+ * @date 2018
+ */
+
 import BigNumber from "bn.js";
 
 export type Unit =