loginterface 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -8,4 +8,4 @@
  * this.http.get('/endpoint').pipe(map(res => res.data), generateInterface('Interface name'))
  * ```
  */
-export declare const logInterface: (interfaceName: string) => any;
+export declare const logInterface: (interfaceName: string) => import("rxjs").MonoTypeOperatorFunction<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "loginterface",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/readme.md

@@ -0,0 +1,45 @@
+# logInterface
+RxJS operator that generates interfaces and logs them into console with styling. Simply copy from console into your file
+
+### Example usage (Angular)
+```ts
+this.http.get('/endpoint').pipe(logInterface('Interface name'))
+```
+#### Example
+```ts
+const person = {
+    name: 'John',
+    lastname: 'Doe',
+    age: 30,
+    address:{
+        street: 'Highroad',
+        number: 100
+    },
+    items: [
+        { pencil: true, gloves: true }
+    ]
+}
+
+of(person).pipe(logInterface('Person')).subscribe()
+//will log the following into console
+
+export interface Person {
+  name: string;
+  lastname: string;
+  age: number;
+  address: PersonAddress;
+  items: PersonItems[];
+}
+
+interface PersonAddress {
+  street: string;
+  streetNumber: number;
+}
+
+interface PersonItems {
+  pencil: boolean;
+  gloves: boolean;
+}
+
+
+```