Skip to content

Commit e4264ef

Browse files
authored
Merge pull request #1 from mcoakley/master
Updated packaging and dependencies
2 parents f0afdbb + ac2cc22 commit e4264ef

File tree

7 files changed

+1445
-1804
lines changed

7 files changed

+1445
-1804
lines changed

.gitignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
.nyc_output
21
.vscode
2+
.nyc_output
33
dist
4+
docs
45
node_modules
56
reports
67

7-
# Logs
8-
logs
98
*.log
109
npm-debug.log*

.vscode/launch.json

Lines changed: 0 additions & 32 deletions
This file was deleted.

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
## Status of Project
44

5-
[![Build Status](https://travis-ci.org/acmeframework/af-conditionals.svg?branch=master)](https://travis-ci.org/acmeframework/af-conditionals) [![Coverage Status](https://coveralls.io/repos/github/acmeframework/af-conditionals/badge.svg?branch=master)](https://coveralls.io/github/acmeframework/af-conditionals?branch=master)
5+
[![Build Status](https://travis-ci.org/acmeframework/af-conditionals.svg?branch=master)](https://travis-ci.org/acmeframework/af-conditionals) [![Coverage Status](https://coveralls.io/repos/github/acmeframework/af-conditionals/badge.svg?branch=master)](https://coveralls.io/github/acmeframework/af-conditionals?branch=master)
66

77
## Purpose
88

99
The `af-conditionals` library was created to provide a consistent interface from which to create dynamic comparisons, conditional expressions, logical expressions, and operations. Through the interface, expressions can be defined externally to the application code and dynamically executed.
1010

1111
## Standard Calling Conventions
1212

13-
All Comparisons, Conditionals, Logicals, and Operators expose the object class and a variable named after the class with the word *Instance* appended, but starting with a lowercase letter. For example: `IsString` is exposed as is `isStringInstance`. The `isStringInstance` variable is declared with a `let` so you may subclass the object and then use your version of your class throughout your application easily. Additionally, we expose a function that implements the testing for the class, for example, `IsString` has a exposed function `isString` that calls `isStringInstance.test()`. *(This is described in the Release Notes for v0.2.0.)*
13+
All Comparisons, Conditionals, Logicals, and Operators expose the object class and a variable named after the class with the word _Instance_ appended, but starting with a lowercase letter. For example: `IsString` is exposed as is `isStringInstance`. The `isStringInstance` variable is declared with a `let` so you may subclass the object and then use your version of your class throughout your application easily. Additionally, we expose a function that implements the testing for the class, for example, `IsString` has a exposed function `isString` that calls `isStringInstance.test()`. _(This is described in the Release Notes for v0.2.0.)_
1414

1515
## Release Notes
1616

@@ -26,15 +26,15 @@ In v0.1.0, you would write code like this:
2626

2727
```javascript
2828
if (isUsable.test(someVar)) {
29-
console.log("It is usable");
29+
console.log('It is usable');
3030
}
3131
```
3232

3333
Starting in v0.2.0, you can now simply say:
3434

3535
```javascript
3636
if (isUsable(someVar)) {
37-
console.log("It is usable");
37+
console.log('It is usable');
3838
}
3939
```
4040

@@ -55,6 +55,13 @@ if (isUsable(someVar)) {
5555

5656
- Official 1.0.0 release version
5757

58+
### v1.1.0
59+
60+
- Updated dependencies
61+
- Updated package.json for consistent scripts across af-XXXX libraries
62+
- removed .vscode folder
63+
- Updated README.md
64+
5865
## Comparisons
5966

6067
The `Comparison` class provides a `compare` and `test` public methods.
@@ -65,13 +72,13 @@ The `compare` method takes two values and compares them returning:
6572
- 0 (zero) when the first value is equal to the second value
6673
- +1 (postive numeral one) when the first value is greater than the second value
6774

68-
The `test` uses the `compare` method to get the result and then compare that result to an expected result that you supply. Compare returns:
75+
_When possible the `compare` method will compare the values using strict equals (`===`). When the values are not of the same type, `compare` will use coerced equality (`==`)._
76+
77+
The `test` uses the `compare` method to get the result and then compare that result to an expected result that you supply. `test` returns:
6978

7079
- `true` if the returned result and expected result are equal
7180
- `false` otherwise
7281

73-
*When possible the `compare` method will compare the values using strict equals (`===`). When the values are not of the same type, `compare` will use coerced equality (`==`).*
74-
7582
Supplied Comparisons are:
7683

7784
- `Equal` - determines if two values are equal
@@ -80,7 +87,7 @@ Supplied Comparisons are:
8087
- `LessThan` - determines if the first value is less than the second value
8188
- `LessThanOrEqual` - determines if the first value is less than or equal to the second value
8289

83-
*Comparisons use shorthand calling function names instead of exposed functions of `equal`, `greaterThan`, etc... `eq`, `gt`, `gte`, `lt`, `lte` are exposed.*
90+
_Comparisons use shorthand calling function names instead of exposed functions of `equal`, `greaterThan`, etc... `eq`, `gt`, `gte`, `lt`, `lte` are exposed._
8491

8592
### `strict`
8693

0 commit comments

Comments
 (0)