@types/lunr - npm Package Compare versions

Comparing version 2.1.6 to 2.3.0

lunr/index.d.ts

@@ -1,4 +0,4 @@
-// Type definitions for lunr.js 2.1
+// Type definitions for lunr.js 2.3
 // Project: https://github.com/olivernn/lunr.js
-// Definitions by: Sean Tan <https://github.com/seantanly>
+// Definitions by: Sean Tan <https://github.com/seantanly>, Andrés Pérez <https://github.com/hokiegeek>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -130,5 +130,10 @@ // TypeScript Version: 2.3
          *
+         * Fields can be boosted at build time. This allows terms within that field to have more
+         * importance when ranking search results. Use a field boost to specify that matches
+         * within one field are more important than other fields.
+         *
          * @param field - The name of a field to index in all documents.
+         * @param attributes - Optional attributes associated with this field.
          */
-        field(field: string): void;
+        field(field: string, attributes?: object): void;
 
@@ -164,5 +169,9 @@ /**
          *
+         * Entire documents can be boosted at build time. Applying a boost to a document indicates that
+         * this document should rank higher in search results than other documents.
+         *
          * @param doc - The document to add to the index.
+         * @param attributes - Optional attributes associated with this document.
          */
-        add(doc: object): void;
+        add(doc: object, attributes?: object): void;
 
@@ -169,0 +178,0 @@ /**

lunr/package.json

 {
     "name": "@types/lunr",
-    "version": "2.1.6",
+    "version": "2.3.0",
     "description": "TypeScript definitions for lunr.js",
@@ -11,5 +11,11 @@ "license": "MIT",
             "githubUsername": "seantanly"
+        },
+        {
+            "name": "Andrés Pérez",
+            "url": "https://github.com/hokiegeek",
+            "githubUsername": "hokiegeek"
         }
     ],
     "main": "",
+    "types": "index",
     "repository": {
@@ -21,4 +27,4 @@ "type": "git",
     "dependencies": {},
-    "typesPublisherContentHash": "5005a1da879d650bd98ba17495c9da11dd60933cf32e20cf211d8ab7c97a5b38",
+    "typesPublisherContentHash": "077cc36a84a59c9a042c50635622acc07520993520ec592f8c6271fa09a17fd3",
     "typeScriptVersion": "2.3"
 }

lunr/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Thu, 02 Aug 2018 01:35:11 GMT
+ * Last updated: Sat, 08 Dec 2018 01:45:01 GMT
  * Dependencies: none
@@ -17,2 +17,2 @@ * Global values: lunr
 # Credits
-These definitions were written by Sean Tan <https://github.com/seantanly>.
+These definitions were written by Sean Tan <https://github.com/seantanly>, Andrés Pérez <https://github.com/hokiegeek>.

No alert changes

Improved metrics

Total package byte prevSize

39797

increased by2.47%

Lines of code

895

increased by1.02%

No dependency changes