@types/basiclightbox - npm Package Compare versions

Comparing version 5.0.0 to 5.0.1

basiclightbox/index.d.ts

@@ -36,7 +36,7 @@ // Type definitions for basiclightbox 5.0
      */
-    closable?: boolean;
+    closable?: boolean | undefined;
     /*
      * One or more space separated classes to be added to the basicLightbox element.
      */
-    className?: string;
+    className?: string | undefined;
     /*
@@ -46,3 +46,3 @@ * Function that gets executed before the lightbox will be shown.
      */
-    onShow?: (instance: BasicLightBox) => boolean;
+    onShow?: ((instance: BasicLightBox) => boolean) | undefined;
     /*
@@ -52,3 +52,3 @@ * Function that gets executed before the lightbox closes.
      */
-    onClose?: (instance: BasicLightBox) => boolean;
+    onClose?: ((instance: BasicLightBox) => boolean) | undefined;
   }
@@ -55,0 +55,0 @@

basiclightbox/package.json

 {
     "name": "@types/basiclightbox",
-    "version": "5.0.0",
+    "version": "5.0.1",
     "description": "TypeScript definitions for basiclightbox",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/basiclightbox",
     "license": "MIT",
@@ -14,3 +15,3 @@ "contributors": [
     "main": "",
-    "types": "index",
+    "types": "index.d.ts",
     "repository": {
@@ -23,4 +24,4 @@ "type": "git",
     "dependencies": {},
-    "typesPublisherContentHash": "e6e18e61fd9a2b939a1d269ffce3b5ea68ded60cf174dcf89bd6018cb94833f9",
-    "typeScriptVersion": "2.0"
+    "typesPublisherContentHash": "f57c95cb51a709f23b7c1ed511619388f274c3b3f3768374f223f2b11564752c",
+    "typeScriptVersion": "3.6"
 }

basiclightbox/README.md

@@ -5,9 +5,77 @@ # Installation
 # Summary
-This package contains type definitions for basiclightbox ( https://basiclightbox.electerious.com ).
+This package contains type definitions for basiclightbox (https://basiclightbox.electerious.com).
 
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/basiclightbox
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/basiclightbox.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/basiclightbox/index.d.ts)
+````ts
+// Type definitions for basiclightbox 5.0
+// Project: https://basiclightbox.electerious.com
+// Definitions by: Adrian Hope-Bailie <https://github.com/adrianhopebailie>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
-Additional Details
- * Last updated: Tue, 04 Jun 2019 20:40:29 GMT
+export interface BasicLightBox {
+    /**
+     * Shows a lightbox instance.
+     *
+     * @param cb A function that gets executed as soon as the lightbox starts to fade in.
+     */
+    show: (cb?: () => void) => void;
+
+    /**
+     * Closes a lightbox instance.
+     *
+     * @param cb A function that gets executed as soon as the lightbox has been faded out.
+     */
+    close: (cb?: () => void) => void;
+
+    /**
+     * Returns true when the lightbox instance is visible. Also returns true when the lightbox is currently in the process of showing/hiding and not fully visible/hidden, yet.
+     */
+    visible: () => boolean;
+
+    /**
+     * Returns the DOM element/node associated with the instance.
+     */
+    element: () => Element;
+  }
+
+  export interface BasicLightBoxOptions {
+    /*
+     * Prevents the lightbox from closing when clicking its background.
+     */
+    closable?: boolean | undefined;
+    /*
+     * One or more space separated classes to be added to the basicLightbox element.
+     */
+    className?: string | undefined;
+    /*
+     * Function that gets executed before the lightbox will be shown.
+     * Returning false will prevent the lightbox from showing.
+     */
+    onShow?: ((instance: BasicLightBox) => boolean) | undefined;
+    /*
+     * Function that gets executed before the lightbox closes.
+     * Returning false will prevent the lightbox from closing.
+     */
+    onClose?: ((instance: BasicLightBox) => boolean) | undefined;
+  }
+
+  /**
+   * Creates a new BasicLightbox instance.
+   *
+   * @param content Content of the lightbox.
+   * @param options An object of options.
+   */
+  export function create(content: string | Element, options?: BasicLightBoxOptions): BasicLightBox;
+
+  /**
+   * Returns `true` when a lightbox is visible. Also returns true when a lightbox is currently in the process of showing/hiding and not fully visible/hidden, yet.
+   */
+  export function visible(): boolean;
+
+````
+
+### Additional Details
+ * Last updated: Wed, 07 Jul 2021 21:44:52 GMT
  * Dependencies: none
@@ -17,2 +85,2 @@ * Global values: none
 # Credits
-These definitions were written by Adrian Hope-Bailie <https://github.com/adrianhopebailie>.
+These definitions were written by [Adrian Hope-Bailie](https://github.com/adrianhopebailie).

Fixed alerts

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6955

increased by53.16%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

85

increased by400%

No dependency changes