haystack-core - npm Package Compare versions

Comparing version 2.0.26 to 2.0.27

dist/filter/HFilter.d.ts

@@ -19,2 +19,6 @@ import { Node } from './Node';
     /**
+     * Used for a type guard check.
+     */
+    readonly _isHFilter = true;
+    /**
      * Constructs a new haystack filter from the string.
@@ -29,2 +33,9 @@ *
     /**
+     * Return true if the value is a haystack filter object.
+     *
+     * @param value The value to test.
+     * @returns True if the value is a haystack filter.
+     */
+    static isHFilter(value: unknown): value is HFilter;
+    /**
      * Parse a Haystack Filter and returns it's base AST node.
@@ -31,0 +42,0 @@ *

dist/filter/HFilterBuilder.d.ts

@@ -9,2 +9,4 @@ import { HUri } from '../core/HUri';
 import { HSymbol } from '../core/HSymbol';
+import { HFilter } from './HFilter';
+import { Node } from './Node';
 declare type Path = string | string[];
@@ -29,2 +31,13 @@ declare type Value = HBool | HRef | HStr | HUri | HNum | HDate | HTime | HSymbol | string | boolean | number | Date;
     /**
+     * Used for a type guard check.
+     */
+    readonly _isHFilterBuilder = true;
+    /**
+     * Return true if the value is a haystack filter builder object.
+     *
+     * @param value The value to test.
+     * @returns True if the value is a haystack filter builder.
+     */
+    static isHFilterBuilder(value: unknown): value is HFilterBuilder;
+    /**
      * Adds a does the tag exist condition.
@@ -133,2 +146,27 @@ *
     /**
+     * Write the filter into this filter.
+     *
+     * @param filter The filter value to write.
+     * @returns The builder instance.
+     */
+    filter(filter: string | Node | HFilter | HFilterBuilder): this;
+    /**
+     * Return true if nothing has been written to the builder.
+     *
+     * @returns True if the internal buffer is empty.
+     */
+    isEmpty(): boolean;
+    /**
+     * Dump the current state of the filter builder to the console output.
+     *
+     * @returns The builder instance.
+     */
+    inspect(): this;
+    /**
+     * The internal buffer used to build the haystack filter.
+     *
+     * Please note, this method is only intended for debugging/testing purposes.
+     */
+    get internalBuffer(): string;
+    /**
      * Add a comparison using an operator.
@@ -135,0 +173,0 @@ *

package.json

@@ -14,3 +14,3 @@ {
 	"email": "[e-mail]",
-	"version": "2.0.26",
+	"version": "2.0.27",
 	"module": "dist/index.es.js",
@@ -17,0 +17,0 @@ "main": "dist/index.js",

README.md

@@ -28,2 +28,4 @@ <p align="center">
 
+If you're after a high performance haystack library for running on constrained devices, please see [libhaystack](https://github.com/j2inn/libhaystack).
+
 ## Installation
@@ -30,0 +32,0 @@

No alert changes

Improved metrics

Total package byte prevSize

1166922

increased by0.5%

Lines of code

37739

increased by0.54%

Number of lines in readme file

136

increased by1.49%

No dependency changes