@desole/client
Advanced tools
Comparing version 0.0.1 to 1.0.0
{ | ||
"name": "@desole/client", | ||
"version": "0.0.1", | ||
"description": "client-side desole library", | ||
"main": "index.js", | ||
"version": "1.0.0", | ||
"description": "Client side library for Desole.io", | ||
"main": "client.js", | ||
"scripts": { | ||
"lint": "eslint .", | ||
"uglify": "uglifyjs client.js -c -o client-min.js", | ||
"release": "npm run uglify && mkdir -p $npm_package_config_releaseDir/$npm_package_version && cp *.js $npm_package_config_releaseDir/$npm_package_version" | ||
}, | ||
"repository": { | ||
@@ -10,4 +15,8 @@ "type": "git", | ||
}, | ||
"keywords": ["desole"], | ||
"author": "", | ||
"keywords": [ | ||
"desole", | ||
"error", | ||
"tracking" | ||
], | ||
"author": "Slobodan Stojanović <slobodan@cloudhorizon.com> (http://slobodan.me)", | ||
"license": "MIT", | ||
@@ -17,3 +26,12 @@ "bugs": { | ||
}, | ||
"homepage": "https://github.com/desoleio/client#readme" | ||
"homepage": "https://github.com/desoleio/client#readme", | ||
"config": { | ||
"releaseDir": "../www.desole.io/code" | ||
}, | ||
"devDependencies": { | ||
"eslint": "^4.19.1", | ||
"eslint-config-crockford": "^2.0.0", | ||
"eslint-config-defaults": "^9.0.0", | ||
"uglify-js": "^3.3.25" | ||
} | ||
} |
@@ -1,1 +0,41 @@ | ||
# client | ||
# Desole browser collector client | ||
![](https://desole.io/images/desole-logo.png) | ||
This project contains the code for the Desole browser client collector. Check out [desole.io](https://desole.io) for more information on how to set up the back-end. | ||
## Installing | ||
You can either grab the code from this repository, install it using NPM, or use the CDN version: | ||
* non-minified: https://desole.io/code/1.0.0/client.js (CORS integrity hash sha384-F6dlhvEal5yUmvat1O3JGkkA6xaPbwxWhQksJVfbZTFvLR3KkWmNf2OkF1jyuzzA) | ||
* minified: https://desole.io/code/1.0.0/client-min.js (CORS integrity hash sha384-RJpzB9k3WRLZZ0Th8DoSiEWUYMmt5+9fxLajledFE5PY/23D+tHatLo38g/LDc7z) | ||
## Configuring the HTML page | ||
Add this snippet before any other scripts in your HTML document, and replace the path to the client JS and the API URL: | ||
```html | ||
<script src="CLIENT-LIBRARY-PATH" crossorigin="anonymous" integrity="INTEGRITY-HASH"></script> | ||
<script> | ||
var desole = new Desole({ | ||
url: 'https://DESOLE-API-URL', | ||
app: { | ||
name: 'Desole test', | ||
version: '1.0.0', | ||
stage: 'test' | ||
} | ||
}) | ||
</script> | ||
``` | ||
This will make Desole automatically track unhandled errors on the page, as well as script loading errors. Make sure to add the block to the end of the HEAD element | ||
To track errors manually, use instance created with `new Desole` and call the `captureException` to send an exception object or a promise rejection to the collector API: | ||
```js | ||
try { | ||
throw new Error('capturedException'); | ||
} catch (e) { | ||
window.desole.captureException(e); | ||
} | ||
``` |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Trivial Package
Supply chain riskPackages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.
Found 1 instance in 1 package
No contributors or author data
MaintenancePackage does not specify a list of contributors or an author in package.json.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
13268
6
174
1
0
42
4