@fresh8/copacetic - npm Package Compare versions

Comparing version 3.1.1 to 3.2.0

lib/copacetic.js

@@ -88,11 +88,13 @@ const EventEmitter = require('events')
      */
-    deregisterDependency (name) {
-      precond.checkState(
-        this.isDependencyRegistered(name) === true,
-        `Tried to deregister dependency - ${name}, but dependency is not registered`
+    deregisterDependency (dependency) {
+      const resolved = this.getDependency(dependency)
+
+      precond.checkIsDef(
+        resolved,
+        `Tried to deregister dependency, but dependency is not registered`
       )
+      resolved.cleanup()
 
-      this.getDependency(name).cleanup()
-      delete this.dependencyIndex[name]
-      this.dependencyNames = this.dependencyNames.filter(n => n !== name)
+      delete this.dependencyIndex[resolved.name]
+      this.dependencyNames = this.dependencyNames.filter(n => n !== resolved.name)
 
@@ -99,0 +101,0 @@ return this

package.json

 {
   "name": "@fresh8/copacetic",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "description": "A package to help your service check the health of its dependencies.",
@@ -54,2 +54,3 @@ "main": "index.js",
   "devDependencies": {
+    "@types/node": "^6.0.78",
     "chai": "^3.5.0",
@@ -79,3 +80,4 @@ "coveralls": "^2.13.1",
     "ioredis": "3.x"
-  }
+  },
+  "typings": "copacetic.d.ts"
 }

README.md

@@ -17,3 +17,3 @@ # Copacetic
 
-#### Quick Start
+#### Quick Start - Javascript
 ```javascript
@@ -30,3 +30,3 @@ const Copacetic = require('@fresh8/copacetic')
   // Defaults to SOFT
-  dependency: level.HARD
+  level: level.HARD
 })
@@ -55,2 +55,25 @@
 
+#### Quick Start - Typescript
+```typescript
+import * as Copacetic from '@fresh8/copacetic'
+
+const copacetic = Copacetic('my-service')
+
+const myDependencyOverHttp : Copacetic.DependencyOptions = {
+  name: 'my-web-service',
+  url: 'http://example.com'
+}
+
+copacetic.registerDependency(myDependencyOverHttp)
+
+instance
+  .check({ name: 'my-web-service' })
+  .on('healthy', (res: Copacetic.Health) => {
+    // do something with your healthy dependency :)
+  })
+  .on('unhealthy', (res: Copacetic.Health) => {
+    // handle degraded state
+  })
+```
+
 <a name="Copacetic"></a>
@@ -57,0 +80,0 @@

No alert changes

Improved metrics

Total package byte prevSize

220030

increased by5.27%

Number of package files

66

increased by1.54%

Lines of code

6145

increased by6.94%

Number of lines in readme file

274

increased by9.16%

Worsened metrics

Dev dependency count

11

increased by10%

No dependency changes