@ekolabs/iframily - npm Package Compare versions

Comparing version 0.1.3 to 0.1.4

package.json

 {
   "name": "@ekolabs/iframily",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Modern iframes communication",
@@ -5,0 +5,0 @@ "main": "dist/iframily.min.js",

README.md

@@ -33,9 +33,9 @@ # Iframily
 
-### Iframily singleton
+### ⭒ Iframily singleton:
 
 Iframily is a singleton and will allow you to initialize parent/child [iframily instances](#iframily-instance).
 
-#### Iframily.initParent(id, msgHandler, options) -> `iframily instance`
+#### `Iframily.initParent(id, msgHandler, options) -> iframily instance`
 
-#### Iframily.initChild(id, msgHandler, options) -> `iframily instance`
+#### `Iframily.initChild(id, msgHandler, options) -> iframily instance`
 
@@ -53,3 +53,3 @@ Creates a parent/child [iframily instance](#iframily-instance) respectively (to be used in the parent/child frame) and returns it, if successful.
 
-#### Iframily.isIframilyMessage(event) -> `boolean`
+#### `Iframily.isIframilyMessage(event) -> boolean`
 
@@ -72,7 +72,7 @@ If you manually listen to messages using the window ["message" event](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage#The_dispatched_event) you will also receive internal iframily messages. This method will return `true` for this events so you can easily identify them.
 
-### iframily instance
+### ⭒ iframily instance:
 
-The iframily instance is the object returned when initing a new connecter using the `initParent()` or `initChild()` methods.
+The iframily instance is the object returned when initing a new iframily using the `initParent()` or `initChild()` methods.
 
-#### f.sendMessage(msg) -> `Promise`
+#### `f.sendMessage(msg) -> Promise`
 
@@ -87,3 +87,3 @@ | Param           | Type           | Description  |
 
-#### f.dispose()
+#### `f.dispose()`
 
@@ -97,7 +97,7 @@ Dispose of the iframily instance, making it obsolete.
 
-#### f.disposed -> `boolean` (read only)
+#### `f.disposed -> boolean (read only)`
 
 Returns `true` if this iframily instance has been disposed.
 
-#### f.id -> `string` (read only)
+#### `f.id -> string (read only)`
 
@@ -104,0 +104,0 @@ Returns the id that this iframily was inited with.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20632

increased by0.05%

No dependency changes