@stltio/stealth - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0

dist/index.d.ts

@@ -1,4 +0,5 @@
-declare function stealth({ apiKey, debug }: {
+declare function stealth({ apiKey, debug, ignore }?: {
     apiKey?: string;
     debug?: boolean;
+    ignore: string[];
 }): Promise<{
@@ -5,0 +6,0 @@ visitorId: any;

package.json

 {
   "name": "@stltio/stealth",
-  "version": "0.5.0",
-  "description": "",
+  "version": "0.6.0",
+  "description": "Device fingerprinting library",
   "main": "./dist/index.js",
@@ -41,3 +41,3 @@ "module": "./dist/index.mjs",
   "dependencies": {
-    "axios": "^1.6.8",
+    "axios": "^1.7.2",
     "jssha": "^3.3.1"
@@ -47,5 +47,5 @@ },
     "ts-node": "^10.9.2",
-    "tsup": "^8.0.2",
+    "tsup": "^8.2.3",
     "typescript": "^5.4.5"
   }
 }

README.md

 # Stlt - Stealth
 
-Device fingerprinting
+Device fingerprinting and browser information.
 
-(work in progress)
-
 See the working [demo](https://stlt.io) in action.
@@ -56,1 +54,37 @@
 ```
+
+## Ignore list
+
+You can exclude some tests by providing an array of keys to ignore.
+
+### Example with ignore list
+
+```
+import stealth from '@stltio/stealth'
+const result = await stealth({ ignore: ['audio', 'webrtc']})
+const {
+  local: {},
+  remote: {},
+  visitorId: 'abc...xyz',
+  ms: 491
+} = result
+```
+
+## Debug
+
+You can enable debug mode by setting `debug` to `true`.
+
+It will print in the console the lolcal generated payload and the remote response.
+
+### Example with debug
+
+```
+import stealth from '@stltio/stealth'
+const result = await stealth({ debug: true })
+const {
+  local: {},
+  remote: {},
+  visitorId: 'abc...xyz',
+  ms: 491
+} = result
+```

No alert changes

Improved metrics

Total package byte prevSize

492681

increased by0.99%

Lines of code

8560

increased by0.08%

Number of lines in readme file

90

increased by60.71%

Dependency changes

• Updatedaxios@^1.7.2