Skip to content

Commit

Permalink
Made updates to Readme.md and removed superfluous documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mdaemon-technologies committed Mar 29, 2024
1 parent 64e4a0f commit 1dda408
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 36 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ The `observable` function provides methods for setting, getting, observing, and

$ npm install @mdaemon/observable --save

# Node CommonJS #
## Node CommonJS ##
```javascript
const observe = require("@mdaemon/observable/dist/observable.cjs");
```

# Node Modules #
## Node Modules ##
```javascript
import observe from "@mdaemon/observable/dist/observable.mjs";
```

# Web #
## Web ##
```HTML
<script type="text/javascript" src="/path_to_modules/dist/observable.umd.js">
```
Expand All @@ -28,6 +28,7 @@ The `observable` function provides methods for setting, getting, observing, and
You can use observe to keep track of a value from multiple contexts
```javascript
import observe from "@mdaemon/observerable/dist/observable.mjs";
// observeTheseValues.js
const observedNumber = observe("numberName", 20);
Expand All @@ -46,9 +47,16 @@ You can use observe to keep track of a value from multiple contexts
const observedString = observe("stringName","test");
export observedString;
```
```javascript
// index.js
import { observedNumber, observedObject, observedArray, observedBoolean, observedString } from "observeTheseValues.js";
import {
observedNumber, observedObject,
observedArray, observedBoolean,
observedString
} from "observeTheseValues.js";
// change the value and return changed true/false
let changed = observedNumber(30);
console.log(changed); // true
Expand Down
8 changes: 0 additions & 8 deletions dist/observable.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -121,14 +121,6 @@ var deepEqual = function (a, b) {
}
return false;
};
/**
* Class representing an observable value that can be observed by
* registering callback functions. Allows observing value changes.
*
* Has methods for getting/setting the value, registering observers,
* and notifying observers when the value changes. Stores observers
* in an array.
*/
/**
* Constructor for the Observable class.
*
Expand Down
8 changes: 0 additions & 8 deletions dist/observable.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -119,14 +119,6 @@ var deepEqual = function (a, b) {
}
return false;
};
/**
* Class representing an observable value that can be observed by
* registering callback functions. Allows observing value changes.
*
* Has methods for getting/setting the value, registering observers,
* and notifying observers when the value changes. Stores observers
* in an array.
*/
/**
* Constructor for the Observable class.
*
Expand Down
8 changes: 0 additions & 8 deletions dist/observable.umd.js
Original file line number Diff line number Diff line change
Expand Up @@ -125,14 +125,6 @@
}
return false;
};
/**
* Class representing an observable value that can be observed by
* registering callback functions. Allows observing value changes.
*
* Has methods for getting/setting the value, registering observers,
* and notifying observers when the value changes. Stores observers
* in an array.
*/
/**
* Constructor for the Observable class.
*
Expand Down
8 changes: 0 additions & 8 deletions src/observable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -172,14 +172,6 @@ interface Observer {
observe: Function;
}

/**
* Class representing an observable value that can be observed by
* registering callback functions. Allows observing value changes.
*
* Has methods for getting/setting the value, registering observers,
* and notifying observers when the value changes. Stores observers
* in an array.
*/
/**
* Constructor for the Observable class.
*
Expand Down

0 comments on commit 1dda408

Please sign in to comment.