billy - npm Package Compare versions
Comparing version 2.0.0-beta-2 to 2.0.1
| # Change History | ||
| ## v2.0.0 (???) | ||
| ## v2.0.1 (2017-05-11) | ||
@@ -5,0 +5,0 @@ * Initial v2 release |
| { | ||
| "name": "billy", | ||
| "version": "2.0.0-beta-2", | ||
| "version": "2.0.1", | ||
| "description": "A minimal application harness that stays out of your way and out of your code.", | ||
@@ -5,0 +5,0 @@ "author": "Brandon Valosek <bvalosek@gmail.com>", |
| # billy | ||
| > v2 is currently in progress and is NOT yet shipped / final. | ||
| > To install it, you need to run `npm install billy@v2-beta` | ||
| [](https://circleci.com/gh/bvalosek/billy/tree/master) | ||
@@ -24,12 +20,9 @@ | ||
| The primary goal and driving philosophy of Billy is to provide a cohesive and | ||
| useful set of patterns for building an application that doesn't creep its way | ||
| into your business logic and domain code. | ||
| useful set of utilities for building an complex application, without creeping | ||
| its way into your business logic and domain code. | ||
| It is flexible and generic enough to work great for building server apps, | ||
| browser apps, Javascript games, or even CLI utilities. | ||
| Billy is not an opinionated framework that permeates all parts of your | ||
| codebase, but rather the simple scaffolding that allows you to roll your own | ||
| application architecture stack, your way. | ||
| Much like [express](https://github.com/visionmedia/express), Billy strives not | ||
| to be a framework that permeates all parts of your codebase, but rather the | ||
| scaffolding that allows you to roll your own application architecture stack. | ||
| ### The `Application` instance and the Service Stack | ||
@@ -48,4 +41,38 @@ | ||
| should be free of all business logic, and should be the only parts of the | ||
| aplication that are aware of Billy. | ||
| application that are aware of Billy. | ||
| ```javascript | ||
| app.service(AppConfigService); | ||
| app.service(PostgresDatabaseService); | ||
| app.service(SQSQueueService); | ||
| app.service(AuthAPIComponent); | ||
| ``` | ||
| If a service implements a `start()` method, it will be called (and `await`-ed) | ||
| when you call `app.start()` to boot the application. | ||
| ```javascript | ||
| (async () => { | ||
| await app.start(); | ||
| console.log('all services succesfully instantiated and started -- nice!'); | ||
| })(); | ||
| ``` | ||
| All services registered (via `Application#service`) will be instantiated (with | ||
| injected constructors, see below) **in the order in which they were | ||
| registered**. After all services have been successfully (and synchronously) | ||
| instantiated, the `start` method will be called on each one (again, in the | ||
| order registered) if implemented. If `start` returns a `Promise`, the app will | ||
| wait for it to resolve before continuing. | ||
| If any service `throw`s during instantiation or during the `start` method (or | ||
| the `Promise` returned is rejected), then the application will abort its | ||
| startup. | ||
| ### The `Container` instance and Dependency Injection | ||
@@ -55,8 +82,12 @@ | ||
| ## Usage | ||
| #### Registering Dependencies | ||
| > Code Examples | ||
| > The various `container.register*` methods | ||
| ### Environments | ||
| #### Resolving Dependencies | ||
| > Overview of `new` and `call` on the container, and locals | ||
| ## Environments | ||
| Billy is written to run in modern Javascript environments (ES2017) that support | ||
@@ -67,3 +98,3 @@ the CommonJS module system and the latest ES2017 Spec (e.g, Node 7.10+). It | ||
| #### Older JS Runtimes | ||
| ### Older JS Runtimes | ||
@@ -70,0 +101,0 @@ If you are not on the absolute cutting edge, you'll want to use a transpiled |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
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
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.83%
47722
- Number of low quality alerts
- decreased by-50%
1
- Number of lines in readme file
- increased by15.42%
232
- Number of medium supply chain risk alerts
- decreased by-100%
0